From: Cornelia Huck <cohuck@redhat.com>
To: Mauro Carvalho Chehab <mchehab+samsung@kernel.org>
Cc: Linux Doc Mailing List <linux-doc@vger.kernel.org>,
Mauro Carvalho Chehab <mchehab@infradead.org>,
linux-kernel@vger.kernel.org, Jonathan Corbet <corbet@lwn.net>,
Martin Schwidefsky <schwidefsky@de.ibm.com>,
Heiko Carstens <heiko.carstens@de.ibm.com>,
Tony Krowiak <akrowiak@linux.ibm.com>,
Pierre Morel <pmorel@linux.ibm.com>,
Halil Pasic <pasic@linux.ibm.com>,
Farhan Ali <alifm@linux.ibm.com>,
Eric Farman <farman@linux.ibm.com>,
linux-s390@vger.kernel.org, kvm@vger.kernel.org
Subject: Re: [PATCH v2 31/79] docs: s390: convert docs to ReST and rename to *.rst
Date: Wed, 24 Apr 2019 14:52:51 +0200 [thread overview]
Message-ID: <20190424145251.18e0b3af.cohuck@redhat.com> (raw)
In-Reply-To: <20190424094450.1e3da646@coco.lan>
On Wed, 24 Apr 2019 09:44:50 -0300
Mauro Carvalho Chehab <mchehab+samsung@kernel.org> wrote:
> Em Wed, 24 Apr 2019 13:41:09 +0200
> Cornelia Huck <cohuck@redhat.com> escreveu:
>
> > On Mon, 22 Apr 2019 10:27:20 -0300
> > Mauro Carvalho Chehab <mchehab+samsung@kernel.org> 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>
> > > ---
> > > .../admin-guide/kernel-parameters.txt | 4 +-
> > > Documentation/driver-api/s390-drivers.rst | 4 +-
> > > Documentation/s390/{3270.txt => 3270.rst} | 85 +-
> > > Documentation/s390/{cds.txt => cds.rst} | 354 ++-
> > > .../s390/{CommonIO => common_io.rst} | 49 +-
> > > Documentation/s390/{DASD => dasd.rst} | 33 +-
> > > .../{Debugging390.txt => debugging390.rst} | 2389 ++++++++++-------
> > > .../{driver-model.txt => driver-model.rst} | 179 +-
> > > Documentation/s390/index.rst | 30 +
> > > .../s390/{monreader.txt => monreader.rst} | 85 +-
> > > Documentation/s390/{qeth.txt => qeth.rst} | 36 +-
> > > Documentation/s390/s390dbf.rst | 803 ++++++
> > > Documentation/s390/s390dbf.txt | 667 -----
> > > Documentation/s390/text_files.rst | 11 +
> > > .../s390/{vfio-ap.txt => vfio-ap.rst} | 487 ++--
> > > .../s390/{vfio-ccw.txt => vfio-ccw.rst} | 90 +-
> > > .../s390/{zfcpdump.txt => zfcpdump.rst} | 2 +
> > > MAINTAINERS | 4 +-
> > > arch/s390/Kconfig | 4 +-
> > > arch/s390/include/asm/debug.h | 4 +-
> > > drivers/s390/char/zcore.c | 2 +-
> > > 21 files changed, 3089 insertions(+), 2233 deletions(-)
> > > rename Documentation/s390/{3270.txt => 3270.rst} (90%)
> > > rename Documentation/s390/{cds.txt => cds.rst} (64%)
> > > rename Documentation/s390/{CommonIO => common_io.rst} (87%)
> > > rename Documentation/s390/{DASD => dasd.rst} (92%)
> > > rename Documentation/s390/{Debugging390.txt => debugging390.rst} (53%)
> > > rename Documentation/s390/{driver-model.txt => driver-model.rst} (73%)
> > > create mode 100644 Documentation/s390/index.rst
> > > rename Documentation/s390/{monreader.txt => monreader.rst} (81%)
> > > rename Documentation/s390/{qeth.txt => qeth.rst} (62%)
> > > create mode 100644 Documentation/s390/s390dbf.rst
> > > delete mode 100644 Documentation/s390/s390dbf.txt
> > > create mode 100644 Documentation/s390/text_files.rst
> > > rename Documentation/s390/{vfio-ap.txt => vfio-ap.rst} (72%)
> > > rename Documentation/s390/{vfio-ccw.txt => vfio-ccw.rst} (89%)
> > > rename Documentation/s390/{zfcpdump.txt => zfcpdump.rst} (97%)
> > >
> >
> > (...)
> >
> > > diff --git a/Documentation/s390/3270.txt b/Documentation/s390/3270.rst
> > > similarity index 90%
> > > rename from Documentation/s390/3270.txt
> > > rename to Documentation/s390/3270.rst
> > > index 7c715de99774..e09e77954238 100644
> > > --- a/Documentation/s390/3270.txt
> > > +++ b/Documentation/s390/3270.rst
> >
> > (...)
> >
> > > @@ -17,12 +21,12 @@ twenty and thirty years ago.
> > > You may have 3270s in-house and not know it. If you're using the
> > > VM-ESA operating system, define a 3270 to your virtual machine by using
> > > the command "DEF GRAF <hex-address>" This paper presumes you will be
> > > -defining four 3270s with the CP/CMS commands
> > > +defining four 3270s with the CP/CMS commands:
> > >
> > > - DEF GRAF 620
> > > - DEF GRAF 621
> > > - DEF GRAF 622
> > > - DEF GRAF 623
> > > + - DEF GRAF 620
> > > + - DEF GRAF 621
> > > + - DEF GRAF 622
> > > + - DEF GRAF 623
> >
> > IIUC, this makes this into a bulleted list... but the user is supposed
> > to enter these commands (similar to the shell commands further down in
> > this file).
>
> Ah, OK! I'll change it to use a literal block (::).
Sounds good.
> > > diff --git a/Documentation/s390/CommonIO b/Documentation/s390/common_io.rst
> > > similarity index 87%
> > > rename from Documentation/s390/CommonIO
> > > rename to Documentation/s390/common_io.rst
> > > index 6e0f63f343b4..846485681ce7 100644
> > > --- a/Documentation/s390/CommonIO
> > > +++ b/Documentation/s390/common_io.rst
> > > @@ -1,5 +1,9 @@
> > > -S/390 common I/O-Layer - command line parameters, procfs and debugfs entries
> > > -============================================================================
> > > +======================
> > > +S/390 common I/O-Layer
> > > +======================
> > > +
> > > +command line parameters, procfs and debugfs entries
> > > +===================================================
> >
> > I don't see why this should be split into two lines? If anything needs
> > to be changed, I'd drop the hyphen.
>
> No real need for html output. I suspect that a big title like the
> above would cause troubles for pdf output. That's basically why I opted
> to break it.
>
> Yet, if you prefer, I'll keep it as-is.
I basically find the short title confusing (the file is not about the
common I/O layer as a whole, but only about parameters etc.)
Maybe "S/390 common I/O layer user interface"?
But I don't care about this deeply :)
> > > diff --git a/Documentation/s390/vfio-ccw.txt b/Documentation/s390/vfio-ccw.rst
> > > similarity index 89%
> > > rename from Documentation/s390/vfio-ccw.txt
> > > rename to Documentation/s390/vfio-ccw.rst
> > > index 2be11ad864ff..1f6d0b56d53e 100644
> > > --- a/Documentation/s390/vfio-ccw.txt
> > > +++ b/Documentation/s390/vfio-ccw.rst
> >
> > (...)
> >
> > > @@ -295,6 +321,6 @@ Reference
> > > 1. ESA/s390 Principles of Operation manual (IBM Form. No. SA22-7832)
> > > 2. ESA/390 Common I/O Device Commands manual (IBM Form. No. SA22-7204)
> > > 3. https://en.wikipedia.org/wiki/Channel_I/O
> > > -4. Documentation/s390/cds.txt
> > > +4. Documentation/s390/cds.rst
>
> > > 5. Documentation/vfio.txt
> > > 6. Documentation/vfio-mediated-device.txt
> >
> > Are these two renamed in a later patch?
>
> Yes. Patch 56 renames almost all Documentation/*.txt to .rst. Those files
> are already parsed properly by Sphinx, so no changes there are needed.
>
> I'm working on followup patches (not submitted yet), with moves all
> ReST files under Documentation to some place.
>
> In the specific case of those files, on the series I'm working,
> I moved them to be part of the driver-api:
>
> https://git.linuxtv.org/mchehab/experimental.git/commit/?h=convert_rst_renames&id=3387ab063cf43f91d5c0f79d741244e7dbcdec05
>
> The results, when parsed, are at:
>
> https://www.infradead.org/~mchehab/rst_conversion/driver-api/vfio.html
> https://www.infradead.org/~mchehab/rst_conversion/driver-api/vfio-mediated-device.html
Sounds good!
next prev parent reply other threads:[~2019-04-24 12:52 UTC|newest]
Thread overview: 124+ messages / expand[flat|nested] mbox.gz Atom feed top
[not found] <20190423132100.GB7132@redhat.com>
2019-04-22 13:26 ` [PATCH v2 00/79] Convert files to ReST Mauro Carvalho Chehab
2019-04-22 13:26 ` [PATCH v2 01/79] docs: core-api: fix broken references for div64.c and gcd.c Mauro Carvalho Chehab
2019-04-22 13:26 ` [PATCH v2 02/79] docs: trace: fix some Sphinx warnings Mauro Carvalho Chehab
2019-04-24 15:10 ` Steven Rostedt
2019-04-22 13:26 ` [PATCH v2 03/79] scripts/documentation-file-ref-check: don't parse Next/ dir Mauro Carvalho Chehab
2019-04-22 13:26 ` [PATCH v2 04/79] docs: aoe: convert docs to ReST and rename to *.rst Mauro Carvalho Chehab
2019-04-22 13:26 ` [PATCH v2 05/79] docs: arm64: convert docs to ReST and rename to .rst Mauro Carvalho Chehab
2019-04-22 13:26 ` [PATCH v2 06/79] docs: cdrom-standard.tex: convert from LaTeX to ReST Mauro Carvalho Chehab
2019-04-22 13:26 ` [PATCH v2 07/79] docs: cdrom: convert docs to ReST and rename to *.rst Mauro Carvalho Chehab
2019-04-22 13:26 ` [PATCH v2 08/79] docs: cgroup-v1: " Mauro Carvalho Chehab
2019-05-06 15:47 ` Tejun Heo
2019-04-22 13:26 ` [PATCH v2 09/79] docs: cgroup-v1/blkio-controller.rst: add a note about CFQ scheduler Mauro Carvalho Chehab
2019-04-22 13:26 ` [PATCH v2 10/79] docs: cpu-freq: convert docs to ReST and rename to *.rst Mauro Carvalho Chehab
2019-04-23 8:21 ` Rafael J. Wysocki
2019-04-22 13:27 ` [PATCH v2 11/79] docs: " Mauro Carvalho Chehab
2019-04-22 13:27 ` [PATCH v2 12/79] docs: fault-injection: " Mauro Carvalho Chehab
2019-04-22 13:27 ` [PATCH v2 13/79] docs: fb: " Mauro Carvalho Chehab
2019-05-06 13:40 ` Bartlomiej Zolnierkiewicz
2019-04-22 13:27 ` [PATCH v2 14/79] docs: fpga: " Mauro Carvalho Chehab
2019-04-22 13:27 ` [PATCH v2 15/79] docs: gpio: " Mauro Carvalho Chehab
2019-04-23 11:23 ` Linus Walleij
2019-04-23 12:36 ` Mauro Carvalho Chehab
2019-04-23 21:30 ` Linus Walleij
2019-04-22 13:27 ` [PATCH v2 16/79] docs: ide: " Mauro Carvalho Chehab
2019-04-22 13:27 ` [PATCH v2 17/79] docs: infiniband: " Mauro Carvalho Chehab
2019-04-22 13:27 ` [PATCH v2 19/79] docs: kdump: " Mauro Carvalho Chehab
2019-04-22 13:27 ` [PATCH v2 20/79] docs: livepatch: " Mauro Carvalho Chehab
2019-04-26 8:10 ` Petr Mladek
2019-04-26 9:04 ` Mauro Carvalho Chehab
2019-04-22 13:27 ` [PATCH v2 21/79] docs: locking: " Mauro Carvalho Chehab
2019-04-22 13:27 ` [PATCH v2 22/79] docs: mic: " Mauro Carvalho Chehab
2019-04-22 13:27 ` [PATCH v2 23/79] docs: netlabel: " Mauro Carvalho Chehab
2019-04-22 18:10 ` Paul Moore
2019-04-22 13:27 ` [PATCH v2 24/79] docs: pcmcia: " Mauro Carvalho Chehab
2019-04-22 13:27 ` [PATCH v2 25/79] docs: " Mauro Carvalho Chehab
2019-04-22 13:48 ` Bjorn Helgaas
2019-04-22 14:07 ` Mauro Carvalho Chehab
2019-04-25 18:07 ` Mark Brown
2019-04-26 9:46 ` Mauro Carvalho Chehab
2019-04-27 17:25 ` Mark Brown
2019-04-27 18:13 ` Mauro Carvalho Chehab
2019-04-22 13:27 ` [PATCH v2 26/79] docs: powerpc: " Mauro Carvalho Chehab
2019-04-24 1:15 ` Andrew Donnellan
2019-04-22 13:27 ` [PATCH v2 27/79] docs: pps.txt: convert to ReST and rename to pps.rst Mauro Carvalho Chehab
2019-04-22 16:19 ` Rodolfo Giometti
2019-04-22 13:27 ` [PATCH v2 28/79] docs: ptp.txt: convert to ReST and move to driver-api Mauro Carvalho Chehab
2019-04-22 15:40 ` Richard Cochran
2019-04-22 13:27 ` [PATCH v2 29/79] docs: riscv: convert docs to ReST and rename to *.rst Mauro Carvalho Chehab
2019-04-22 13:27 ` [PATCH v2 30/79] docs: Debugging390.txt: convert table to ascii artwork Mauro Carvalho Chehab
2019-04-22 13:27 ` [PATCH v2 31/79] docs: s390: convert docs to ReST and rename to *.rst Mauro Carvalho Chehab
2019-04-23 16:12 ` Farhan Ali
2019-04-23 19:46 ` Mauro Carvalho Chehab
2019-04-24 11:41 ` Cornelia Huck
2019-04-24 12:30 ` Heiko Carstens
2019-04-24 12:44 ` Mauro Carvalho Chehab
2019-04-24 12:52 ` Cornelia Huck [this message]
2019-04-22 13:27 ` [PATCH v2 32/79] s390: include/asm/debug.h add kerneldoc markups Mauro Carvalho Chehab
2019-04-22 13:27 ` [PATCH v2 33/79] docs: serial: convert docs to ReST and rename to *.rst Mauro Carvalho Chehab
2019-04-22 13:27 ` [PATCH v2 34/79] docs: target: " Mauro Carvalho Chehab
2019-04-22 13:27 ` [PATCH v2 35/79] docs: timers: " Mauro Carvalho Chehab
2019-04-22 13:27 ` [PATCH v2 36/79] docs: watchdog: " Mauro Carvalho Chehab
2019-04-22 13:27 ` [PATCH v2 37/79] docs: xilinx: convert eemi.txt to eemi.rst Mauro Carvalho Chehab
2019-04-22 13:27 ` [PATCH v2 38/79] docs: scheduler: convert docs to ReST and rename to *.rst Mauro Carvalho Chehab
2019-04-23 8:29 ` Peter Zijlstra
2019-04-23 10:32 ` Ingo Molnar
2019-04-23 11:19 ` Peter Zijlstra
2019-04-23 12:30 ` Ingo Molnar
2019-04-22 13:27 ` [PATCH v2 39/79] docs: EDID/HOWTO.txt: convert it and rename to howto.rst Mauro Carvalho Chehab
2019-04-22 13:27 ` [PATCH v2 40/79] convert docs to ReST and rename to *.rst Mauro Carvalho Chehab
2019-04-22 13:27 ` [PATCH v2 41/79] docs: lcd-panel-cgram.txt: " Mauro Carvalho Chehab
2019-04-22 13:27 ` [PATCH v2 42/79] docs: lp855x-driver.txt: convert to ReST and move to kernel-api Mauro Carvalho Chehab
2019-04-22 13:27 ` [PATCH v2 43/79] docs: m68k: convert docs to ReST and rename to *.rst Mauro Carvalho Chehab
2019-05-03 11:55 ` Geert Uytterhoeven
2019-04-22 13:27 ` [PATCH v2 44/79] docs: cma/debugfs.txt: " Mauro Carvalho Chehab
2019-04-22 13:27 ` [PATCH v2 45/79] docs: console.txt: " Mauro Carvalho Chehab
2019-05-06 13:41 ` Bartlomiej Zolnierkiewicz
2019-04-22 13:27 ` [PATCH v2 46/79] docs: pti_intel_mid.txt: convert it to pti_intel_mid.rst Mauro Carvalho Chehab
2019-04-22 13:27 ` [PATCH v2 47/79] docs: early-userspace: convert docs to ReST and rename to *.rst Mauro Carvalho Chehab
2019-04-22 13:27 ` [PATCH v2 48/79] docs: driver-model: " Mauro Carvalho Chehab
2019-04-22 14:47 ` Julia Lawall
2019-04-22 22:30 ` Guenter Roeck
2019-04-22 13:27 ` [PATCH v2 50/79] docs: memory-devices: convert ti-emif.txt to ReST Mauro Carvalho Chehab
2019-04-22 13:27 ` [PATCH v2 51/79] docs: xen-tpmfront.txt: convert it to .rst Mauro Carvalho Chehab
2019-04-22 13:27 ` [PATCH v2 52/79] docs: bus-devices: ti-gpmc.rst: convert it to ReST Mauro Carvalho Chehab
2019-04-22 13:27 ` [PATCH v2 53/79] docs: nvmem: convert docs to ReST and rename to *.rst Mauro Carvalho Chehab
2019-04-22 13:27 ` [PATCH v2 54/79] docs: phy: convert samsung-usb2.txt to ReST format Mauro Carvalho Chehab
2019-04-22 13:27 ` [PATCH v2 55/79] docs: rbtree.txt: fix Sphinx build warnings Mauro Carvalho Chehab
2019-04-22 13:27 ` [PATCH v2 57/79] docs: accounting: convert to ReST Mauro Carvalho Chehab
2019-05-06 15:46 ` Tejun Heo
2019-04-22 13:27 ` [PATCH v2 58/79] docs: fmc: " Mauro Carvalho Chehab
2019-04-22 13:27 ` [PATCH v2 59/79] docs: hid: " Mauro Carvalho Chehab
2019-04-22 13:27 ` [PATCH v2 60/79] docs: ia64: " Mauro Carvalho Chehab
2019-04-22 13:27 ` [PATCH v2 61/79] docs: leds: " Mauro Carvalho Chehab
2019-04-23 19:00 ` Jacek Anaszewski
2019-04-22 13:27 ` [PATCH v2 62/79] docs: laptops: " Mauro Carvalho Chehab
2019-05-06 8:59 ` Andy Shevchenko
2019-04-22 13:27 ` [PATCH v2 63/79] docs: iio: " Mauro Carvalho Chehab
2019-04-22 14:25 ` Jonathan Cameron
2019-04-22 13:27 ` [PATCH v2 64/79] docs: ioctl-number.txt: convert it to ReST format Mauro Carvalho Chehab
2019-04-22 14:05 ` Doug Ledford
2019-04-22 14:17 ` Mauro Carvalho Chehab
2019-04-22 13:27 ` [PATCH v2 65/79] docs: ioctl: convert to ReST Mauro Carvalho Chehab
2019-04-22 13:27 ` [PATCH v2 66/79] docs: namespaces: " Mauro Carvalho Chehab
2019-04-22 13:27 ` [PATCH v2 67/79] docs: nfc: " Mauro Carvalho Chehab
2019-04-22 13:27 ` [PATCH v2 68/79] docs: md: " Mauro Carvalho Chehab
2019-04-22 13:27 ` [PATCH v2 69/79] docs: mtd: " Mauro Carvalho Chehab
2019-04-22 13:27 ` [PATCH v2 70/79] docs: nvdimm: " Mauro Carvalho Chehab
2019-04-22 13:28 ` [PATCH v2 71/79] docs: xtensa: " Mauro Carvalho Chehab
2019-04-22 13:28 ` [PATCH v2 72/79] docs: mmc: " Mauro Carvalho Chehab
2019-04-22 13:28 ` [PATCH v2 73/79] docs: sparc: " Mauro Carvalho Chehab
2019-04-22 13:28 ` [PATCH v2 74/79] docs: thermal: " Mauro Carvalho Chehab
2019-04-22 13:28 ` [PATCH v2 75/79] docs: rapidio: " Mauro Carvalho Chehab
2019-04-22 13:28 ` [PATCH v2 76/79] docs: blockdev: " Mauro Carvalho Chehab
2019-04-22 13:28 ` [PATCH v2 77/79] docs: perf: " Mauro Carvalho Chehab
2019-04-22 13:28 ` [PATCH v2 78/79] docs: sysctl: " Mauro Carvalho Chehab
2019-04-22 13:28 ` [PATCH v2 79/79] docs: block: " Mauro Carvalho Chehab
2019-04-22 14:51 ` [PATCH v2 00/79] Convert files " Mauro Carvalho Chehab
[not found] ` <cda57849a6462ccc72dcd360b30068ab6a1021c4.1555938376.git.mchehab+samsung@kernel.org>
[not found] ` <20190423083135.GA11158@hirez.programming.kicks-ass.net>
[not found] ` <20190423125519.GA7104@redhat.com>
[not found] ` <20190423130132.GT4038@hirez.programming.kicks-ass.net>
2019-04-23 14:52 ` [PATCH v2 56/79] docs: Documentation/*.txt: rename all ReST files to *.rst David Howells
2019-04-23 16:54 ` Jonathan Corbet
2019-04-23 17:12 ` Peter Zijlstra
2019-04-23 20:26 ` Mauro Carvalho Chehab
2019-04-24 11:51 ` Mike Rapoport
2019-04-24 12:57 ` Mauro Carvalho Chehab
2019-04-23 19:37 ` Mauro Carvalho Chehab
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20190424145251.18e0b3af.cohuck@redhat.com \
--to=cohuck@redhat.com \
--cc=akrowiak@linux.ibm.com \
--cc=alifm@linux.ibm.com \
--cc=corbet@lwn.net \
--cc=farman@linux.ibm.com \
--cc=heiko.carstens@de.ibm.com \
--cc=kvm@vger.kernel.org \
--cc=linux-doc@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=linux-s390@vger.kernel.org \
--cc=mchehab+samsung@kernel.org \
--cc=mchehab@infradead.org \
--cc=pasic@linux.ibm.com \
--cc=pmorel@linux.ibm.com \
--cc=schwidefsky@de.ibm.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).