[<prev] [next>] [<thread-prev] [thread-next>] [day] [month] [year] [list]
Message-ID: <87plxkqnq5.fsf@somnus>
Date: Mon, 29 Jan 2024 14:21:38 +0100
From: Anna-Maria Behnsen <anna-maria@...utronix.de>
To: Jonathan Corbet <corbet@....net>, Randy Dunlap <rdunlap@...radead.org>,
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>, Clemens Ladisch
<clemens@...isch.de>, linux-doc@...r.kernel.org
Subject: Re: [PATCH 6/8] Documentation: Create a new folder for all timer
internals
Jonathan Corbet <corbet@....net> writes:
> Anna-Maria Behnsen <anna-maria@...utronix.de> writes:
>
>>> I've thought for a while that we should have a standard warning or two
>>> along these lines, like Wikipedia does, but of course haven't done
>>> anything about it.
>>>
>>
>> Sure, if we could standardize it, I would definitely prefere it! For me
>> as a not sphinx/rst/... expert, it would be great if only something like
>>
>> .. might_be_outdated:: <optional additional text>
>>
>> needs to be added to the code. And then the default lines would appear
>> together with the optional additional text.
>>
>> Is this what you have been thinking about?
>
> You've already put more thought into it than I have :)
>
> I was just thinking in terms of some relatively standard text. I'd
> rather not create an extension just for this, but Jani's idea of using
> the todo extension could work, or just a convention like:
>
> .. include crufty-stuff-note.rst
>
> might be good enough and not require an extension at all.
Maybe also a combination of both - using the todo extension inside the
include file?
I would integrate it into a v2, but I'm not sure, when I have time to
prepare it.
Thanks,
Anna-Maria
Powered by blists - more mailing lists