1
0
mirror of https://github.com/moparisthebest/curl synced 2024-08-13 17:03:50 -04:00
curl/docs
Yang Tse 5a053ffe80 build: fix circular header inclusion with other packages
This commit renames lib/setup.h to lib/curl_setup.h and
renames lib/setup_once.h to lib/curl_setup_once.h.

Removes the need and usage of a header inclusion guard foreign
to libcurl. [1]

Removes the need and presence of an alarming notice we carried
in old setup_once.h [2]

----------------------------------------

1 - lib/setup_once.h used __SETUP_ONCE_H macro as header inclusion guard
    up to commit ec691ca3 which changed this to HEADER_CURL_SETUP_ONCE_H,
    this single inclusion guard is enough to ensure that inclusion of
    lib/setup_once.h done from lib/setup.h is only done once.

    Additionally lib/setup.h has always used __SETUP_ONCE_H macro to
    protect inclusion of setup_once.h even after commit ec691ca3, this
    was to avoid a circular header inclusion triggered when building a
    c-ares enabled version with c-ares sources available which also has
    a setup_once.h header. Commit ec691ca3 exposes the real nature of
    __SETUP_ONCE_H usage in lib/setup.h, it is a header inclusion guard
    foreign to libcurl belonging to c-ares's setup_once.h

    The renaming this commit does, fixes the circular header inclusion,
    and as such removes the need and usage of a header inclusion guard
    foreign to libcurl. Macro __SETUP_ONCE_H no longer used in libcurl.

2 - Due to the circular interdependency of old lib/setup_once.h and the
    c-ares setup_once.h header, old file lib/setup_once.h has carried
    back from 2006 up to now days an alarming and prominent notice about
    the need of keeping libcurl's and c-ares's setup_once.h in sync.

    Given that this commit fixes the circular interdependency, the need
    and presence of mentioned notice is removed.

    All mentioned interdependencies come back from now old days when
    the c-ares project lived inside a curl subdirectory. This commit
    removes last traces of such fact.
2013-01-09 00:49:50 +01:00
..
examples build: fix circular header inclusion with other packages 2013-01-09 00:49:50 +01:00
libcurl DOCS: Updated CURLOPT_CONNECT_ONLY to reflect usage in other protocols 2012-11-23 13:43:53 +00:00
.gitignore IGNORE: files generated by maketgz 2010-04-14 17:34:57 +02:00
BINDINGS a binding for Falcon 2009-11-29 19:12:00 +00:00
BUGS BUGS: fix the bug tracker URL 2012-11-01 21:36:28 +01:00
CONTRIBUTE Fixed some typos in documentation 2012-07-20 21:02:58 +02:00
curl-config.1 curl-config.1: fix curl-config usage in example 2012-05-20 15:38:54 +02:00
curl.1 writeout: -w now supports remote_ip/port and local_ip/port 2013-01-03 23:16:38 +01:00
DISTRO-DILEMMA removed trailing whitespace 2010-02-14 19:40:18 +00:00
FAQ FAQ: Can I write a server with libcurl? 2013-01-03 10:15:20 +01:00
FEATURES Fixed some typos in documentation 2012-07-20 21:02:58 +02:00
HISTORY HISTORY: mention the gopher story 2010-08-28 22:51:22 +02:00
HTTP-COOKIES HTTP-COOKIES: clarified and modified layout 2012-07-03 11:10:41 +02:00
index.html added doctype tag to get HTML compliant 2004-04-27 07:05:22 +00:00
INSTALL build: fix circular header inclusion with other packages 2013-01-09 00:49:50 +01:00
INSTALL.cmake curl tool: renaming hugehelp files to tool_hugehelp 2012-12-26 23:30:54 +01:00
INSTALL.devcpp Fixed some typos in documentation 2012-07-20 21:02:58 +02:00
INTERNALS Revert "configure: update req to 2.59" 2013-01-08 19:02:13 +01:00
KNOWN_BUGS socks.c: Added support for IPv6 connections through SOCKSv5 proxy 2012-09-14 00:14:38 +02:00
LICENSE-MIXING Mention axTLS in some more documentation 2011-01-21 14:27:10 -08:00
MAIL-ETIQUETTE Fixed some typos in documentation 2012-07-20 21:02:58 +02:00
Makefile.am HTTP-COOKIES: added cookie documentation 2012-07-03 09:03:08 +02:00
MANUAL MANUAL: clarified user+password in HTTP URLs 2012-09-09 23:08:59 +02:00
mk-ca-bundle.1 mk-ca-bundle.1: convert syntax to what's used elsewhere 2013-01-06 00:15:36 +01:00
README.cmake removed execute file permission 2011-12-30 03:53:25 +01:00
README.netware removed trailing whitespace 2010-02-14 19:40:18 +00:00
README.win32 removed trailing whitespace 2010-02-14 19:40:18 +00:00
RESOURCES Implement SMTP authentication 2010-04-19 11:16:30 +02:00
SSLCERTS removed trailing whitespace 2010-02-14 19:40:18 +00:00
THANKS THANKS: added 14 contributors from the 7.28.1 release 2012-11-20 10:25:25 +01:00
TheArtOfHttpScripting TheArtOfHttpScripting: extended 2011-01-19 13:08:03 +01:00
TODO Revert changes relative to lib/*.[ch] recent renaming 2013-01-06 18:20:27 +01:00
VERSIONS VERSIONS: clarify our versioning concept 2011-08-08 09:25:59 +02:00

                                  _   _ ____  _
                              ___| | | |  _ \| |
                             / __| | | | |_) | |
                            | (__| |_| |  _ <| |___
                             \___|\___/|_| \_\_____|

README.win32

  Read the README file first.

  Curl has been compiled, built and run on all sorts of Windows and win32
  systems. While not being the main develop target, a fair share of curl users
  are win32-based.

  The unix-style man pages are tricky to read on windows, so therefore are all
  those pages converted to HTML as well as pdf, and included in the release
  archives.

  The main curl.1 man page is also "built-in" in the command line tool. Use a
  command line similar to this in order to extract a separate text file:

        curl -M >manual.txt

  Read the INSTALL file for instructions how to compile curl self.