Re: [PATCH] doc: flat-table directive

From: Markus Heiser
Date: Fri Jul 01 2016 - 08:04:34 EST



Am 01.07.2016 um 13:56 schrieb Jani Nikula <jani.nikula@xxxxxxxxx>:

> On Fri, 01 Jul 2016, Markus Heiser <markus.heiser@xxxxxxxxxxx> wrote:
>> Am 01.07.2016 um 12:44 schrieb Jani Nikula <jani.nikula@xxxxxxxxx>:
>>
>>> On Fri, 01 Jul 2016, Mauro Carvalho Chehab <mchehab@xxxxxxxxxxxxxxx> 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.

Thanks for your feedback

-- Markus --



> BR,
> Jani.
>
>
> --
> Jani Nikula, Intel Open Source Technology Center