README.cares

   1 c-ares
   2 ======
   3
   4 This package is based on ares 1.1.1 (written by Greg Hudson). I decided to
   5 fork and release a separate project since the ares author didn't want the
   6 improvements that were vital for our use of it.
   7
   8 This package is dubbed 'c-ares' since I (Daniel Stenberg) wanted this for use
   9 within the curl project (hence the letter C) and it makes a nice pun. Also,
  10 c-ares is not API compatible with ares: a new name makes that more obvious to
  11 the public.
  12
  13 The full source code is available in the 'c-ares' release archives, and in a
  14 git repository: http://github.com/bagder/c-ares
  15
  16 If you find bugs, correct flaws, have questions or have comments in general in
  17 regard to c-ares (or by all means the original ares too), get in touch with us
  18 on the c-ares mailing list: http://cool.haxx.se/mailman/listinfo/c-ares
  19
  20 c-ares is of course distributed under the same MIT-style license as the
  21 original ares.
  22
  23 You'll find all c-ares details and news here:
  24
  25         http://c-ares.haxx.se/
  26
  27
  28 NOTES FOR C-ARES HACKERS
  29
  30 The following notes apply to c-ares version 1.7.0 and later.
  31
  32 * The distributed ares_build.h file is only intended to be used on systems
  33   which can not run the also distributed configure script.
  34
  35 * The distributed ares_build.h file is generated as a copy of ares_build.h.dist
  36   when the c-ares source code distribution archive file is originally created.
  37
  38 * If you check out from git on a non-configure platform, you must run the
  39   appropriate buildconf* script to set up ares_build.h and other local files
  40   before being able of compiling the library.
  41
  42 * On systems capable of running the configure script, the configure process
  43   will overwrite the distributed ares_build.h file with one that is suitable
  44   and specific to the library being configured and built, this new file is
  45   generated from the ares_build.h.in template file.
  46
  47 * If you intend to distribute an already compiled c-ares library you _MUST_
  48   also distribute along with it the generated ares_build.h which has been
  49   used to compile it. Otherwise the library will be of no use for the users of
  50   the library that you have built. It is _your_ responsability to provide this
  51   file. No one at the c-ares project can know how you have built the library.
  52
  53 * File ares_build.h includes platform and configuration dependent info,
  54   and must not be modified by anyone. Configure script generates it for you.
  55
  56 * We cannot assume anything else but very basic compiler features being
  57   present. While c-ares requires an ANSI C compiler to build, some of the
  58   earlier ANSI compilers clearly can't deal with some preprocessor operators.
  59
  60 * Newlines must remain unix-style for older compilers' sake.
  61
  62 * Comments must be written in the old-style /* unnested C-fashion */
  63