On 08/13/2017 11:46 PM, Markus Heiser wrote: > Hi Randy, > >> Am 13.08.2017 um 19:29 schrieb Randy Dunlap <rdunlap@xxxxxxxxxxxxx>: >> >> Hi, >> >> [on linux v4.13-rc4] >> >>> sphinx-build --version >> Sphinx (sphinx-build) 1.2.3 > > see "Sphinx Install" Documentation/doc-guide/sphinx.rst (ATM in Jon's docs-next) > > The ReST markups currently used by the Documentation/ files are meant to be > built with ``Sphinx`` version 1.3 or upper. If you're desiring to build > PDF outputs, it is recommended to use version 1.4.6 or upper. > > Sorry for the mess in the past. Mauro has now cleared this up for us / thanks Mauro > >> I'm getting some docs build errors and warnings. Do I need a newer >> version of Sphinx or some options added? > > No options needed, update Sphinx should help. OK, will do, thanks. >> ~~~~~~~~~~~~~~~~~~~~~~~ >> >> Lots of ERRORs where a doc comment is of the form GPP_ (ending with a '_'): >> >> ../block/bio.c:404: ERROR: Unknown target name: "gfp". > > Yes, this is a conflict since comments are reST Markup. > > https://www.kernel.org/doc/html/latest/doc-guide/kernel-doc.html > > In sources we like to use FOO_ (ending with a '_'), which is a > hyperlink markup in reST: > > http://www.sphinx-doc.org/en/stable/rest.html#hyperlinks > > The only solution I see is to replace FOO_ with ``FOO_`` I guess that's OK in doc files, but most of these comments are in source files and requiring ``xyz_`` there is not nice. -- ~Randy -- 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
