docs/internals: new subdirectory
For libcurl internal APIs and concepts. Closes #14552
This commit is contained in:
parent
3932964793
commit
20aa8d8f31
@ -40,55 +40,60 @@ if BUILD_DOCS
|
|||||||
CLEANFILES = mk-ca-bundle.1 curl-config.1
|
CLEANFILES = mk-ca-bundle.1 curl-config.1
|
||||||
endif
|
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 = \
|
EXTRA_DIST = \
|
||||||
$(CURLPAGES) \
|
$(CURLPAGES) \
|
||||||
|
$(INTERNALDOCS) \
|
||||||
ALTSVC.md \
|
ALTSVC.md \
|
||||||
BINDINGS.md \
|
BINDINGS.md \
|
||||||
BUFQ.md \
|
|
||||||
BUFREF.md \
|
|
||||||
BUG-BOUNTY.md \
|
BUG-BOUNTY.md \
|
||||||
BUGS.md \
|
BUGS.md \
|
||||||
CHECKSRC.md \
|
|
||||||
CIPHERS.md \
|
CIPHERS.md \
|
||||||
CIPHERS-TLS12.md \
|
CIPHERS-TLS12.md \
|
||||||
CMakeLists.txt \
|
CMakeLists.txt \
|
||||||
CODE_OF_CONDUCT.md \
|
CODE_OF_CONDUCT.md \
|
||||||
CODE_REVIEW.md \
|
CODE_REVIEW.md \
|
||||||
CODE_STYLE.md \
|
|
||||||
CLIENT-READERS.md \
|
|
||||||
CLIENT-WRITERS.md \
|
|
||||||
CONNECTION-FILTERS.md \
|
|
||||||
CONTRIBUTE.md \
|
CONTRIBUTE.md \
|
||||||
CURL-DISABLE.md \
|
CURL-DISABLE.md \
|
||||||
CURLDOWN.md \
|
CURLDOWN.md \
|
||||||
DEPRECATE.md \
|
DEPRECATE.md \
|
||||||
DISTROS.md \
|
DISTROS.md \
|
||||||
DYNBUF.md \
|
|
||||||
EARLY-RELEASE.md \
|
EARLY-RELEASE.md \
|
||||||
ECH.md \
|
ECH.md \
|
||||||
EXPERIMENTAL.md \
|
EXPERIMENTAL.md \
|
||||||
FAQ \
|
FAQ \
|
||||||
FEATURES.md \
|
FEATURES.md \
|
||||||
GOVERNANCE.md \
|
GOVERNANCE.md \
|
||||||
HASH.md \
|
|
||||||
HELP-US.md \
|
HELP-US.md \
|
||||||
HISTORY.md \
|
HISTORY.md \
|
||||||
HSTS.md \
|
HSTS.md \
|
||||||
HTTP-COOKIES.md \
|
HTTP-COOKIES.md \
|
||||||
HTTP2.md \
|
HTTP2.md \
|
||||||
HTTP3.md \
|
HTTP3.md \
|
||||||
HYPER.md \
|
|
||||||
INSTALL \
|
INSTALL \
|
||||||
INSTALL-CMAKE.md \
|
INSTALL-CMAKE.md \
|
||||||
INSTALL.md \
|
INSTALL.md \
|
||||||
INTERNALS.md \
|
INTERNALS.md \
|
||||||
IPFS.md \
|
IPFS.md \
|
||||||
LLIST.md \
|
|
||||||
KNOWN_BUGS \
|
KNOWN_BUGS \
|
||||||
MAIL-ETIQUETTE.md \
|
MAIL-ETIQUETTE.md \
|
||||||
MANUAL.md \
|
MANUAL.md \
|
||||||
MQTT.md \
|
|
||||||
NEW-PROTOCOL.md \
|
|
||||||
options-in-versions \
|
options-in-versions \
|
||||||
PARALLEL-TRANSFERS.md \
|
PARALLEL-TRANSFERS.md \
|
||||||
README.md \
|
README.md \
|
||||||
@ -99,13 +104,11 @@ EXTRA_DIST = \
|
|||||||
SPONSORS.md \
|
SPONSORS.md \
|
||||||
SSL-PROBLEMS.md \
|
SSL-PROBLEMS.md \
|
||||||
SSLCERTS.md \
|
SSLCERTS.md \
|
||||||
THANKS \
|
THANKS TODO \
|
||||||
TODO \
|
|
||||||
TheArtOfHttpScripting.md \
|
TheArtOfHttpScripting.md \
|
||||||
URL-SYNTAX.md \
|
URL-SYNTAX.md \
|
||||||
VERSIONS.md \
|
VERSIONS.md \
|
||||||
VULN-DISCLOSURE-POLICY.md \
|
VULN-DISCLOSURE-POLICY.md
|
||||||
WEBSOCKET.md
|
|
||||||
|
|
||||||
CD2NROFF = $(top_srcdir)/scripts/cd2nroff $< >$@
|
CD2NROFF = $(top_srcdir)/scripts/cd2nroff $< >$@
|
||||||
|
|
||||||
|
|||||||
12
docs/internals/README.md
Normal file
12
docs/internals/README.md
Normal 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.
|
||||||
Loading…
Reference in New Issue
Block a user