COMPILING

   1 General Information
   2 ~~~~~~~~~~~~~~~~~~~
   3 To compile this you need a couple things
   4   - A working POSIX system with working POSIX gcc, g++, make (GNU),
   5     ar, sh, awk and sed in the path
   6   - GNU Make 3.74 or so, -- normal UNIX make will NOT work
   7     * Note 3.77 is broken.
   8   - A working ANSI C++ compiler, this is not g++ 2.7.*
   9     g++ 2.8 works OK and newer egcs work well also. Nobody has tried it
  10     on other compilers :< You will need a properly working STL as well.
  11   - A C library with the usual POSIX functions and a BSD socket layer.
  12     If you OS conforms to the Single Unix Spec then you are fine:
  13       http://www.opengroup.org/onlinepubs/7908799/index.html
  14
  15 ** NOTICE **
  16 The C++ global constructors do not link correctly when using non-shared
  17 libaries. This is probably the correct behavior of the linker, but I have
  18 not yet had time to devise a work around for it. The correct thing to
  19 do is add a reference to debSystem in apt-pkg/init.cc,
  20 assert(&debSystem == 0) would be fine for instance.
  21
  22 Guidelines
  23 ~~~~~~~~~~
  24 I am not interested in making 'ultra portable code'. I will accept patches
  25 to make the code that already exists conform more to SUS or POSIX, but
  26 I don't really care if your not-SUS OS doesn't work. It is simply too
  27 much work to maintain patches for dysfunctional OSs. I highly suggest you
  28 contact your vendor and express intrest in a conforming C library.
  29
  30 That said, there are lots of finniky problems that must be delt with even
  31 between the supported OS's. Primarily the path I choose to take is to put
  32 a shim header file in build/include that transparently adds the required
  33 functionality. Patches to make autoconf detect these cases and generate the
  34 required shims are OK.
  35
  36 Current shims:
  37   * C99 integer types 'inttypes.h'
  38   * sys/statvfs.h to convert from BSD/old-glibc statfs to SUS statvfs
  39   * rfc2553 hostname resolution (methods/rfc*), shims to normal gethostbyname.
  40     The more adventerous could steal the KAME IPv6 enabled resolvers for those
  41     OS's with IPv6 support but no rfc2553 (why?)
  42   * define _XOPEN_EXTENDED_SOURCE to bring in h_errno on HP-UX
  43   * socklen_t shim in netdb.h if the OS does not have socklen_t
  44
  45 The only completely non-shimed OS is Linux with glibc2.1, glibc2.0 requires
  46 the first three shims.
  47
  48 Platform Notes
  49 ~~~~~~~~~~~~~~
  50 Debian GNU Linux 2.1 'slink'
  51 Debian GNU Linux 'potato'
  52 Debian GNU Linux 'woody'
  53   * All Archs
  54   - Works flawlessly
  55   - You will want to have debiandoc-sgml and docbook2man installed to get
  56     best results.
  57   - No IPv6 Support in glibc's < 2.1.
  58
  59 Sun Solaris
  60   SunOS cab101 5.7 Generic_106541-04 sun4u sparc
  61   SunOS csu201 5.8 Generic_108528-04 sun4u sparc
  62   - Works fine
  63   - Note, no IPv6 Support, OS lacks RFC 2553 hostname resolution
  64
  65 OpenBSD
  66   OpenBSD gsb086 2.5 CMPUT#0 i386 unknown
  67   OpenBSD csu101 2.7 CMPUT#1 i386 unknown
  68   - OS needs 'ranlib' to generate the symbol table after 'ar'.. (not using
  69     GNU ar with the gnu tool chain :<)
  70   - '2.5' does not have RFC 2553 hostname resolution, but '2.7' does
  71   - Testing on '2.7' suggests the OS has a bug in its handling of
  72     ftruncate on files that have been written via mmap. It fills the page
  73     that crosses the truncation boundary with 0's.
  74
  75 HP-UX
  76   HP-UX nyquist B.10.20 C 9000/780 2016574337 32-user license
  77   - Evil OS, does not conform very well to SUS
  78      1) snprintf exists but is not prototyped, ignore spurios warnings
  79      2) No socklen_t
  80      3) Requires -D_XOPEN_SOURCE_EXTENDED for h_errno
  81     configure should fix the last two (see above)
  82   - Note, no IPv6 Support, OS lacks RFC 2553 hostname resolution
  83