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

[Randy Dunlap]

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@xxxxxxxxxxxxx>
> ---
>  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