docs: Introduce deprecated APIs list
Subsystems (2)
PATCH v2 1/1 docs: Introduce deprecated APIs list
As discussed in the "API replacement/deprecation" thread[1], this makes an effort to document what things shouldn't get (re)added to the kernel, by introducing Documentation/process/deprecated.rst.
[1] https://lists.linuxfoundation.org/pipermail/ksummit-discuss/2018-September/005282.html
---
v2: drop overflow.h hack, try to clarify open-coded math description
--- Documentation/driver-api/basics.rst | 3 + Documentation/process/deprecated.rst | 119 +++++++++++++++++++++++++++ Documentation/process/index.rst | 1 + 3 files changed, 123 insertions(+) create mode 100644 Documentation/process/deprecated.rst
Documentation/driver-api/basics.rst +3 -0
@@ -121,6 +121,9 @@ Kernel utility functions .. kernel-doc:: kernel/rcu/update.c :export: +.. kernel-doc:: include/linux/overflow.h + :internal: + Device Resource Management --------------------------
Documentation/process/deprecated.rst new file +119 -0
119 lines not on this page · raw message
Documentation/process/index.rst +1 -0
@@ -41,6 +41,7 @@ Other guides to the community that are of interest to most developers are: stable-kernel-rules submit-checklist kernel-docs + deprecated These are some overall technical guides that have been put here for now for lack of a better place.
Signature · 6 lines
2.17.1 -- Kees Cook Pixel Security
Quoted 7 lines · On Wed, 17 Oct 2018 16:45:32 -0700 Kees Cook <[email protected]> wrote:
As discussed in the "API replacement/deprecation" thread[1], this makes an effort to document what things shouldn't get (re)added to the kernel, by introducing
Documentation/process/deprecated.rst.[1] https://lists.linuxfoundation.org/pipermail/ksummit-discuss/2018-September/005282.html
Signed-off-by Kees Cook <[email protected]>
Applied, thanks.
jon