]> git.ipfire.org Git - thirdparty/curl.git/commitdiff
INTERNALS: bring back the "Library symbols" section
authorDaniel Stenberg <daniel@haxx.se>
Wed, 22 Jun 2022 07:40:39 +0000 (09:40 +0200)
committerDaniel Stenberg <daniel@haxx.se>
Wed, 22 Jun 2022 08:38:03 +0000 (10:38 +0200)
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

docs/INTERNALS.md

index c9fe47e90b8b80d1b5bff5ffacdf49dedccbe9a0..7da0be5a55d52af5987bf24df6878a2646900602 100644 (file)
@@ -58,3 +58,13 @@ versions of libs, tools and operating systems.
  - perl         5.004
  - roffit       0.5
  - groff        ? (any version that supports `groff -Tps -man [in] [out]`)
+
+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.