mirror/curl
2
0
Fork 0
mirror of https://github.com/curl/curl.git synced 2024-12-21 06:50:10 +08:00
Code Issues Packages Projects Releases Wiki Activity
92179353e5
curl/docs/INTERNALS.md

Ignoring revisions in .git-blame-ignore-revs. Click here to bypass and see the normal blame view.

71 lines
2.2 KiB
Markdown
Raw Normal View History

docs/INTERNALS.md: clean up, refer to the book The explanatory parts are now in the everything curl book (which can also use images etc). This document now refers to that resource and only leaves listings of supported versions of libs, tools and operating systems. See https://everything.curl.dev/internals Closes #8467
2022-02-17 17:49:05 +08:00
# curl internals
moved here from the root directory
2000-05-23 01:35:35 +08:00
docs/INTERNALS.md: clean up, refer to the book The explanatory parts are now in the everything curl book (which can also use images etc). This document now refers to that resource and only leaves listings of supported versions of libs, tools and operating systems. See https://everything.curl.dev/internals Closes #8467
2022-02-17 17:49:05 +08:00
The canonical libcurl internals documentation is now in the [everything
curl](https://everything.curl.dev/internals) book. This file lists supported
versions of libs, tools and operating systems.
INTERNALS: cat lib/README* >> INTERNALS and a conversion to markdown. Removed the lib/README.* files. The idea being to move toward having INTERNALS as the one and only "book" of internals documentation. Added a TOC to top of the document.
2015-06-10 05:57:22 +08:00
docs/INTERNALS.md: clean up, refer to the book The explanatory parts are now in the everything curl book (which can also use images etc). This document now refers to that resource and only leaves listings of supported versions of libs, tools and operating systems. See https://everything.curl.dev/internals Closes #8467
2022-02-17 17:49:05 +08:00
## Portability
My first attempt at documenting what we try to support and make curl run with in regard to C standard, third party libraries and operating systems etc.
2008-06-13 05:03:16 +08:00
docs: address proselint nits - avoid exclamation marks - use consistent number of spaces after periods: one - avoid clichés - avoid using 'very' Closes #8060
2021-11-26 15:46:59 +08:00
We write curl and libcurl to compile with C89 compilers. On 32-bit and up
docs: reduce/avoid English contractions You're => You are Hasn't => Has not Doesn't => Does not Don't => Do not You'll => You will etc Closes #7930
2021-10-31 23:34:44 +08:00
machines. Most of libcurl assumes more or less POSIX compliance but that is
My first attempt at documenting what we try to support and make curl run with in regard to C standard, third party libraries and operating systems etc.
2008-06-13 05:03:16 +08:00
not a requirement.
We write libcurl to build and work with lots of third party tools, and we
want it to remain functional and buildable with these and later versions
(older versions may still work but is not what we work hard to maintain):
docs/INTERNALS.md: clean up, refer to the book The explanatory parts are now in the everything curl book (which can also use images etc). This document now refers to that resource and only leaves listings of supported versions of libs, tools and operating systems. See https://everything.curl.dev/internals Closes #8467
2022-02-17 17:49:05 +08:00
## Dependencies
We aim to support these or later versions.
INTERNALS: cat lib/README* >> INTERNALS and a conversion to markdown. Removed the lib/README.* files. The idea being to move toward having INTERNALS as the one and only "book" of internals documentation. Added a TOC to top of the document.
2015-06-10 05:57:22 +08:00
- OpenSSL 0.9.7
gnutls: bump lowest supported version to 3.1.10 GnuTLS 3.1.10 added new functions we want to use. That version was released on Mar 22, 2013. Removing support for older versions also greatly simplifies the code. Ref: #5271 Closes #5276
2020-04-21 04:23:48 +08:00
- GnuTLS 3.1.10
INTERNALS: cat lib/README* >> INTERNALS and a conversion to markdown. Removed the lib/README.* files. The idea being to move toward having INTERNALS as the one and only "book" of internals documentation. Added a TOC to top of the document.
2015-06-10 05:57:22 +08:00
- zlib 1.1.4
libssh2: require version 1.0 or later ... and simplify the code accordingly. libssh2 version 1.0 was released in April 2009. Closes #6116
2020-10-22 18:29:21 +08:00
- libssh2 1.0
INTERNALS: bump c-ares requirement to 1.16.0 Since ba904db0705c93 we use ares_getaddrinfo, added in c-ares 1.16.0
2021-09-06 22:00:52 +08:00
- c-ares 1.16.0
INTERNALS: we may use libidn2 now, not libidn
2017-11-14 19:47:04 +08:00
- libidn2 2.0.0
wolfssl: refer to it as wolfSSL only Remove support for, references to and use of "cyaSSL" from the source and docs. wolfSSL is the current name and there's no point in keeping references to ancient history. Assisted-by: Daniel Gustafsson Closes #3903
2019-06-02 22:55:05 +08:00
- wolfSSL 2.0.0
INTERNALS: cat lib/README* >> INTERNALS and a conversion to markdown. Removed the lib/README.* files. The idea being to move toward having INTERNALS as the one and only "book" of internals documentation. Added a TOC to top of the document.
2015-06-10 05:57:22 +08:00
- openldap 2.0
- MIT Kerberos 1.2.4
- GSKit V5R3M0
- NSS 3.14.x
- Heimdal ?
http2: now require nghttp2 >= 1.12.0 To simplify our code and since earlier versions lack important function calls libcurl needs to function correctly. nghttp2 1.12.0 was relased on June 26, 2016. Closes #4961
2020-02-21 18:30:05 +08:00
- nghttp2 1.12.0
win32: drop support for WinSock version 1, require version 2 IPv6, telnet and now also the multi API require WinSock version 2 which is available starting with Windows 95. Therefore we think it is time to drop support for version 1. Reviewed-by: Marcel Raad Reviewed-by: Jay Satiro Reviewed-by: Daniel Stenberg Reviewed-by: Viktor Szakats Follow up to #5634 Closes #5854
2020-08-30 18:21:53 +08:00
- WinSock 2.2 (on Windows 95+ and Windows CE .NET 4.1+)
INTERNALS: cat lib/README* >> INTERNALS and a conversion to markdown. Removed the lib/README.* files. The idea being to move toward having INTERNALS as the one and only "book" of internals documentation. Added a TOC to top of the document.
2015-06-10 05:57:22 +08:00
docs/INTERNALS.md: clean up, refer to the book The explanatory parts are now in the everything curl book (which can also use images etc). This document now refers to that resource and only leaves listings of supported versions of libs, tools and operating systems. See https://everything.curl.dev/internals Closes #8467
2022-02-17 17:49:05 +08:00
## Operating Systems
My first attempt at documenting what we try to support and make curl run with in regard to C standard, third party libraries and operating systems etc.
2008-06-13 05:03:16 +08:00
On systems where configure runs, we aim at working on them all - if they have
docs/INTERNALS.md: clean up, refer to the book The explanatory parts are now in the everything curl book (which can also use images etc). This document now refers to that resource and only leaves listings of supported versions of libs, tools and operating systems. See https://everything.curl.dev/internals Closes #8467
2022-02-17 17:49:05 +08:00
a suitable C compiler. On systems that do not run configure, we strive to
keep curl running correctly on:
My first attempt at documenting what we try to support and make curl run with in regard to C standard, third party libraries and operating systems etc.
2008-06-13 05:03:16 +08:00
INTERNALS: cat lib/README* >> INTERNALS and a conversion to markdown. Removed the lib/README.* files. The idea being to move toward having INTERNALS as the one and only "book" of internals documentation. Added a TOC to top of the document.
2015-06-10 05:57:22 +08:00
- Windows 98
- AS/400 V5R3M0
- Symbian 9.1
- Windows CE ?
- TPF ?
docs/INTERNALS.md: clean up, refer to the book The explanatory parts are now in the everything curl book (which can also use images etc). This document now refers to that resource and only leaves listings of supported versions of libs, tools and operating systems. See https://everything.curl.dev/internals Closes #8467
2022-02-17 17:49:05 +08:00
## Build tools
My first attempt at documenting what we try to support and make curl run with in regard to C standard, third party libraries and operating systems etc.
2008-06-13 05:03:16 +08:00
added the versions of a range of build tools that we want to remain to work
2008-06-13 05:16:00 +08:00
When writing code (mostly for generating stuff included in release tarballs)
we use a few "build tools" and we make sure that we remain functional with
these versions:
INTERNALS: cat lib/README* >> INTERNALS and a conversion to markdown. Removed the lib/README.* files. The idea being to move toward having INTERNALS as the one and only "book" of internals documentation. Added a TOC to top of the document.
2015-06-10 05:57:22 +08:00
- GNU Libtool 1.4.2
- GNU Autoconf 2.57
- GNU Automake 1.7
- GNU M4 1.4
- perl 5.004
- roffit 0.5
docs: Markdown and misc improvements [ci skip] Approved-by: Daniel Stenberg Closes #3896
2019-05-17 06:11:27 +08:00
- groff ? (any version that supports `groff -Tps -man [in] [out]`)
INTERNALS: bring back the "Library symbols" section Most contents was moved, but this text should remain here. Follow-up to: d324ac8 Reported-by: Viktor Szakats Bug: https://github.com/curl/curl/pull/9027#discussion_r903382326 Closes #9037
2022-06-22 15:40:39 +08:00
Library Symbols
===============
All symbols used internally in libcurl must use a `Curl_` prefix if they are
used in more than a single file. Single-file symbols must be made static.
Public ("exported") symbols must use a `curl_` prefix. (There are exceptions,
but they are to be changed to follow this pattern in future versions.) Public
API functions are marked with `CURL_EXTERN` in the public header files so
that all others can be hidden on platforms where this is possible.
Reference in New Issue Copy Permalink