* Applied patch from Amos Waterland <apw@us.ibm.com> to allow apt to

[apt.git] / COMPILING

diff --git a/COMPILING b/COMPILING
index 3ce726180824a819f48c836b433ce931cef5d601..fadbe171b5050005eea5f7fa21b24753b96cf65b 100644 (file)
--- a/COMPILING
+++ b/COMPILING
@@ -9,8 +9,17 @@ To compile this you need a couple things
     g++ 2.8 works OK and newer egcs work well also. Nobody has tried it
     on other compilers :< You will need a properly working STL as well.
   - A C library with the usual POSIX functions and a BSD socket layer. 
-    If you OS conforms to the Single User Spec then you are fine:
+    If you OS conforms to the Single Unix Spec then you are fine:
       http://www.opengroup.org/onlinepubs/7908799/index.html      
+  - Refer to the Build-Depends information in debian/control for
+    additional requirements (some of which are Debian-specific)
+
+** NOTICE **
+The C++ global constructors do not link correctly when using non-shared
+libaries. This is probably the correct behavior of the linker, but I have
+not yet had time to devise a work around for it. The correct thing to 
+do is add a reference to debSystem in apt-pkg/init.cc, 
+assert(&debSystem == 0) would be fine for instance.
 
 Guidelines
 ~~~~~~~~~~
@@ -27,41 +36,50 @@ functionality. Patches to make autoconf detect these cases and generate the
 required shims are OK.
 
 Current shims:
-  * C9x integer types 'inttypes.h' 
-  * sys/statvfs.h to convert from BSD statfs to SUS statvfs  
+  * C99 integer types 'inttypes.h' 
+  * sys/statvfs.h to convert from BSD/old-glibc statfs to SUS statvfs
   * rfc2553 hostname resolution (methods/rfc*), shims to normal gethostbyname.
+    The more adventerous could steal the KAME IPv6 enabled resolvers for those
+    OS's with IPv6 support but no rfc2553 (why?)
+  * define _XOPEN_EXTENDED_SOURCE to bring in h_errno on HP-UX
+  * socklen_t shim in netdb.h if the OS does not have socklen_t
   
-The only completely non-shimed OS is Linux with glibc2.1
+The only completely non-shimed OS is Linux with glibc2.1, glibc2.0 requires
+the first three shims.
 
 Platform Notes
 ~~~~~~~~~~~~~~
 Debian GNU Linux 2.1 'slink'
 Debian GNU Linux 'potato'
+Debian GNU Linux 'woody'
   * All Archs
   - Works flawlessly
-  - You will want to have debiandoc-sgml and yodl installed to get
+  - You will want to have debiandoc-sgml and docbook2man installed to get
     best results.
-  - No IPv6 Support in glibc's < 2.1
+  - No IPv6 Support in glibc's < 2.1.
 
 Sun Solaris
   SunOS cab101 5.7 Generic_106541-04 sun4u sparc
+  SunOS csu201 5.8 Generic_108528-04 sun4u sparc  
   - Works fine
   - Note, no IPv6 Support, OS lacks RFC 2553 hostname resolution
-   
+
+OpenBSD
+  OpenBSD gsb086 2.5 CMPUT#0 i386 unknown
+  OpenBSD csu101 2.7 CMPUT#1 i386 unknown  
+  - OS needs 'ranlib' to generate the symbol table after 'ar'.. (not using
+    GNU ar with the gnu tool chain :<)
+  - '2.5' does not have RFC 2553 hostname resolution, but '2.7' does
+  - Testing on '2.7' suggests the OS has a bug in its handling of 
+    ftruncate on files that have been written via mmap. It fills the page 
+    that crosses the truncation boundary with 0's. 
+    
 HP-UX
   HP-UX nyquist B.10.20 C 9000/780 2016574337 32-user license
   - Evil OS, does not conform very well to SUS
      1) snprintf exists but is not prototyped, ignore spurios warnings
      2) No socklen_t
      3) Requires -D_XOPEN_SOURCE_EXTENDED for h_errno
-    Items 2 and 3 have to be fixed by hand. Insert this into
-    build/include/netdb.h:
-    
-    #define _XOPEN_SOURCE_EXTENDED
-    #define socklen_t size_t
-    #include_next <netdb.h>
-    
-    A similar techinque can be used for snprintf/vsprintf if you dislike 
-    the warnings
+    configure should fix the last two (see above)
   - Note, no IPv6 Support, OS lacks RFC 2553 hostname resolution