Received-SPF: pass (google.com: domain of linux-kernel+bounces-38407-linux.lists.archive=gmail.com@vger.kernel.org designates 147.75.48.161 as permitted sender) client-ip=147.75.48.161;
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
In-Reply-To: <71285bc1-bf38-49ea-ab77-3258727339e3@infradead.org>
References: <20240123164702.55612-1-anna-maria@linutronix.de>
 <20240123164702.55612-8-anna-maria@linutronix.de>
 <71285bc1-bf38-49ea-ab77-3258727339e3@infradead.org>
Date: Thu, 25 Jan 2024 11:40:53 +0100
Message-ID: <87le8dd7be.fsf@somnus>
Precedence: bulk
MIME-Version: 1.0
Content-Type: text/plain

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