docs/internals: new subdirectory

For libcurl internal APIs and concepts.

Closes #14552
This commit is contained in:
Daniel Stenberg 2024-08-15 14:05:23 +02:00
parent 3932964793
commit 20aa8d8f31
No known key found for this signature in database
GPG Key ID: 5CC908FDB71E12C2
16 changed files with 32 additions and 17 deletions

View File

@ -40,55 +40,60 @@ if BUILD_DOCS
CLEANFILES = mk-ca-bundle.1 curl-config.1
endif
INTERNALDOCS = \
internals/BUFQ.md \
internals/BUFREF.md \
internals/CHECKSRC.md \
internals/CLIENT-READERS.md \
internals/CLIENT-WRITERS.md \
internals/CODE_STYLE.md \
internals/CONNECTION-FILTERS.md \
internals/DYNBUF.md \
internals/HASH.md \
internals/HYPER.md \
internals/LLIST.md \
internals/MQTT.md \
internals/NEW-PROTOCOL.md \
internals/README.md \
internals/WEBSOCKET.md
EXTRA_DIST = \
$(CURLPAGES) \
$(INTERNALDOCS) \
ALTSVC.md \
BINDINGS.md \
BUFQ.md \
BUFREF.md \
BUG-BOUNTY.md \
BUGS.md \
CHECKSRC.md \
CIPHERS.md \
CIPHERS-TLS12.md \
CMakeLists.txt \
CODE_OF_CONDUCT.md \
CODE_REVIEW.md \
CODE_STYLE.md \
CLIENT-READERS.md \
CLIENT-WRITERS.md \
CONNECTION-FILTERS.md \
CONTRIBUTE.md \
CURL-DISABLE.md \
CURLDOWN.md \
DEPRECATE.md \
DISTROS.md \
DYNBUF.md \
EARLY-RELEASE.md \
ECH.md \
EXPERIMENTAL.md \
FAQ \
FEATURES.md \
GOVERNANCE.md \
HASH.md \
HELP-US.md \
HISTORY.md \
HSTS.md \
HTTP-COOKIES.md \
HTTP2.md \
HTTP3.md \
HYPER.md \
INSTALL \
INSTALL-CMAKE.md \
INSTALL.md \
INTERNALS.md \
IPFS.md \
LLIST.md \
KNOWN_BUGS \
MAIL-ETIQUETTE.md \
MANUAL.md \
MQTT.md \
NEW-PROTOCOL.md \
options-in-versions \
PARALLEL-TRANSFERS.md \
README.md \
@ -99,13 +104,11 @@ EXTRA_DIST = \
SPONSORS.md \
SSL-PROBLEMS.md \
SSLCERTS.md \
THANKS \
TODO \
THANKS TODO \
TheArtOfHttpScripting.md \
URL-SYNTAX.md \
VERSIONS.md \
VULN-DISCLOSURE-POLICY.md \
WEBSOCKET.md
VULN-DISCLOSURE-POLICY.md
CD2NROFF = $(top_srcdir)/scripts/cd2nroff $< >$@

12
docs/internals/README.md Normal file
View File

@ -0,0 +1,12 @@
<!--
Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al.
SPDX-License-Identifier: curl
-->
# Internals
This directory contains documentation covering libcurl internals; APIs and
concepts that are useful for contributors and maintainers.
Public APIs are documented in the public documentation, not here.