From: Anna-Maria Behnsen <anna-maria@linutronix.de>
To: Randy Dunlap <rdunlap@infradead.org>, linux-kernel@vger.kernel.org
Cc: Thomas Gleixner <tglx@linutronix.de>,
Frederic Weisbecker <frederic@kernel.org>,
Ingo Molnar <mingo@kernel.org>, John Stultz <jstultz@google.com>,
Stephen Boyd <sboyd@kernel.org>, Jonathan Corbet <corbet@lwn.net>,
Clemens Ladisch <clemens@ladisch.de>,
linux-doc@vger.kernel.org
Subject: Re: [PATCH 7/8] Documentation: Move "core core" api into a separate file
Date: Thu, 25 Jan 2024 11:40:53 +0100 [thread overview]
Message-ID: <87le8dd7be.fsf@somnus> (raw)
In-Reply-To: <71285bc1-bf38-49ea-ab77-3258727339e3@infradead.org>
Randy Dunlap <rdunlap@infradead.org> writes:
> 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@linutronix.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".
>
Oh no! I fixed it - but didn't update the patch... I'm sorry!
Thanks,
Anna-Maria
next prev parent reply other threads:[~2024-01-25 10:40 UTC|newest]
Thread overview: 27+ messages / expand[flat|nested] mbox.gz Atom feed top
2024-01-23 16:46 [PATCH 0/8] timers and Documentation: Cleanup Anna-Maria Behnsen
2024-01-23 16:46 ` [PATCH 1/8] include/hrtimers: Move hrtimer base related definitions into hrtimer_defs Anna-Maria Behnsen
2024-01-25 8:17 ` Thomas Gleixner
2024-01-25 12:20 ` Anna-Maria Behnsen
2024-01-25 13:34 ` Thomas Gleixner
2024-02-19 8:45 ` [tip: timers/core] hrtimers: Move hrtimer base related definitions into hrtimer_defs.h tip-bot2 for Anna-Maria Behnsen
2024-01-23 16:46 ` [PATCH 2/8] hrtimers: Update formatting of documentation Anna-Maria Behnsen
2024-02-19 8:45 ` [tip: timers/core] " tip-bot2 for Anna-Maria Behnsen
2024-01-23 16:46 ` [PATCH 3/8] tick/sched: Add function description for tick_nohz_next_event() Anna-Maria Behnsen
2024-02-19 8:45 ` [tip: timers/core] " tip-bot2 for Anna-Maria Behnsen
2024-01-23 16:46 ` [PATCH 4/8] timers: Add struct member description for timer_base Anna-Maria Behnsen
2024-02-19 8:45 ` [tip: timers/core] " tip-bot2 for Anna-Maria Behnsen
2024-01-23 16:46 ` [PATCH 5/8] jiffies: Transform comment about time_* functions into DOC block Anna-Maria Behnsen
2024-02-19 8:45 ` [tip: timers/core] " tip-bot2 for Anna-Maria Behnsen
2024-01-23 16:47 ` [PATCH 6/8] Documentation: Create a new folder for all timer internals Anna-Maria Behnsen
2024-01-24 1:26 ` Randy Dunlap
2024-01-25 10:39 ` Anna-Maria Behnsen
2024-01-25 15:00 ` Jonathan Corbet
2024-01-25 15:27 ` Jani Nikula
2024-01-25 16:55 ` Anna-Maria Behnsen
2024-01-25 16:52 ` Anna-Maria Behnsen
2024-01-25 19:50 ` Jonathan Corbet
2024-01-29 13:21 ` Anna-Maria Behnsen
2024-01-23 16:47 ` [PATCH 7/8] Documentation: Move "core core" api into a separate file Anna-Maria Behnsen
2024-01-24 0:57 ` Randy Dunlap
2024-01-25 10:40 ` Anna-Maria Behnsen [this message]
2024-01-23 16:47 ` [PATCH 8/8] timers: Add timer wheel documentation Anna-Maria Behnsen
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=87le8dd7be.fsf@somnus \
--to=anna-maria@linutronix.de \
--cc=clemens@ladisch.de \
--cc=corbet@lwn.net \
--cc=frederic@kernel.org \
--cc=jstultz@google.com \
--cc=linux-doc@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=mingo@kernel.org \
--cc=rdunlap@infradead.org \
--cc=sboyd@kernel.org \
--cc=tglx@linutronix.de \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.