Re: ABI conversion to ReST - Was: Re: [PATCH 0/4] reST-directive kernel-cmd / include contentent from scripts

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

 



Am 28.10.2016 um 08:54 schrieb Greg Kroah-Hartman <gregkh@xxxxxxxxxxxxxxxxxxx>:

> On Thu, Oct 27, 2016 at 10:34:05PM -0200, Mauro Carvalho Chehab wrote:
>> As defined at Documentation/ABI/README, this is actually a database
>> with those fields:
>> 
>> What, Date, KernelVersion, Contact, Description and Users.
>> 
>> An user-face documentation would probably require only a few of those
>> fields (like What and Description), but the entries should be
>> probably sorted by the What field.
>> 
>> So, I suspect it wouldn't be hard to write a perl script to parse it
>> and generate an ABI guide. On the other hand, we might need to fix
>> some documents, if the parser fails due to some typo.
> 
> That sounds like a good plan to me, and patches to fix up typos to keep
> things being able to be parsed properly should be fine.

I followed this discussion and now I wan't to come back to the "Was" of
the subject [1] where the sphinx kernel-cmd directive was introduced ;-)

My conclusion of this and other discussions on the linux-doc ML is; we
have the situation, where *old hats* want to stay with perl, since they
are productive with, while sphinx is in the python domain. And there
is a need (to answer [2]).

IMO, the sphinx kernel-cmd directive [1] is the gate in between sphinx's
python and the perl domains.

I know that Jani [2] and Jon [3] have reasonable doubt about such a
directive. So I want to ask, if we all can life with this compromise:

* rebase [1] on top of Jon's docs-next
* apply patch [4] to fix a tab issue
* fix kernel-cmd to start only *.pl scripts from Documentation/sphinx [5]
* add documentation [2] 

Should we take this away? .. if so, I can send patch series, but I want
to ask this first, before I implement a "parse-headers" replacement 
a third time. ;-)

--Markus--

[1] https://www.mail-archive.com/linux-doc@xxxxxxxxxxxxxxx/msg06657.html
[2] https://www.mail-archive.com/linux-doc@xxxxxxxxxxxxxxx/msg07075.html
[3] https://www.mail-archive.com/linux-doc@xxxxxxxxxxxxxxx/msg07080.html
[4] https://www.mail-archive.com/linux-doc@xxxxxxxxxxxxxxx/msg06941.html
[5] https://www.mail-archive.com/linux-doc@xxxxxxxxxxxxxxx/msg07082.html

--
To unsubscribe from this list: send the line "unsubscribe linux-doc" in
the body of a message to majordomo@xxxxxxxxxxxxxxx
More majordomo info at  http://vger.kernel.org/majordomo-info.html



[Index of Archives]     [Kernel Newbies]     [Security]     [Netfilter]     [Bugtraq]     [Linux FS]     [Yosemite Forum]     [MIPS Linux]     [ARM Linux]     [Linux Security]     [Linux RAID]     [Samba]     [Video 4 Linux]     [Device Mapper]     [Linux Resources]

  Powered by Linux