From: Federico Vaga <federico.vaga@vaga.pv.it>
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>,
Harry Wei <harryxiyou@gmail.com>,
Alex Shi <alex.shi@linux.alibaba.com>,
Doug Ledford <dledford@redhat.com>,
Jason Gunthorpe <jgg@ziepe.ca>,
linux-rdma@vger.kernel.org
Subject: Re: [PATCH v1 02/22] docs: ioctl-number.txt: convert it to ReST format
Date: Wed, 19 Jun 2019 09:32:14 +0200 [thread overview]
Message-ID: <1723505.IrfYrSHNLM@pcbe13614> (raw)
In-Reply-To: <e8f1c925c5d118717eb38455e8f9dacf340cc35e.1560891322.git.mchehab+samsung@kernel.org>
On Tuesday, June 18, 2019 11:05:26 PM CEST Mauro Carvalho Chehab wrote:
> The conversion itself is simple: add a markup for the
> title of this file and add markups for both tables.
>
> Yet, the big table here with IOCTL numbers is badly formatted:
> on several lines, the "Include File" column has some values that
> are bigger than the reserved space there.
>
> Also, on several places, a comment was misplaced at the "Include
> File" space.
>
> So, most of the work here is to actually ensure that each field
> will be properly fixed.
>
> Also worth to mention that some URLs have the asterisk character
> on it. Well, Sphinx has an issue with asterisks in the middle
> of an string. As this is URL, use the alternate format: %2A.
>
> As a side effect of this patch, it is now a lot easier to see that
> some reserved ioctl numbers are missing the include files
> where it is supposed to be used.
>
> PS.: While this is part of a subdir, I opted to convert this
> single file alone, as this file has a potential of conflicts,
> as most subsystem maintainers touch it.
>
> Signed-off-by: Mauro Carvalho Chehab <mchehab+samsung@kernel.org>
> ---
> .../{ioctl-number.txt => ioctl-number.rst} | 588 +++++++++---------
> Documentation/process/submit-checklist.rst | 2 +-
> .../it_IT/process/submit-checklist.rst | 2 +-
> .../zh_CN/process/submit-checklist.rst | 2 +-
> include/uapi/rdma/rdma_user_ioctl_cmds.h | 2 +-
Acked-by: Federico Vaga <federico.vaga@vaga.pv.it>
--
Federico Vaga
http://www.federicovaga.it/
next prev parent reply other threads:[~2019-06-19 7:32 UTC|newest]
Thread overview: 65+ messages / expand[flat|nested] mbox.gz Atom feed top
2019-06-18 21:05 [PATCH v1 00/22] Convert files to ReST - part 3 Mauro Carvalho Chehab
2019-06-18 21:05 ` Mauro Carvalho Chehab
2019-06-18 21:05 ` [PATCH v1 01/22] docs: Documentation/*.txt: rename all ReST files to *.rst Mauro Carvalho Chehab
2019-06-18 21:05 ` Mauro Carvalho Chehab
2019-06-18 21:05 ` Mauro Carvalho Chehab
2019-06-18 21:05 ` Mauro Carvalho Chehab
2019-07-09 17:02 ` Rob Herring
2019-07-09 17:02 ` Rob Herring
2019-07-09 17:02 ` Rob Herring
2019-07-09 17:02 ` Rob Herring
2019-07-09 17:02 ` Rob Herring
2019-06-18 21:05 ` [PATCH v1 02/22] docs: ioctl-number.txt: convert it to ReST format Mauro Carvalho Chehab
2019-06-19 7:32 ` Federico Vaga [this message]
2019-06-18 21:05 ` [PATCH v1 03/22] docs: ioctl: convert to ReST Mauro Carvalho Chehab
2019-06-18 21:05 ` Mauro Carvalho Chehab
2019-06-18 21:05 ` [PATCH v1 04/22] docs: thermal: " Mauro Carvalho Chehab
2019-06-18 21:05 ` Mauro Carvalho Chehab
2019-06-25 13:40 ` Zhang Rui
2019-06-25 13:40 ` Zhang Rui
2019-06-25 13:53 ` Mauro Carvalho Chehab
2019-06-25 14:21 ` Zhang Rui
2019-06-25 14:21 ` Zhang Rui
2019-06-18 21:05 ` [PATCH v1 05/22] docs: rapidio: " Mauro Carvalho Chehab
2019-06-18 21:05 ` [PATCH v1 06/22] docs: blockdev: " Mauro Carvalho Chehab
2019-06-18 21:05 ` [PATCH v1 07/22] docs: perf: " Mauro Carvalho Chehab
2019-06-18 21:05 ` Mauro Carvalho Chehab
2019-06-18 21:05 ` [PATCH v1 08/22] docs: sysctl: " Mauro Carvalho Chehab
2019-06-18 21:05 ` [PATCH v1 09/22] docs: block: " Mauro Carvalho Chehab
2019-06-18 21:05 ` [PATCH v1 10/22] docs: security: move some books to it and update Mauro Carvalho Chehab
2019-06-18 21:05 ` [PATCH v1 11/22] docs: admin-guide: add .rst files from the main dir Mauro Carvalho Chehab
2019-06-18 21:05 ` Mauro Carvalho Chehab
2019-06-18 21:05 ` Mauro Carvalho Chehab
2019-06-18 21:05 ` Mauro Carvalho Chehab
2019-06-18 21:05 ` [PATCH v1 12/22] docs: driver-api: " Mauro Carvalho Chehab
2019-06-18 21:05 ` Mauro Carvalho Chehab
2019-06-18 21:05 ` Mauro Carvalho Chehab
2019-06-18 21:05 ` Mauro Carvalho Chehab
2019-06-18 21:05 ` [PATCH v1 13/22] docs: x86: move two x86-specific files to x86 arch dir Mauro Carvalho Chehab
2019-06-18 21:05 ` [PATCH v1 14/22] docs: usb: rename files to .rst and add them to drivers-api Mauro Carvalho Chehab
2019-06-19 6:23 ` Felipe Balbi
2019-06-19 6:46 ` Greg Kroah-Hartman
2019-06-19 6:47 ` Greg Kroah-Hartman
2019-06-19 12:39 ` Johan Hovold
[not found] ` <cover.1560891322.git.mchehab+samsung-DgEjT+Ai2ygdnm+yROfE0A@public.gmane.org>
2019-06-18 21:05 ` [PATCH v1 15/22] docs: driver-api: add a chapter for memory-related API Mauro Carvalho Chehab
2019-06-18 21:05 ` Mauro Carvalho Chehab
2019-06-18 21:05 ` Mauro Carvalho Chehab
2019-06-18 21:05 ` Mauro Carvalho Chehab
2019-06-18 21:05 ` [PATCH v1 16/22] docs: driver-api: add xilinx driver API documentation Mauro Carvalho Chehab
2019-06-18 21:05 ` Mauro Carvalho Chehab
2019-06-18 21:05 ` [PATCH v1 17/22] docs: add arch doc directories to the index Mauro Carvalho Chehab
2019-06-18 21:05 ` Mauro Carvalho Chehab
2019-06-18 21:05 ` Mauro Carvalho Chehab
2019-06-18 21:05 ` [PATCH v1 18/22] docs: admin-guide: move sysctl directory to it Mauro Carvalho Chehab
2019-06-18 21:05 ` [PATCH v1 19/22] docs: driver-api: add remaining converted dirs " Mauro Carvalho Chehab
2019-06-18 21:05 ` [PATCH v1 20/22] docs: extcon: move it to acpi dir and convert it to ReST Mauro Carvalho Chehab
2019-06-19 9:59 ` Rafael J. Wysocki
2019-06-19 10:02 ` Rafael J. Wysocki
2019-06-19 10:43 ` Mauro Carvalho Chehab
2019-06-18 21:05 ` [PATCH v1 21/22] docs: admin-guide: add laptops documentation Mauro Carvalho Chehab
2019-06-20 6:14 ` Andy Shevchenko
2019-06-18 21:05 ` [PATCH v1 22/22] admin-guide: add kdump documentation into it Mauro Carvalho Chehab
2019-06-18 21:05 ` Mauro Carvalho Chehab
2019-06-18 21:05 ` Mauro Carvalho Chehab
2019-06-18 21:05 ` Mauro Carvalho Chehab
2019-06-18 21:05 ` 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=1723505.IrfYrSHNLM@pcbe13614 \
--to=federico.vaga@vaga.pv.it \
--cc=alex.shi@linux.alibaba.com \
--cc=corbet@lwn.net \
--cc=dledford@redhat.com \
--cc=harryxiyou@gmail.com \
--cc=jgg@ziepe.ca \
--cc=linux-doc@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=linux-rdma@vger.kernel.org \
--cc=mchehab+samsung@kernel.org \
--cc=mchehab@infradead.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 an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.