Date: Thu, 4 Jan 2018 09:48:50 +0800
From: Boqun Feng <boqun.feng@gmail.com>
To: afzal mohammed <afzal.mohd.ma@gmail.com>
Cc: linux-kernel@vger.kernel.org, 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>
Subject: Re: [PATCH] doc: memory-barriers: reStructure Text
Message-ID: <20180104014850.GB31392@tardis>
References: <20180103093436.16704-1-afzal.mohd.ma@gmail.com>
MIME-Version: 1.0
Content-Type: multipart/signed; micalg=pgp-sha256;
        protocol="application/pgp-signature"; boundary="PmA2V3Z32TCmWXqI"
Content-Disposition: inline
In-Reply-To: <20180103093436.16704-1-afzal.mohd.ma@gmail.com>
User-Agent: Mutt/1.9.1 (2017-09-22)
Sender: linux-kernel-owner@vger.kernel.org


--PmA2V3Z32TCmWXqI
Content-Type: text/plain; charset=us-ascii
Content-Disposition: inline
Content-Transfer-Encoding: quoted-printable

On Wed, Jan 03, 2018 at 03:04:36PM +0530, afzal mohammed wrote:
> Let PDF & HTML's be created out of memory-barriers Text by
> reStructuring.
>=20
> reStructuring done were,
> 1. Section headers modification, lower header case except start
> 2. Removal of manual index(contents section), since it now gets created
>    automatically for html/pdf
> 3. Internal cross reference for easy navigation
> 4. Alignment adjustments
> 5. Strong emphasis made wherever there was emphasis earlier (through
>    other ways), strong was chosen as normal emphasis showed in italics,
>    which was felt to be not enough & strong showed it in bold
> 6. ASCII text & code snippets in literal blocks
> 7. Backquotes for inline instances in the paragraph's where they are
>    expressed not in English, but in C, pseudo-code, file path etc.
> 8. Notes section created out of the earlier notes
> 9. Manual numbering replaced by auto-numbering
> 10.Bibliography (References section) made such that it can be
>    cross-linked
>=20
> Signed-off-by: afzal mohammed <afzal.mohd.ma@gmail.com>
> ---
>=20
> Hi,
>=20
> With this change, pdf & html could be generated. There certainly are
> improvements to be made, but thought of first knowing whether migrating
> memory-barriers from txt to rst is welcome.
>=20
> 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.
>=20
> Other files refer to memory-barrier.txt, those also needs to be
> adjusted based on where .rst can reside.
>=20

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.

Regards,
Boqun

> afzal
>=20
>=20
[...]

--PmA2V3Z32TCmWXqI
Content-Type: application/pgp-signature; name="signature.asc"

-----BEGIN PGP SIGNATURE-----

iQEzBAABCAAdFiEEj5IosQTPz8XU1wRHSXnow7UH+rgFAlpNh/4ACgkQSXnow7UH
+rhvuwf/S1KU5xvZhvcp+tRbl0hMurzpmUdlbQjk7PEfa6nOsiDfkqwcexzSzqHr
RA4wyu7dA1j6bfB/3fB9kgF/1vGFaDIja5UY1W1S0Dl9c0djJWngC7Eu+2dk750B
A6+o7zuH3XlrFXYljcRkYKVme+5Nc7DJ5bpfaVx271/8Y9G2xeEYN0yImxdBu3kr
ioeAJp9hPVl7FEtkfNTpmSAIoE0dJle6sL1Ncvvim95B1w8URjNvN//KqFXkU5fn
JPACM2iZmQClo9XEAWubAF5bc82+RMYblfRdy7IT/AB1a+8wWEYHd54E8Fw24EXI
0vHbMgp1p1Lb0ho+krEBJbgn/4J6gA==
=AxXC
-----END PGP SIGNATURE-----

--PmA2V3Z32TCmWXqI--