aboutsummaryrefslogtreecommitdiffstats
path: root/doc/dev_ref/mistakes.rst
diff options
context:
space:
mode:
authorJack Lloyd <[email protected]>2019-06-07 09:39:46 -0400
committerJack Lloyd <[email protected]>2019-06-07 12:49:22 -0400
commitb5513cd0d95b0ed99c581900fea226771b74339c (patch)
tree8d7e4ac14e93a527bc654cd325188bc30d753d80 /doc/dev_ref/mistakes.rst
parent762a76edc0240d3028ed17b9fb6e394ab3eac6cf (diff)
Officially deprecate headers
Create BOTAN_DEPRECATED_HEADER so we can warn about this consistently. Shuffle around the filter headers so all of the concrete filters are defined in filters.h instead of being spread across many headers. Document which headers are deprecated as well as a list of headers which will be made internal-only in a future major release.
Diffstat (limited to 'doc/dev_ref/mistakes.rst')
-rw-r--r--doc/dev_ref/mistakes.rst7
1 files changed, 7 insertions, 0 deletions
diff --git a/doc/dev_ref/mistakes.rst b/doc/dev_ref/mistakes.rst
index 9f89e3059..03b2c7905 100644
--- a/doc/dev_ref/mistakes.rst
+++ b/doc/dev_ref/mistakes.rst
@@ -27,6 +27,13 @@ the overall API and ABI surface.
These interfaces are now deprecated, and perhaps will be able to be
removed eventually.
+Header Directories
+-------------------
+
+It would have been better to install all headers as ``X/header.h``
+where ``X`` is the base dir in the source, eg ``block/aes128.h``,
+``hash/md5.h``, ...
+
Exceptions
-----------