File: INTERNALS.md

package info (click to toggle)
curl 8.19.0-1
  • links: PTS, VCS
  • area: main
  • in suites: forky
  • size: 31,884 kB
  • sloc: ansic: 200,254; perl: 21,116; python: 10,390; sh: 6,691; makefile: 1,507; pascal: 240; cpp: 196
file content (68 lines) | stat: -rw-r--r-- 2,444 bytes parent folder | download | duplicates (7)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
<!--
Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al.

SPDX-License-Identifier: curl
-->

# curl internals

The canonical libcurl internals documentation is now in the [everything
curl](https://everything.curl.dev/internals) book. This file lists supported
versions of libs and build tools.

## Portability

We write curl and libcurl to compile with C89 compilers on 32-bit and up
machines. Most of libcurl assumes more or less POSIX compliance but that is
not a requirement. The compiler must support a 64-bit integer type as well as
supply a stdint.h header file that defines C99-style fixed-width integer types
like uint32_t.

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):

## Dependencies

We aim to support these or later versions.

- brotli       1.0.0 (2017-09-21)
- c-ares       1.6.0 (2008-12-09)
- GnuTLS       3.6.5 (2018-12-01)
- libidn2      2.0.0 (2017-03-29)
- LibreSSL     2.9.1 (2019-04-22)
- libssh       0.9.0 (2019-06-28)
- libssh2      1.9.0 (2019-06-20)
- mbedTLS      3.2.0 (2022-07-11)
- MIT Kerberos 1.3 (2003-07-31)
- nghttp2      1.15.0 (2016-09-25)
- OpenLDAP     2.0 (2000-08-01)
- OpenSSL      3.0.0 (2021-09-07)
- Windows      Vista 6.0 (2006-11-08 - 2012-04-10)
- wolfSSL      3.4.6 (2017-09-22)
- zlib         1.2.5.2 (2011-12-11)
- zstd         1.0 (2016-08-31)

## Build tools

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:

- clang-tidy     17.0.0 (2023-09-19), recommended: 19.1.0 or later (2024-09-17)
- cmake          3.7 (2016-11-11)
- GNU autoconf   2.59 (2003-11-06)
- GNU automake   1.7 (2002-09-25)
- GNU libtool    1.4.2 (2001-09-11)
- GNU m4         1.4 (2007-09-21)
- mingw-w64      3.0 (2013-09-20)
- perl           5.8 (2002-07-19), on Windows: 5.22 (2015-06-01)
- Visual Studio  2010 10.0 (2010-04-12 - 2020-07-14)

## 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. 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.