Convert USB documentation to ReST format
Get series with b4
b4 am [email protected]Versions newest first
- v2 Latest21 patches 6 repliesIn review
Patches in v2 No applies recorded yet
| # | Subject and files | Size | Replies | Applied |
|---|---|---|---|---|
| 1/21 | tmplcvt: make the tool more robustDocumentation/ | +11 | 0 replies | |
| 2/21 | driver-api/basics.rst: add device table headerDocumentation/ | +6 | 0 replies | |
| 3/21 | docs-rst: convert usb docbooks to ReSTDocumentation/ Documentation/ Documentation/ +7 more | +1719 | 0 replies | |
| 4/21 | usb.rst: Enrich its ReST representationDocumentation/ | +17 | 0 replies | |
| 5/21 | gadget.rst: Enrich its ReST representation and add kernel-doc tagDocumentation/ | +52 | 0 replies | |
| 6/21 | writing_usb_driver.rst: Enrich its ReST representationDocumentation/ | +82 | 0 replies | |
| 7/21 | writing_musb_glue_layer.rst: Enrich its ReST representationDocumentation/ | +292 | 0 replies | |
| 8/21 | usb/anchors.txt: convert to ReST and add to driver-api bookDocumentation/ Documentation/ | +21 | 0 replies | |
| 9/21 | usb/bulk-streams.txt: convert to ReST and add to driver-api bookDocumentation/ Documentation/ | +10 | 0 replies | |
| 10/21 | usb/callbacks.txt: convert to ReST and add to driver-api bookDocumentation/ Documentation/ | +43 | 0 replies | |
| 11/21 | usb/power-management.txt: convert to ReST and add to driver-api bookDocumentation/ Documentation/ | +214 | 0 replies | |
| 12/21 | usb/dma.txt: convert to ReST and add to driver-api bookDocumentation/ Documentation/ | +28 | 0 replies | |
| 13/21 | error-codes.rst: convert to ReST and add to driver-api bookDocumentation/ Documentation/ Documentation/ | +206 | 0 replies | |
| 14/21 | usb/hotplug.txt: convert to ReST and add to driver-api bookDocumentation/ Documentation/ | +37 | 0 replies | |
| 15/21 | usb/persist.txt: convert to ReST and add to driver-api bookDocumentation/ Documentation/ | +14 | 0 replies | |
| 16/21 | usb/URB.txt: convert to ReST and update itDocumentation/ Documentation/ Documentation/ | +127 | 0 replies | |
| 17/21 | usb.rst: get rid of some Sphinx errorsDocumentation/ | +3 | 0 replies | |
| 18/21 | usb: get rid of some ReST doc build errorsdrivers/ include/ | +2 | 0 replies | |
| 19/21 | usb: composite.h: fix two warnings when building docsinclude/ | +3 | 0 replies | |
| 20/21 | usb: gadget.h: be consistent at kernel doc macrosinclude/ | +1 | 0 replies | |
| 21/21 | docs-rst: fix usb cross-referencesDocumentation/ Documentation/ Documentation/ +7 more | +15 | 0 replies |
Reviews trailers per patch
None of the 21 patches has a Reviewed-by or Acked-by of their own; the series has one for all of them.
| Patch | Greg Kroah-Hartman |
|---|---|
| Series | A-b |
| 1/21 | |
| 2/21 | |
| 3/21 | |
| 4/21 | |
| 5/21 | |
| 6/21 | |
| 7/21 | |
| 8/21 | |
| 9/21 | |
| 10/21 | |
| 11/21 | |
| 12/21 | |
| 13/21 | |
| 14/21 | |
| 15/21 | |
| 16/21 | |
| 17/21 | |
| 18/21 | |
| 19/21 | |
| 20/21 | |
| 21/21 |
Trailers given in replies are filled; those carried in the patches from earlier versions are outlined with dashes.
Cover letter [PATCH v2 00/21] Convert USB documentation to ReST format
Currently, there are several USB core documents that are at either written in plain text or in DocBook format. Convert them to ReST and add to the driver-api book.
Mauro Carvalho Chehab (21):
tmplcvt: make the tool more robust
driver-api/basics.rst: add device table header
docs-rst: convert usb docbooks to ReST
usb.rst: Enrich its ReST representation
gadget.rst: Enrich its ReST representation and add kernel-doc tag writing_usb_driver.rst: Enrich its ReST representation writing_musb_glue_layer.rst: Enrich its ReST representation usb/anchors.txt: convert to ReST and add to driver-api book usb/bulk-streams.txt: convert to ReST and add to driver-api book usb/callbacks.txt: convert to ReST and add to driver-api book usb/power-management.txt: convert to ReST and add to driver-api book usb/dma.txt: convert to ReST and add to driver-api book error-codes.rst: convert to ReST and add to driver-api book usb/hotplug.txt: convert to ReST and add to driver-api book usb/persist.txt: convert to ReST and add to driver-api book usb/URB.txt: convert to ReST and update it
usb.rst: get rid of some Sphinx errors
usb: get rid of some ReST doc build errors
usb: composite.h: fix two warnings when building docs
usb: gadget.h: be consistent at kernel doc macros
docs-rst: fix usb cross-references
Documentation/ABI/stable/sysfs-bus-usb | 2 +-
Documentation/DocBook/Makefile | 7 +-
Documentation/DocBook/gadget.tmpl | 793 -------------------
Documentation/DocBook/writing_musb_glue_layer.tmpl | 873 ---------------------
Documentation/DocBook/writing_usb_driver.tmpl | 412 ----------
Documentation/driver-api/basics.rst | 6 +
Documentation/driver-api/index.rst | 2 +-
.../{usb/URB.txt => driver-api/usb/URB.rst} | 223 +++---
.../anchors.txt => driver-api/usb/anchors.rst} | 36 +-
.../usb/bulk-streams.rst} | 13 +-
.../callbacks.txt => driver-api/usb/callbacks.rst} | 65 +-
.../{usb/dma.txt => driver-api/usb/dma.rst} | 51 +-
Documentation/driver-api/usb/error-codes.rst | 207 +++++
Documentation/driver-api/usb/gadget.rst | 510 ++++++++++++
.../hotplug.txt => driver-api/usb/hotplug.rst} | 66 +-
Documentation/driver-api/usb/index.rst | 26 +
.../persist.txt => driver-api/usb/persist.rst} | 22 +-
.../usb/power-management.rst} | 404 +++++-----
Documentation/driver-api/{ => usb}/usb.rst | 222 +++---
.../driver-api/usb/writing_musb_glue_layer.rst | 723 +++++++++++++++++
.../driver-api/usb/writing_usb_driver.rst | 326 ++++++++
Documentation/power/swsusp.txt | 2 +-
Documentation/sphinx/tmplcvt | 13 +-
Documentation/usb/error-codes.txt | 175 -----
drivers/staging/most/hdm-usb/hdm_usb.c | 2 +-
drivers/usb/core/Kconfig | 2 +-
drivers/usb/core/message.c | 1 +
include/linux/usb/composite.h | 6 +-
include/linux/usb/gadget.h | 2 +-
29 files changed, 2417 insertions(+), 2775 deletions(-)
delete mode 100644 Documentation/DocBook/gadget.tmpl
delete mode 100644 Documentation/DocBook/writing_musb_glue_layer.tmpl
delete mode 100644 Documentation/DocBook/writing_usb_driver.tmpl
rename Documentation/{usb/URB.txt => driver-api/usb/URB.rst} (50%)
rename Documentation/{usb/anchors.txt => driver-api/usb/anchors.rst} (75%)
rename Documentation/{usb/bulk-streams.txt => driver-api/usb/bulk-streams.rst} (94%)
rename Documentation/{usb/callbacks.txt => driver-api/usb/callbacks.rst} (76%)
rename Documentation/{usb/dma.txt => driver-api/usb/dma.rst} (79%)
create mode 100644 Documentation/driver-api/usb/error-codes.rst
create mode 100644 Documentation/driver-api/usb/gadget.rst
rename Documentation/{usb/hotplug.txt => driver-api/usb/hotplug.rst} (76%)
create mode 100644 Documentation/driver-api/usb/index.rst
rename Documentation/{usb/persist.txt => driver-api/usb/persist.rst} (94%)
rename Documentation/{usb/power-management.txt => driver-api/usb/power-management.rst} (69%)
rename Documentation/driver-api/{ => usb}/usb.rst (85%)
create mode 100644 Documentation/driver-api/usb/writing_musb_glue_layer.rst
create mode 100644 Documentation/driver-api/usb/writing_usb_driver.rst
delete mode 100644 Documentation/usb/error-codes.txtSignature · 1 line
2.9.3