linux-kernel - Re: [PATCH 7/8] Documentation: Move "core core" api into a separate file

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [<thread-prev] [thread-next>] [day] [month] [year] [list]

Date: Tue, 23 Jan 2024 16:57:02 -0800
From: Randy Dunlap <rdunlap@...radead.org>
To: Anna-Maria Behnsen <anna-maria@...utronix.de>,
 linux-kernel@...r.kernel.org
Cc: Thomas Gleixner <tglx@...utronix.de>,
 Frederic Weisbecker <frederic@...nel.org>, Ingo Molnar <mingo@...nel.org>,
 John Stultz <jstultz@...gle.com>, Stephen Boyd <sboyd@...nel.org>,
 Jonathan Corbet <corbet@....net>, Clemens Ladisch <clemens@...isch.de>,
 linux-doc@...r.kernel.org
Subject: Re: [PATCH 7/8] Documentation: Move "core core" api into a separate
 file



On 1/23/24 08:47, Anna-Maria Behnsen wrote:
> Some "core core" API as timer API is documented in driver-api. This is
> definitely the wrong place. As the subject description in
> core-api/index.rst mentions, is also core-api/kernel-api.rst a collection
> of leftovers. Therefore create a new core-api file and start to integrate
> timer api. As this contains a lot of functions, it is separated into a
> timer specific API file.
> 
> Signed-off-by: Anna-Maria Behnsen <anna-maria@...utronix.de>
> ---
>  Documentation/core-api/core-api.rst     | 14 ++++++
>  Documentation/core-api/index.rst        |  4 +-
>  Documentation/core-api/kernel-api.rst   | 12 +++--
>  Documentation/core-api/timers/api.rst   | 63 +++++++++++++++++++++++++
>  Documentation/core-api/timers/index.rst |  4 ++
>  Documentation/driver-api/basics.rst     | 24 ----------
>  6 files changed, 93 insertions(+), 28 deletions(-)
>  create mode 100644 Documentation/core-api/core-api.rst
>  create mode 100644 Documentation/core-api/timers/api.rst
> 
> diff --git a/Documentation/core-api/core-api.rst b/Documentation/core-api/core-api.rst
> new file mode 100644
> index 000000000000..4fe00d084dc7
> --- /dev/null
> +++ b/Documentation/core-api/core-api.rst
> @@ -0,0 +1,14 @@
> +.. SPDX-License-Identifier: GPL-2.0
> +
> +=========================
> +The Linux Kernel Core API
> +=========================
> +
> +.. note:: Some Core API is still documented in :doc:`../driver-api/basic` and

I'm getting this warning from the line above:

linux-next-20240123/Documentation/core-api/core-api.rst:7: WARNING: unknown document: '../driver-api/basic'

Ah, it should be "basics".

> +          needs to be moved here. As this document will be huge when it contains
> +          the whole API, split the API for a special part into a separate file.
> +
> +Timers
> +======
> +
> +For timer related API, please refere to :doc:`timers/api`.


-- 
#Randy