lkml.org 
[lkml]   [2020]   [Oct]   [14]   [last100]   RSS Feed
Views: [wrap][no wrap]   [headers]  [forward] 
 
Messages in this thread
/
SubjectRe: [PATCH v2 02/24] tools: docs: memory-model: fix references for some files
From
Date
On Wed, 14 Oct 2020 09:56:03 +0200, Mauro Carvalho Chehab wrote:
> Em Tue, 13 Oct 2020 18:58:40 -0700
> "Paul E. McKenney" <paulmck@kernel.org> escreveu:
>
>> On Tue, Oct 13, 2020 at 12:38:36PM -0400, Alan Stern wrote:
>>> On Tue, Oct 13, 2020 at 09:33:54AM -0700, Paul E. McKenney wrote:
>>>> On Tue, Oct 13, 2020 at 02:14:29PM +0200, Mauro Carvalho Chehab wrote:
>>>>> - The sysfs.txt file was converted to ReST and renamed;
>>>>> - The control-dependencies.txt is not at
>>>>> Documentation/control-dependencies.txt. As it is at the
>>>>> same dir as the README file, which mentions it, just
>>>>> remove Documentation/.
>>>>>
>>>>> With that, ./scripts/documentation-file-ref-check script
>>>>> is now happy again for files under tools/.
>>>>>
>>>>> Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
>>>>
>>>> Queued for review and testing, likely target v5.11.
>>>
>>> Instead of changing the path in the README reference, shouldn't
>>> tools/memory-model/control-dependencies.txt be moved to its proper
>>> position in .../Documentation?
>>
>> You are of course quite right. My thought is to let Mauro go ahead,
>> given his short deadline. We can then make this "git mv" change once
>> v5.10-rc1 comes out, given that it should have Mauro's patches. I have
>> added a reminder to my calendar.
>
> Sounds like a plan to me.
>
>
> If it helps on 5.11 plans, converting this file to ReST format is quite
> trivial: it just needs to use "::" for C/asm code literal blocks, and
> to replace "(*) " by something that matches ReST syntax for lists,
> like "(#) " or just "* ":
>
> https://docutils.sourceforge.io/docs/ref/rst/restructuredtext.html#bullet-lists
>
> See enclosed.

I'm afraid conversion of LKMM documents to ReST is unlikely to happen
any time soon.
It should wait until such time comes when the auto markup tools become
clever enough and .rst files looks exactly the same as plain .txt files.

Am I asking too much? :-)

Thanks, Akira

>
> Thanks,
> Mauro
>
> [PATCH] convert control-dependencies.rst to ReST
>

[snip]

\
 
 \ /
  Last update: 2020-10-14 16:14    [W:0.121 / U:5.112 seconds]
©2003-2020 Jasper Spaans|hosted at Digital Ocean and TransIP|Read the blog|Advertise on this site