linux-kernel - Re: [PATCH v3 07/21] Documentation/CodingStyle: Convert to ReST markup

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]

Date:   Fri, 16 Sep 2016 17:34:26 -0300
From:   Mauro Carvalho Chehab <mchehab@...pensource.com>
To:     Jonathan Corbet <corbet@....net>
Cc:     Linux Doc Mailing List <linux-doc@...r.kernel.org>,
        Mauro Carvalho Chehab <mchehab@...radead.org>,
        Markus Heiser <markus.heiser@...marit.de>,
        Jani Nikula <jani.nikula@...ux.intel.com>,
        LKML <linux-kernel@...r.kernel.org>
Subject: Re: [PATCH v3 07/21] Documentation/CodingStyle: Convert to ReST
 markup

Em Fri, 16 Sep 2016 11:13:14 -0600
Jonathan Corbet <corbet@....net> escreveu:

> On Wed, 14 Sep 2016 08:06:36 -0300
> Mauro Carvalho Chehab <mchehab@...pensource.com> wrote:
> 
> > - Fix all chapter identation;
> > - add c blocks where needed;  
> 
> Here is where I think we need a bit of a philosophical discussion...
> 
> > -		Chapter 1: Indentation
> > +Indentation
> > +-----------  
> 
> You're a fan of having sphinx do the numbering, and I have no problem
> understanding why.  But this will defeat people who say "look in chapter 3
> of Documentation/CodingStyle".  We're removing a bit of information from
> the plain-text file and reserving it for the formatted version.  If we're
> really going to do that, we should do it consciously, with the knowledge
> that there is a cost involved.
> 
> We'll see this even more with SubmittingPatches, where it is quite common
> for people to cite the number of the section they think is being violated
> in any given situation.

I see your point. However, AFAICT, there's no way to disable automatic
numbering for LaTeX and PDF formats: it will always generate an index.

It is actually worse than that: the numbering for the LaTeX and PDF
versions of the document don't match with the numbering for html and ePub,
and Sphinx restricts to just one numbered TOC index for the entire document.

Currently, I don't know any way to fix it.

So, keeping the current numeration there will produce a very messy
PDF output, with the two numerations altogether.

Thanks,
Mauro