legacy-libs/grpc-cloned/deps/grpc/third_party/cares/cares/README.md

   1 c-ares
   2 ======
   3
   4 [![Build Status](https://travis-ci.org/c-ares/c-ares.svg?branch=master)](https://travis-ci.org/c-ares/c-ares)
   5 [![Windows Build Status](https://ci.appveyor.com/api/projects/status/03i7151772eq3wn3/branch/master?svg=true)](https://ci.appveyor.com/project/c-ares/c-ares)
   6 [![Coverage Status](https://coveralls.io/repos/c-ares/c-ares/badge.svg?branch=master&service=github)](https://coveralls.io/github/c-ares/c-ares?branch=master)
   7 [![CII Best Practices](https://bestpractices.coreinfrastructure.org/projects/291/badge)](https://bestpractices.coreinfrastructure.org/projects/291)
   8 [![Releases](https://coderelease.io/badge/c-ares/c-ares)](https://coderelease.io/github/repository/c-ares/c-ares)
   9
  10 This is c-ares, an asynchronous resolver library.  It is intended for
  11 applications which need to perform DNS queries without blocking, or need to
  12 perform multiple DNS queries in parallel.  The primary examples of such
  13 applications are servers which communicate with multiple clients and programs
  14 with graphical user interfaces.
  15
  16 The full source code is available in the ['c-ares' release archives](https://c-ares.haxx.se/download/),
  17 and in a git repository: http://github.com/c-ares/c-ares.  See the
  18 [INSTALL.md](INSTALL.md) file for build information.
  19
  20 If you find bugs, correct flaws, have questions or have comments in general in
  21 regard to c-ares (or by all means the original ares too), get in touch with us
  22 on the c-ares mailing list: http://cool.haxx.se/mailman/listinfo/c-ares
  23
  24 c-ares is of course distributed under the same MIT-style license as the
  25 original ares.
  26
  27 You'll find all c-ares details and news here:
  28         https://c-ares.haxx.se/
  29
  30
  31 Notes for c-ares hackers
  32 ------------------------
  33
  34 * The distributed `ares_build.h` file is only intended to be used on systems
  35   which can not run the also distributed configure script.
  36
  37 * The distributed `ares_build.h` file is generated as a copy of `ares_build.h.dist`
  38   when the c-ares source code distribution archive file is originally created.
  39
  40 * If you check out from git on a non-configure platform, you must run the
  41   appropriate `buildconf*` script to set up `ares_build.h` and other local files
  42   before being able to compile the library.
  43
  44 * On systems capable of running the `configure` script, the `configure` process
  45   will overwrite the distributed `ares_build.h` file with one that is suitable
  46   and specific to the library being configured and built, this new file is
  47   generated from the `ares_build.h.in` template file.
  48
  49 * If you intend to distribute an already compiled c-ares library you **MUST**
  50   also distribute along with it the generated `ares_build.h` which has been
  51   used to compile it. Otherwise the library will be of no use for the users of
  52   the library that you have built. It is **your** responsibility to provide this
  53   file. No one at the c-ares project can know how you have built the library.
  54
  55 * File `ares_build.h` includes platform and configuration dependent info,
  56   and must not be modified by anyone. Configure script generates it for you.
  57
  58 * We cannot assume anything else but very basic compiler features being
  59   present. While c-ares requires an ANSI C compiler to build, some of the
  60   earlier ANSI compilers clearly can't deal with some preprocessor operators.
  61
  62 * Newlines must remain unix-style for older compilers' sake.
  63
  64 * Comments must be written in the old-style /* unnested C-fashion */
  65
  66 * Try to keep line lengths below 80 columns.