Re: [PATCH v2 31/79] docs: s390: convert docs to ReST and rename to *.rst

Mauro Carvalho Chehab
2019-04-23T19:46:40Z

Em Tue, 23 Apr 2019 12:12:41 -0400
Farhan Ali <alifm@linux.ibm.com> escreveu:

> On 04/22/2019 09:27 AM, Mauro Carvalho Chehab wrote:
> > Convert all text files with s390 documentation to ReST format.
> >
> > Tried to preserve as much as possible the original document
> > format. Still, some of the files required some work in order
> > for it to be visible on both plain text and after converted
> > to html.
> >
> > The conversion is actually:
> > - add blank lines and identation in order to identify paragraphs;
> > - fix tables markups;
> > - add some lists markups;
> > - mark literal blocks;
> > - adjust title markups.
> >
> > At its new index.rst, let's add a :orphan: while this is not linked to
> > the main index.rst file, in order to avoid build warnings.
> >
> > Signed-off-by: Mauro Carvalho Chehab<mchehab+samsung@kernel.org>
> > ---
>
> Hi Mauro,
>
> How would the s390 rst files be accessed from a top level index.rst
> file? Is there a view of the changes? I looked at a link you posted [1]
> as a reply in another thread, but I couldn't find the s390 docs there.
>
> [1] https://www.infradead.org/~mchehab/rst_conversion/

With just the patch I added on this series, you'll find the s390
index.html, and one file for each .rst at Documentation/output/s390/.

In order to have it linked to the main index, you need to add
s390/index to Documentation/index.rst, but, if you just want to
see the results, you can just call:

$ firefox file://`pwd`/Documentation/output/s390/index.html

I have a patch already that adds s390 to the main index, together with
other arch conversions:

https://git.linuxtv.org/mchehab/experimental.git/commit/?h=convert_rst_renames&id=d28c466a495488e5e57c7893123011342eea40b2

However, as subsystem maintainers may take a while to apply some of those
patches, and there's a patchset converting x86 arch too, I opted to do
such additions on a separate patch, in order to reduce merge conflicts.

Thanks,
Mauro