Content-Type: text/plain; charset=utf-8
Mime-Version: 1.0 (Mac OS X Mail 10.3 \(3273\))
Subject: Re: [PATCH] doc: memory-barriers: reStructure Text
From: Markus Heiser <markus.heiser@darmarit.de>
In-Reply-To: <20180104035948.GB3782@afzalpc>
Date: Thu, 4 Jan 2018 11:27:55 +0100
Cc: Boqun Feng <boqun.feng@gmail.com>, linux-kernel@vger.kernel.org,
        Linux Doc Mailing List <linux-doc@vger.kernel.org>,
        "Paul E. McKenney" <paulmck@linux.vnet.ibm.com>,
        Will Deacon <will.deacon@arm.com>,
        Ingo Molnar <mingo@kernel.org>,
        Peter Zijlstra <peterz@infradead.org>,
        Stan Drozd <drozdziak1@gmail.com>,
        Palmer Dabbelt <palmer@dabbelt.com>,
        Mauro Carvalho Chehab <mchehab@kernel.org>,
        Jonathan Corbet <corbet@lwn.net>
Content-Transfer-Encoding: 8BIT
Message-Id: <9DBB839D-975D-4E45-A4E2-A8010A55D361@darmarit.de>
References: <20180103093436.16704-1-afzal.mohd.ma@gmail.com>
 <20180104014850.GB31392@tardis> <20180104035948.GB3782@afzalpc>
To: afzal mohammed <afzal.mohd.ma@gmail.com>
Sender: linux-kernel-owner@vger.kernel.org


> Am 04.01.2018 um 04:59 schrieb afzal mohammed <afzal.mohd.ma@gmail.com>:
> 
> Hi,
> 
> On Thu, Jan 04, 2018 at 09:48:50AM +0800, Boqun Feng wrote:
> 
>>> The location chosen is "Documentation/kernel-hacking", i was unsure
>>> where this should reside & there was no .rst file in top-level directory
>>> "Documentation", so put it into one of the existing folder that seemed
>>> to me as not that unsuitable.
>>> 
>>> Other files refer to memory-barrier.txt, those also needs to be
>>> adjusted based on where .rst can reside.
> 
>> How do you plan to handle the external references? For example, the
>> following LWN articles has a link this file:
>> 
>> 	https://lwn.net/Articles/718628/
>> 
>> And changing the name and/or location will break that link, AFAIK.
> 
> If necessary to handle these, symlink might help here i believe.

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. 

> Am 04.01.2018 um 00:48 schrieb Peter Zijlstra <peterz@infradead.org>:
> 
> So I hate this rst crap with a passion, so NAK from me.

I really like them, factually valuable comments .. please
express your concern so that we have a chance to move on.

> 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.

-- Markus --