linux-kernel - Re: [PATCH] doc: memory-barriers: reStructure Text

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: <20180105035245.GA6780@afzalpc>
Date:   Fri, 5 Jan 2018 09:22:45 +0530
From:   afzal mohammed <afzal.mohd.ma@...il.com>
To:     Markus Heiser <markus.heiser@...marit.de>
Cc:     Boqun Feng <boqun.feng@...il.com>, linux-kernel@...r.kernel.org,
        Linux Doc Mailing List <linux-doc@...r.kernel.org>,
        "Paul E. McKenney" <paulmck@...ux.vnet.ibm.com>,
        Will Deacon <will.deacon@....com>,
        Ingo Molnar <mingo@...nel.org>,
        Peter Zijlstra <peterz@...radead.org>,
        Stan Drozd <drozdziak1@...il.com>,
        Palmer Dabbelt <palmer@...belt.com>,
        Mauro Carvalho Chehab <mchehab@...nel.org>,
        Jonathan Corbet <corbet@....net>
Subject: Re: [PATCH] doc: memory-barriers: reStructure Text

Hi,

On Thu, Jan 04, 2018 at 11:27:55AM +0100, Markus Heiser wrote:

> IMO symlinks are mostly ending in a mess, URLs are never stable.
> There is a 
> 
>  https://www.kernel.org/doc/html/latest/objects.inv
> 
> to handle such requirements. Take a look at *intersphinx* :
> 
>  http://www.sphinx-doc.org/en/stable/ext/intersphinx.html
> 
> to see how it works:  Each Sphinx HTML build creates a file named objects.inv that
> contains a mapping from object names to URIs relative to the HTML set’s root.
> 
> This means articles from external (like lwn articles) has to be recompiled.
> Not perfect, but a first solution. 

Thanks for the details.

> I really like them

Initially i was sceptical of rst & once instead of hitting the fly,
hit "make htmldocs" on the keyboard :), and the opinion about it was
changed. It was easy to navigate through various docs & the realized
that various topics (& many) were present (yes, it was there earlier
also, but had to dive inside Documentation & search, while viewing the
toplevel index.html made them standout). It was like earlier you had
to go after docs, but now it was docs coming after you, that is my
opinion.

Later while fighting with memory-barriers.txt, felt that it might be
good for it as well as to be in that company.

And the readability as a text is not hurt as well.

It was thought that rst conversion could be done quickly, but since
this was my first attempt with rst, had to put some effort to get a
not so bad output, even if this patch dies, i am happy to have learnt
rst conversion to some extent.

> > Upon trying to understand memory-barriers.txt, i felt that it might be
> > better to have it in PDF/HTML format, thus attempted to convert it to
> > rst. And i see it not being welcomed, hence shelving the conversion.
> 
> I think that's a pity.

When one of the author of the original document objected, i felt it is
better to backoff. But if there is a consensus, i will proceed.

afzal