From: Mauro Carvalho Chehab <mchehab+samsung@kernel.org>
To: "Rafael J. Wysocki" <rafael@kernel.org>
Cc: Linux Doc Mailing List <linux-doc@vger.kernel.org>,
Mauro Carvalho Chehab <mchehab@infradead.org>,
Linux Kernel Mailing List <linux-kernel@vger.kernel.org>,
Jonathan Corbet <corbet@lwn.net>,
"Rafael J. Wysocki" <rjw@rjwysocki.net>,
Viresh Kumar <viresh.kumar@linaro.org>,
Linux PM <linux-pm@vger.kernel.org>
Subject: Re: [PATCH 09/57] docs: cpu-freq: convert files to ReST
Date: Tue, 16 Apr 2019 06:58:15 -0300 [thread overview]
Message-ID: <20190416065815.57fbdf2c@coco.lan> (raw)
In-Reply-To: <CAJZ5v0he8GHZ+EFJ911vgrO53NnEWDwm=_vZD4K9SVL0MahMTQ@mail.gmail.com>
Em Tue, 16 Apr 2019 10:21:31 +0200
"Rafael J. Wysocki" <rafael@kernel.org> escreveu:
> On Tue, Apr 16, 2019 at 4:56 AM Mauro Carvalho Chehab
> <mchehab+samsung@kernel.org> wrote:
> >
> > In order to be able to build html and pdf files, convert the
> > documentation to ReST format.
> >
> > Signed-off-by: Mauro Carvalho Chehab <mchehab+samsung@kernel.org>
>
> Please don't convert these files.
>
> They need more work than just semi-automatic conversion
Except for one exception (at patch 32/57), the ReST conversion on this
patch set was manually made. I basically renamed the files to
.rst, checked the errors and fixed, trying to preserve the original
document style as much as possible, while providing a good visual
for the html output.
I suspect that trying to write a script for such kind of conversion
is not an easy task, as some documents within the Kernel tree have
their own personal style, (there was even one written in LaTeX at
the CDROM docs), and I suspect that a script would end by adding
extra unwanted markups.
> and the material in them needs to go under driver-api.
Yeah, those documents make sense to be at the driver-api set.
The rationale why I placed the patch with actually renames on a
separate patchset (already on my devel tree, but yet to be submitted)
is that, this way, it should be easy for maintainers to pick the
conversion patch, apply on their trees, and, if they're not ready
yet, postpone the actual rename/move thing.
> This is quite hight in my TODO list.
OK. Feel free to use this patch as a starting point if you
want.
Regards,
Mauro
next prev parent reply other threads:[~2019-04-16 9:58 UTC|newest]
Thread overview: 81+ messages / expand[flat|nested] mbox.gz Atom feed top
2019-04-16 2:55 [PATCH 00/57] Convert files to ReST Mauro Carvalho Chehab
2019-04-16 2:55 ` [PATCH 01/57] docs: trace: fix some Sphinx warnings Mauro Carvalho Chehab
2019-04-16 2:55 ` [PATCH 02/57] docs: acpi: convert text files to ReST Mauro Carvalho Chehab
2019-04-16 8:17 ` Rafael J. Wysocki
2019-04-16 9:54 ` Mauro Carvalho Chehab
2019-04-16 10:17 ` Rafael J. Wysocki
2019-04-16 14:55 ` Changbin Du
2019-04-22 13:31 ` Mauro Carvalho Chehab
2019-04-16 2:55 ` [PATCH 03/57] docs: aoe: " Mauro Carvalho Chehab
2019-04-16 2:55 ` [PATCH 04/57] docs: arm64: convert documentation to ReST format Mauro Carvalho Chehab
2019-04-16 2:55 ` [PATCH 06/57] docs: cdrom: convert remaining files to ReST Mauro Carvalho Chehab
2019-04-16 2:55 ` [PATCH 08/57] docs: cgroup-v1/blkio-controller.rst: add a note about CFQ scheduler Mauro Carvalho Chehab
2019-04-16 2:55 ` [PATCH 09/57] docs: cpu-freq: convert files to ReST Mauro Carvalho Chehab
2019-04-16 8:21 ` Rafael J. Wysocki
2019-04-16 9:58 ` Mauro Carvalho Chehab [this message]
2019-04-16 2:55 ` [PATCH 11/57] docs: extcon: move it to acpi dir and convert it " Mauro Carvalho Chehab
2019-04-16 2:55 ` [PATCH 12/57] docs: fault-injection: convert it to ReST format Mauro Carvalho Chehab
2019-04-16 2:55 ` [PATCH 14/57] docs: fpga: convert it to ReST Mauro Carvalho Chehab
2019-04-16 2:55 ` [PATCH 15/57] docs: gpio: " Mauro Carvalho Chehab
2019-04-23 10:52 ` Linus Walleij
2019-04-23 12:38 ` Mauro Carvalho Chehab
2019-04-16 2:55 ` [PATCH 16/57] docs: ide: convert it to ReST format Mauro Carvalho Chehab
2019-04-16 2:55 ` [PATCH 17/57] docs: infiniband: " Mauro Carvalho Chehab
2019-04-16 2:55 ` [PATCH 19/57] docs: kdump: convert it to ReST Mauro Carvalho Chehab
2019-04-16 2:55 ` [PATCH 20/57] docs: livepatch: convert it to ReST format Mauro Carvalho Chehab
2019-04-16 8:43 ` Petr Mladek
2019-04-16 11:47 ` Mauro Carvalho Chehab
2019-04-16 2:55 ` [PATCH 21/57] docs: locking: convert docs " Mauro Carvalho Chehab
2019-04-16 2:55 ` [PATCH 22/57] docs: mic: convert it " Mauro Carvalho Chehab
2019-04-16 2:55 ` [PATCH 23/57] docs: netlabel: convert it to ReST Mauro Carvalho Chehab
2019-04-17 14:36 ` Paul Moore
2019-04-16 2:55 ` [PATCH 24/57] docs: pcmcia: convert it to ReST format Mauro Carvalho Chehab
2019-04-16 4:58 ` Dominik Brodowski
2019-04-16 2:55 ` [PATCH 26/57] docs: powerpc: convert docs to ReST Mauro Carvalho Chehab
2019-04-16 2:55 ` [PATCH 27/57] docs: pps/pps.txt convert it to ReST and move to API book Mauro Carvalho Chehab
2019-04-16 2:55 ` [PATCH 28/57] docs: ptp.txt: convert to ReST and move to driver-api Mauro Carvalho Chehab
2019-04-16 2:55 ` [PATCH 29/57] docs: riscv: convert it to ReST format Mauro Carvalho Chehab
2019-04-16 2:55 ` [PATCH 30/57] docs: s390: Debugging390.txt: convert table to ascii artwork Mauro Carvalho Chehab
2019-04-16 2:55 ` [PATCH 32/57] s390: include/asm/debug.h add kerneldoc markups Mauro Carvalho Chehab
2019-04-16 2:55 ` [PATCH 33/57] docs: serial: convert it to ReST format Mauro Carvalho Chehab
2019-04-16 2:55 ` [PATCH 34/57] docs: target: " Mauro Carvalho Chehab
2019-04-16 2:56 ` [PATCH 35/57] docs: timers: convert documentation to ReST Mauro Carvalho Chehab
2019-04-16 2:56 ` [PATCH 37/57] docs: watchdog: convert documents to ReST format Mauro Carvalho Chehab
2019-04-17 17:53 ` Guenter Roeck
2019-04-16 2:56 ` [PATCH 39/57] docs: xilinx: convert eemi.txt to ReST Mauro Carvalho Chehab
2019-04-16 2:56 ` [PATCH 40/57] docs: scheduler: convert files " Mauro Carvalho Chehab
2019-04-16 2:56 ` [PATCH 41/57] docs: EDID/HOWTO.txt: convert to ReST and move to kernel-API Mauro Carvalho Chehab
2019-04-16 2:56 ` [PATCH 42/57] docs: connector.txt: convert to ReST Mauro Carvalho Chehab
2019-04-16 2:56 ` [PATCH 43/57] docs: lcd-panel-cgram.txt convert it to ReST and move to admin-guide Mauro Carvalho Chehab
2019-04-16 2:56 ` [PATCH 44/57] docs: lp855x-driver.txt: convert to ReST and move to kernel-api Mauro Carvalho Chehab
2019-04-16 2:56 ` [PATCH 45/57] docs: m68k: convert it to ReST file format and add to arch bookset Mauro Carvalho Chehab
2019-04-16 2:56 ` [PATCH 46/57] docs: cma/debugfs.txt: convert to ReST and move to admin-guide/mm Mauro Carvalho Chehab
2019-04-16 5:21 ` Mike Rapoport
2019-04-16 11:35 ` Mauro Carvalho Chehab
2019-04-16 2:56 ` [PATCH 47/57] docs: console.txt: convert to ReST format Mauro Carvalho Chehab
2019-04-16 2:56 ` [PATCH 48/57] docs: pti_intel_mid.txt: convert to ReST Mauro Carvalho Chehab
2019-04-16 2:56 ` [PATCH 49/57] docs: early-userspace: convert docs " Mauro Carvalho Chehab
2019-04-16 2:56 ` [PATCH 50/57] docs: driver-model: convert it to ReST format Mauro Carvalho Chehab
2019-04-16 2:56 ` [PATCH 52/57] docs: memory-devices: convert ti-emif.txt " Mauro Carvalho Chehab
2019-04-16 2:56 ` [PATCH 53/57] docs: xen-tpmfront.txt: convert the file " Mauro Carvalho Chehab
2019-04-16 2:56 ` [PATCH 54/57] docs: bus-devices: ti-gpmc.txt: convert it to ReST Mauro Carvalho Chehab
2019-04-16 2:56 ` [PATCH 55/57] docs: nvmem: convert file to ReST format Mauro Carvalho Chehab
2019-04-16 2:56 ` [PATCH 56/57] docs: phy: convert samsung-usb2.txt " Mauro Carvalho Chehab
2019-04-16 2:56 ` [PATCH 57/57] docs: Prepare files to be renamed to *.rst Mauro Carvalho Chehab
[not found] ` <eaafc5741ccfe3b96ab2a9ef799c537c49ab20e5.1555382110.git.mchehab+samsung@kernel.org>
2019-04-16 6:12 ` [PATCH 36/57] docs: usb: convert documents to ReST Felipe Balbi
2019-04-16 11:43 ` Mauro Carvalho Chehab
[not found] ` <cfab8842b681a84518b327980b08aee95d159605.1555382110.git.mchehab+samsung@kernel.org>
2019-04-16 7:20 ` [PATCH 25/57] docs: power: convert docs " Pavel Machek
2019-04-16 8:59 ` Rafael J. Wysocki
2019-04-16 10:41 ` Mauro Carvalho Chehab
2019-04-16 10:47 ` Rafael J. Wysocki
[not found] ` <9dd3c4eca01489bd67ea6de88dfedef8b0e81901.1555382110.git.mchehab+samsung@kernel.org>
2019-04-16 13:28 ` [PATCH 10/57] docs: device-mapper: convert it to ReST format Mike Snitzer
2019-04-16 14:00 ` Jonathan Corbet
2019-04-16 14:33 ` Mauro Carvalho Chehab
2019-04-16 15:48 ` Mike Snitzer
2019-04-16 17:27 ` Jonathan Corbet
2019-04-16 18:14 ` Mauro Carvalho Chehab
[not found] ` <5cfeb21a8841c1e029e8396bdaa7cd55ac0b08a2.1555382110.git.mchehab+samsung@kernel.org>
2019-04-18 9:25 ` [PATCH 18/57] docs: kbuild: convert it to ReST output Masahiro Yamada
2019-04-18 10:26 ` Mauro Carvalho Chehab
2019-04-18 12:42 ` Avoiding merge conflicts while adding new docs - Was: Re: [PATCH 00/57] Convert files to ReST Mauro Carvalho Chehab
2019-04-19 22:10 ` Jonathan Corbet
[not found] ` <CGME20190416025636epcas4p2b3bd395b2673bffb3cc0cbdd211aa841@epcas4p2.samsung.com>
[not found] ` <f282cbd57dcee9d598c13d8b1e4ea4cc1459b8ad.1555382110.git.mchehab+samsung@kernel.org>
2019-05-06 13:36 ` [PATCH 13/57] docs: fb: convert documentation to ReST format Bartlomiej Zolnierkiewicz
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=20190416065815.57fbdf2c@coco.lan \
--to=mchehab+samsung@kernel.org \
--cc=corbet@lwn.net \
--cc=linux-doc@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=linux-pm@vger.kernel.org \
--cc=mchehab@infradead.org \
--cc=rafael@kernel.org \
--cc=rjw@rjwysocki.net \
--cc=viresh.kumar@linaro.org \
/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).