docs/internals: new subdirectory

For libcurl internal APIs and concepts.

Closes #14552

diff --git a/docs/Makefile.am b/docs/Makefile.am
index 7f9dbc3bdd69d5dd5fa5ae2ddb14c6b7e1eceb93..8243cb532de9739e60bbdd530bbd5b20b2aae709 100644 (file)
--- a/docs/Makefile.am
+++ b/docs/Makefile.am
@@ -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 $< >$@
 

diff --git a/docs/BUFQ.md b/docs/internals/BUFQ.md
similarity index 100%
rename from docs/BUFQ.md
rename to docs/internals/BUFQ.md

diff --git a/docs/BUFREF.md b/docs/internals/BUFREF.md
similarity index 100%
rename from docs/BUFREF.md
rename to docs/internals/BUFREF.md

diff --git a/docs/CHECKSRC.md b/docs/internals/CHECKSRC.md
similarity index 100%
rename from docs/CHECKSRC.md
rename to docs/internals/CHECKSRC.md

diff --git a/docs/CLIENT-READERS.md b/docs/internals/CLIENT-READERS.md
similarity index 100%
rename from docs/CLIENT-READERS.md
rename to docs/internals/CLIENT-READERS.md

diff --git a/docs/CLIENT-WRITERS.md b/docs/internals/CLIENT-WRITERS.md
similarity index 100%
rename from docs/CLIENT-WRITERS.md
rename to docs/internals/CLIENT-WRITERS.md

diff --git a/docs/CODE_STYLE.md b/docs/internals/CODE_STYLE.md
similarity index 100%
rename from docs/CODE_STYLE.md
rename to docs/internals/CODE_STYLE.md

diff --git a/docs/CONNECTION-FILTERS.md b/docs/internals/CONNECTION-FILTERS.md
similarity index 100%
rename from docs/CONNECTION-FILTERS.md
rename to docs/internals/CONNECTION-FILTERS.md

diff --git a/docs/DYNBUF.md b/docs/internals/DYNBUF.md
similarity index 100%
rename from docs/DYNBUF.md
rename to docs/internals/DYNBUF.md

diff --git a/docs/HASH.md b/docs/internals/HASH.md
similarity index 100%
rename from docs/HASH.md
rename to docs/internals/HASH.md

diff --git a/docs/HYPER.md b/docs/internals/HYPER.md
similarity index 100%
rename from docs/HYPER.md
rename to docs/internals/HYPER.md

diff --git a/docs/LLIST.md b/docs/internals/LLIST.md
similarity index 100%
rename from docs/LLIST.md
rename to docs/internals/LLIST.md

diff --git a/docs/MQTT.md b/docs/internals/MQTT.md
similarity index 100%
rename from docs/MQTT.md
rename to docs/internals/MQTT.md

diff --git a/docs/NEW-PROTOCOL.md b/docs/internals/NEW-PROTOCOL.md
similarity index 100%
rename from docs/NEW-PROTOCOL.md
rename to docs/internals/NEW-PROTOCOL.md

diff --git a/docs/internals/README.md b/docs/internals/README.md
new file mode 100644 (file)
index 0000000..289b360
--- /dev/null
+++ b/docs/internals/README.md
@@ -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.

diff --git a/docs/WEBSOCKET.md b/docs/internals/WEBSOCKET.md
similarity index 100%
rename from docs/WEBSOCKET.md
rename to docs/internals/WEBSOCKET.md