linux-kernel - Re: [PATCH] tools: memory-model: add it to the Documentation body

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: <Pine.LNX.4.44L0.1907310947340.1497-100000@iolanthe.rowland.org>
Date:   Wed, 31 Jul 2019 09:52:05 -0400 (EDT)
From:   Alan Stern <stern@...land.harvard.edu>
To:     Mauro Carvalho Chehab <mchehab+samsung@...nel.org>
cc:     Joel Fernandes <joel@...lfernandes.org>,
        Linux Doc Mailing List <linux-doc@...r.kernel.org>,
        Mauro Carvalho Chehab <mchehab@...radead.org>,
        <linux-kernel@...r.kernel.org>, Jonathan Corbet <corbet@....net>,
        Andrea Parri <andrea.parri@...rulasolutions.com>,
        Will Deacon <will@...nel.org>,
        Peter Zijlstra <peterz@...radead.org>,
        Boqun Feng <boqun.feng@...il.com>,
        Nicholas Piggin <npiggin@...il.com>,
        David Howells <dhowells@...hat.com>,
        Jade Alglave <j.alglave@....ac.uk>,
        Luc Maranget <luc.maranget@...ia.fr>,
        "Paul E. McKenney" <paulmck@...ux.ibm.com>,
        Akira Yokosawa <akiyks@...il.com>,
        Daniel Lustig <dlustig@...dia.com>,
        Ingo Molnar <mingo@...nel.org>, Jason Gunthorpe <jgg@...pe.ca>,
        SeongJae Park <sj38.park@...il.com>,
        <linux-arch@...r.kernel.org>
Subject: Re: [PATCH] tools: memory-model: add it to the Documentation body

On Tue, 30 Jul 2019, Mauro Carvalho Chehab wrote:

> Em Tue, 30 Jul 2019 18:17:01 -0400
> Joel Fernandes <joel@...lfernandes.org> escreveu:

> > > > (4) I would argue that every occurence of
> > > > A ->(some dependency) B should be replaced with fixed size font in the HTML
> > > > results.  
> > > 
> > > Just place those with ``A -> (some dependency)``. This will make them use
> > > a fixed size font.  
> > 
> > Ok, understood all these. I guess my point was all of these will need to be
> > done to make this document useful from a ReST conversion standpoint. Until
> > then it is probably just better off being plain text - since there are so
> > many of those ``A -> (dep) B`` things.

> On a very quick look, it seems that, if we replace:
> 
> 	(\S+\s->\S*\s\w+)
> 
> by:
> 	``\1``
> 
> 
> On an editor that would allow to manually replace the regex (like kate),
> most of those can be get.
> 
> See patch enclosed.

Some time ago I considered the problem of converting this file to ReST 
format.  But I gave up on the idea, because the necessary changes were 
so widespread and the resulting text file would not be easily readable.

Replacing things of the form "A ->dep B" just scratches the surface.  
That document teems with variable names, formulas, code extracts, and
other things which would all need to be rendered in a different font
style.  The density of the markup required to do this would be
phenomenally high.

In my opinion it simply was not worthwhile.

Alan Stern