linux-kernel - Re: [PATCH] doc: flat-table directive

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] [thread-next>] [day] [month] [year] [list]

Message-ID: <87furtpmre.fsf@intel.com>
Date:	Fri, 01 Jul 2016 15:26:45 +0300
From:	Jani Nikula <jani.nikula@...el.com>
To:	Markus Heiser <markus.heiser@...marit.de>
Cc:	Mauro Carvalho Chehab <mchehab@....samsung.com>,
	Jonathan Corbet <corbet@....net>, linux-doc@...r.kernel.org,
	linux-kernel@...r.kernel.org, hverkuil@...all.nl,
	daniel.vetter@...ll.ch, airlied@...il.com,
	grant.likely@...retlab.ca, rdunlap@...radead.org, keithp@...thp.com
Subject: Re: [PATCH] doc: flat-table directive

On Fri, 01 Jul 2016, Markus Heiser <markus.heiser@...marit.de> wrote:
> Am 01.07.2016 um 13:56 schrieb Jani Nikula <jani.nikula@...el.com>:
>
>> On Fri, 01 Jul 2016, Markus Heiser <markus.heiser@...marit.de> wrote:
>>> Am 01.07.2016 um 12:44 schrieb Jani Nikula <jani.nikula@...el.com>:
>>> 
>>>> On Fri, 01 Jul 2016, Mauro Carvalho Chehab <mchehab@....samsung.com> wrote:
>>>>> Not being able to compile just one docbook is a regression and breaks
>>>>> my process. This needs to be fixed.
>>>> 
>>>> Do you have a regression with *DocBook XML* on docs-next now? If yes,
>>>> clearly that must be fixed ASAP.
>>> 
>>> Now I see the problem ...
>>> 
>>> It seems that we didn't neglected that the DocBook Makefile 
>>> builds single books, e.g.
>>> 
>>>  make DOCBOOKS=device-drivers.xml htmldocs
>>> 
>>> Since the Makefile.sphinx does not care the environment DOCBOOKS,
>>> the XML is build and the reST also, where only the XML content
>>> should be build.
>>> 
>>> Jani, may could you apply a small fix on the Makefile.sphinx which
>>> takes into account, not to run the sphinx-build if the DOCBOOK 
>>> environment is set .. is it a solution for a start?
>> 
>> That is not the problem. Makefile.sphinx happily ignores DOCBOOKS. For
>> example 'make DOCBOOKS=kernel-api.xml htmldocs' on docs-next works just
>> fine for me. Sphinx build ignores DOCBOOKS, the DocBook build works just
>> like it always did.
>
> Are you sure .. may I do something wrong::
>
> $ make DOCBOOKS=kernel-api.xml htmldocs
>   SPHINX  htmldocs
> Running Sphinx v1.4.4
> loading pickled environment... done
> building [mo]: targets for 0 po files that are out of date
> building [html]: targets for 0 source files that are out of date
> updating environment: 0 added, 0 changed, 0 removed
> looking for now-outdated files... none found
> no targets are out of date.
> build succeeded.
>   DOCPROC Documentation/DocBook/kernel-api.xml
> .//lib/crc32.c:148: warning: No description found for parameter 'tab)[256]'
> .//lib/crc32.c:148: warning: Excess function parameter 'tab' description in 'crc32_le_generic'
> .//lib/crc32.c:293: warning: No description found for parameter 'tab)[256]'
> .//lib/crc32.c:293: warning: Excess function parameter 'tab' description in 'crc32_be_generic'
> .//lib/crc32.c:1: warning: no structured comments found
> .//mm/memory.c:2881: warning: No description found for parameter 'old'
>   XMLREF  Documentation/DocBook/kernel-api.aux.xml
>   HTML    Documentation/DocBook/kernel-api.html
>   ....
>
> In this example, the sphinx build is started as a side effect
> even if it is not rebuild in this example, because nothing
> in reST content has changed: "looking for now-outdated files... none found".
>
> As far as I can see, this is done **because** Makefile.sphinx
> ignores DOCBOOK.

I was referring to the original problem Mauro reported where the build
failed. The above is a different issue, but an issue nonetheless. Patch
sent.

BR,
Jani.

-- 
Jani Nikula, Intel Open Source Technology Center