Re: [PATCH 36/57] docs: usb: convert documents to ReST

Mauro Carvalho Chehab
2019-04-16T11:43:38Z

Em Tue, 16 Apr 2019 09:12:32 +0300
Felipe Balbi <felipe.balbi@linux.intel.com> escreveu:

> Mauro Carvalho Chehab <mchehab+samsung@kernel.org> writes:
>
> > Convert USB documents to ReST, in order to prepare for adding it
> > to the kernel API book, as most of the stuff there are driver or
> > subsystem-related.
> >
> > Signed-off-by: Mauro Carvalho Chehab <mchehab+samsung@kernel.org>
> > ---
> > Documentation/usb/WUSB-Design-overview.txt | 56 +-
> > Documentation/usb/acm.txt | 156 +++---
> > Documentation/usb/authorization.txt | 75 +--
> > Documentation/usb/chipidea.txt | 101 ++--
> > Documentation/usb/dwc3.txt | 12 +-
> > Documentation/usb/ehci.txt | 42 +-
> > Documentation/usb/functionfs.txt | 17 +-
> > Documentation/usb/gadget-testing.txt | 609 ++++++++++++---------
> > Documentation/usb/gadget_configfs.txt | 302 +++++-----
> > Documentation/usb/gadget_hid.txt | 175 +++---
> > Documentation/usb/gadget_multi.txt | 43 +-
> > Documentation/usb/gadget_printer.txt | 155 +++---
> > Documentation/usb/gadget_serial.txt | 73 +--
> > Documentation/usb/iuu_phoenix.txt | 34 +-
> > Documentation/usb/mass-storage.txt | 19 +-
> > Documentation/usb/misc_usbsevseg.txt | 9 +-
> > Documentation/usb/mtouchusb.txt | 42 +-
> > Documentation/usb/ohci.txt | 5 +-
> > Documentation/usb/rio.txt | 83 +--
> > Documentation/usb/usb-help.txt | 21 +-
> > Documentation/usb/usb-serial.txt | 203 ++++---
> > Documentation/usb/usbip_protocol.txt | 552 ++++++++++---------
> > Documentation/usb/usbmon.txt | 100 ++--
>
> should you change extension to .rst while at that?

I did that on a first version (not submitted):

https://git.linuxtv.org/mchehab/experimental.git/commit/?h=all_with_indexes&id=d7eec4678dbfeb1a40c58bca7a157c8a4c39fa04

but I opted do the postpone the rename to a new series yet to be
sent.

The problem is that renaming it will make Sphinx to try to build them,
causing lots of warnings because they won't be inside an index file.
Adding index would touch Documentation/index (or Documentation/drivers-api),
with would cause merge conflicts.

Once this patch gets merged upstream, a renaming patch can happen
anytime. It probably makes sense to do all renames at once, late
at a merge window.

Thanks,
Mauro