linux-kernel - Re: [PATCH RFC 0/4] Fix PDF build errors

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: <87funaj9k9.fsf@intel.com>
Date:   Wed, 02 Nov 2016 15:27:50 +0200
From:   Jani Nikula <jani.nikula@...ux.intel.com>
To:     Mauro Carvalho Chehab <mchehab@...radead.org>
Cc:     Mauro Carvalho Chehab <mchehab@....samsung.com>,
        Linux Doc Mailing List <linux-doc@...r.kernel.org>,
        Jim Davis <jim.epost@...il.com>,
        Jonathan Corbet <corbet@....net>,
        linux-kernel <linux-kernel@...r.kernel.org>,
        <fengguang.wu@...el.com>, kbuild-all@...org
Subject: Re: [PATCH RFC 0/4] Fix PDF build errors

On Wed, 02 Nov 2016, Mauro Carvalho Chehab <mchehab@...radead.org> wrote:
> Em Wed, 02 Nov 2016 13:14:47 +0200
> Jani Nikula <jani.nikula@...ux.intel.com> escreveu:
>
>> On Wed, 02 Nov 2016, Mauro Carvalho Chehab <mchehab@....samsung.com> wrote:
>> > This series address a series of errors during PDF generation from
>> > media documentation.
>> >
>> > Please notice that patch 2 carries on a PDF conversion from a PNG
>> > image, because Sphinx is not smart enough to do the convertion.
>> >
>> > This is a temporary solution (That's why I'm marking this series
>> > as RFC).  
>> 
>> This seems to work on top of docs-next.
>
> Yes.
>
>> ...but it'll break again if we include the missing admin-guide in the
>> build. :(
>
> LaTeX/PDF output is ugly... for each new stuff, we need to re-validate its
> output :-(

Once we have this working, I think the only way to keep it working is to
have continuous testing of the pdf build. That won't keep the output
pretty, but it'll help ensure passing build.

Perhaps 0day could eventually start running 'make DOCBOOKS="" pdfdocs'
after the htmldocs target? Cc: Fengguang and kbuild-all.

BR,
Jani.



>
>
>
>> 
>> BR,
>> Jani.
>> 
>> 
>> From c296287c65f4b6ad6272171456dcf8508c92ae2f Mon Sep 17 00:00:00 2001
>> From: Jani Nikula <jani.nikula@...el.com>
>> Date: Wed, 2 Nov 2016 13:05:59 +0200
>> Subject: [PATCH] Documentation/sphinx: include admin-guide in the latex/pdf
>>  build
>> Organization: Intel Finland Oy - BIC 0357606-4 - Westendinkatu 7, 02160 Espoo
>> Cc: Jani Nikula <jani.nikula@...el.com>
>> 
>> Fix the warning:
>> 
>> WARNING: "latex_documents" config value references unknown document
>> user/index
>> 
>> Signed-off-by: Jani Nikula <jani.nikula@...el.com>
>> 
>> ---
>> 
>> Sadly, this breaks the pdf build with:
>> 
>> ! TeX capacity exceeded, sorry [main memory size=5000000].
>> \FV@...ce ...ionary {\copy \sphinxvisiblespacebox
>>  }{\sphinxafterbreak } {\ke...
>>  l.3711 ...\PYG{n}{be} \PYG{n}{used} \PYG{n+nb}{to}
>> 
>> Output written on linux-user.pdf (15 pages).
>> Transcript written on linux-user.log.
>> Makefile:66: recipe for target 'linux-user.pdf' failed
>> make[2]: *** [linux-user.pdf] Error 1
>> Documentation/Makefile.sphinx:83: recipe for target 'pdfdocs' failed
>> make[1]: *** [pdfdocs] Error 2
>> Makefile:1442: recipe for target 'pdfdocs' failed
>> make: *** [pdfdocs] Error 2
>> ---
>>  Documentation/conf.py | 2 +-
>>  1 file changed, 1 insertion(+), 1 deletion(-)
>> 
>> diff --git a/Documentation/conf.py b/Documentation/conf.py
>> index 814c336e5f5e..0c758a4f61f1 100644
>> --- a/Documentation/conf.py
>> +++ b/Documentation/conf.py
>> @@ -340,7 +340,7 @@ if minor > 3:
>>  # (source start file, target name, title,
>>  #  author, documentclass [howto, manual, or own class]).
>>  latex_documents = [
>> -    ('user/index', 'linux-user.tex', 'Linux Kernel User Documentation',
>> +    ('admin-guide/index', 'linux-user.tex', 'Linux Kernel User Documentation',
>
> Oh! It seems I forgot to rename the guide name here :(
>
> Your patch looks OK!
>
> Reviewed-by: Mauro Carvalho Chehab <mchehab@...pensource.com>
>
>>       'The kernel development community', 'manual'),
>>      ('kernel-documentation', 'kernel-documentation.tex', 'The Linux Kernel Documentation',
>>       'The kernel development community', 'manual'),
>
>
>
>
> Cheers,
> Mauro

-- 
Jani Nikula, Intel Open Source Technology Center