netdev - Re: [PATCH net-next 1/3] docs: networking: Fix indices heading indentation

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 for Android: free password hash cracker in your pocket

[<prev] [next>] [<thread-prev] [thread-next>] [day] [month] [year] [list]

Date:   Tue, 17 Jul 2018 13:45:44 +0200
From:   Markus Heiser <markus.heiser@...marit.de>
To:     "Tobin C. Harding" <me@...in.cc>,
        "David S. Miller" <davem@...emloft.net>
Cc:     linux-doc@...r.kernel.org, netdev@...r.kernel.org,
        linux-kernel@...r.kernel.org
Subject: Re: [PATCH net-next 1/3] docs: networking: Fix indices heading
 indentation

Am Dienstag, den 17.07.2018, 10:28 +0200 schrieb Markus Heiser:
> Am Dienstag, den 17.07.2018, 14:29 +1000 schrieb Tobin C. Harding:
> > Currently the 'Indices' heading is not aligned with column 0, it should
> > be.
> 
> Hi Tobin, thats not correct. The 'Indices' heading is a part of the 'only'
> block:
> 
>   http://www.sphinx-doc.org/en/stable/markup/misc.html#including-content-based-on-tags
> 
> -- Markus --

I realized that we have not well documented SPHINXDIRS, to be more elaborate ..

The tag 'subproject' will be set from the networking/conf.py if you run:

   make -k SPHINXDIRS="networking" htmldocs

to just build only the networking folder (aka subproject). For more info,
please run 'make help' and take a look at the 'Documentation targets' section.

In short: a subfolder of Documentation/ with a conf.py file in, is a subproject
and can be build separate.

 -- Markus --



> 
> > 
> > Fix 'Indices' heading indentation.
> > 
> > Signed-off-by: Tobin C. Harding <me@...in.cc>
> > ---
> >  Documentation/networking/index.rst | 4 ++--
> >  1 file changed, 2 insertions(+), 2 deletions(-)
> > 
> > diff --git a/Documentation/networking/index.rst b/Documentation/networking/index.rst
> > index 6123a7e9e1da..a4bbde70bcb9 100644
> > --- a/Documentation/networking/index.rst
> > +++ b/Documentation/networking/index.rst
> > @@ -20,7 +20,7 @@ Contents:
> >  
> >  .. only::  subproject
> >  
> > -   Indices
> > -   =======
> > +Indices
> > +=======
> >  
> >     * :ref:`genindex`
> 
> --
> To unsubscribe from this list: send the line "unsubscribe linux-doc" in
> the body of a message to majordomo@...r.kernel.org
> More majordomo info at  http://vger.kernel.org/majordomo-info.html