linux-kernel - Re: [PATCH 00/10] Documentation/Sphinx

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives
Hash Suite: Windows password security audit tool. GUI, reports in PDF.
[<prev] [next>] [<thread-prev] [day] [month] [year] [list]
Date:	Wed, 29 Jun 2016 14:41:07 +0200
From:	Markus Heiser <markus.heiser@...marit.de>
To:	Mauro Carvalho Chehab <mchehab@....samsung.com>
Cc:	Jani Nikula <jani.nikula@...el.com>,
	Daniel Vetter <daniel.vetter@...ll.ch>,
	Jonathan Corbet <corbet@....net>,
	Grant Likely <grant.likely@...retlab.ca>,
	Dan Allen <dan@...ndevise.io>,
	Russel Winder <russel@...der.org.uk>,
	Keith Packard <keithp@...thp.com>,
	LKML <linux-kernel@...r.kernel.org>, linux-doc@...r.kernel.org,
	Hans Verkuil <hverkuil@...all.nl>
Subject: Re: [PATCH 00/10] Documentation/Sphinx


Am 27.06.2016 um 19:08 schrieb Mauro Carvalho Chehab <mchehab@....samsung.com>:

> Em Mon, 27 Jun 2016 08:15:28 +0200
> Markus Heiser <markus.heiser@...marit.de> escreveu:
> 
>> Am 24.06.2016 um 12:40 schrieb Mauro Carvalho Chehab <mchehab@....samsung.com>:
>> 
>>> Em Tue, 31 May 2016 12:16:25 +0200
>>> Markus Heiser <markus.heiser@...marit.de> escreveu:
>>> 
>>>> Am 30.05.2016 um 23:23 schrieb Mauro Carvalho Chehab <mchehab@....samsung.com>:
>>>> 
>>>>> Em Mon, 30 May 2016 23:05:34 +0300
>>>>> Jani Nikula <jani.nikula@...el.com> escreveu:
>>>>> 
>>>>>>> I worry a little bit in that reST will be only one more toolchain 
>>>>>>> beside DocBook .. in the long term, kernel's documentation 
>>>>>>> should get rid of all the DocBook artifacts and for this a more
>>>>>>> comprehensive solution is needed.      
>>>>>> 
>>>>>> We agree on the end goal, eradicate DocBook. I must say that in my
>>>>>> experiments, apart from the media docs, almost everything converts
>>>>>> surprisingly nicely or IMO "good enough" with just the tmplcvt script in
>>>>>> this series.    
>>>>> 
>>>>> With regards to media, my plan is to merge create a topic branch based
>>>>> on Kernel 4.7-rc1 at:
>>>>> 	https://git.linuxtv.org/media_tree.git/
>>>>> 
>>>>> As none of the Jani's patches seem to affect the media API docs, it
>>>>> seems I don't need to merge back from Jon's -next branch.
>>>>> 
>>>>> There, I intend to add Markus patches with the conversion from the
>>>>> DocBook to rst, plus the flat-table extension logic.
>>>>> 
>>>>> Then, I'll work to manually fix what's needed and I'll add the 
>>>>> automation scripting logic that we have at the DocBook Makefile
>>>>> to work with the new media rst files.
>>>>> 
>>>>> Lastly, once the job's done, I'll drop Documentation/DocBook/media.
>>>>> 
>>>>> Markus,
>>>>> 
>>>>> With that regards, could you please send the patches to me?    
>>>> 
>>>> Yes. What is your timeline ... is it OK if I send you a patch in the 
>>>> next two weeks? ... first I wan't to finish my other work / I'am just
>>>> back from holiday .. a lot of work to do :-o  
>>> 
>>> Hi Markus,
>>> 
>>> I'm wanting to start working on it next week, if possible.
>>> 
>>> I created an experimental branch on my tree for such work, where
>>> I'm merging from both Jon's doc-next tree and from media tree at:
>>> 	https://git.linuxtv.org//mchehab/experimental.git/log/?h=docs-next
>>> 
>>> Could you please rebase your work with the media DocBook and with
>>> the flat-table support to be on the top of it?
>>> 
>>> Thanks!
>>> Mauro  
>> 
>> Hi Mauro,
>> 
>> sorry for my late reply, I finished the man-page builder last weekend.
>> 
>>> I'm merging from both Jon's doc-next tree and from media tree  
>> 
>> Currently I'am working on a rebase on top of the Jon's docs-next branch
>> (with "s" in "docs-" / think it was only a typo). 
>> 
>> Hopefully I get this done in the next 2 days.
>> 
>> I will send a pull request when I'am finished / thanks for your
>> patience until then.
> 
> Ok!
> 
> Thanks for your work!
> 
> Regards,
> Mauro

Hi Mauro,

you could pull it from (see [1]).

  https://github.com/return42/linux.git docs-next/linux-doc-reST

I tested it local with your experimental/docs-next and it works.
If you don't want to build the whole documentation every time
(target htmldocs), use 

  $ make books/linux_tv.html
  ... 
  $ make books/linux_tv.clean

May you read the Documentation/books_migrated/README.txt. Since
Documentation/books_migrated is only for the period of transition
move the linux_tv folder to Documentation/ when you start your review.

If you want the "media" folder back, rename it:

  mv Documentation/books_migrated/linux_tv Documentation/media

But take into account, that the target and dist-name is the name of the folder

  $ make books/media.html	
  ...
  SPHINX  books/medi.html --> file:///share/linux-test/Documentation/dist/books/media

BTW, if you do so, we have to modify the ref in Documentation/index.rst

If you build the book, you will see messages like this one:

/share/linux-test/Documentation/books_migrated/linux_tv/media/dvb/FE_GET_EVENT.rst:19: WARNING: Inline emphasis start-string without end-string.

These are marginal issues, ignore them for the first, we fix these
in one step later. First, check if you find any *systematic error*
and report me .. hopefully there are none, but who knows ..

If you have any problems or questions, regardless with sphinx-doc
installation, layout issues, with the reST markup or whatever 
... don't hesitate to contact me directly.

One question: is it right, that no man-pages are created from the 
"media" content? I tried the xmlto on the DocBook-XML media but no
man-pages has been created ...

BTW: the man-page build (target books/name.man) is 10^2-10^3 times faster
than the xmlto, no loud fan anymore ... but if you don't have man-pages
you wan't notice a change ;-)

[1] http://article.gmane.org/gmane.linux.kernel/2255354

-- Markus --