Skip to content

Complete moving media documentation to ReST format

Mauro Carvalho Chehab linux-media 1 version In review

Get series with b4
b4 am [email protected]

Versions newest first

  1. v1 Latest18 patches 17 repliesIn review

Patches in v1 No applies recorded yet

#Subject and filesSizeRepliesApplied
1/18doc-rst: move bttv documentation to bttv.rst fileDocumentation/media/v4l-drivers/bttv.rst Documentation/media/v4l-drivers/tuners.rst Documentation/video4linux/bttv/CONTRIBUTORS +14 more+1881 -17630 replies
2/18doc-rst: add documentation for bttv driverDocumentation/media/v4l-drivers/bttv.rst Documentation/media/v4l-drivers/index.rst+96 -610 replies
3/18doc-rst: add documentation for tunersDocumentation/media/v4l-drivers/index.rst Documentation/media/v4l-drivers/tuners.rst+54 -370 replies
4/18doc-rst: start adding documentation for cx2341xDocumentation/media/v4l-drivers/cx2341x.rst Documentation/media/v4l-drivers/index.rst Documentation/video4linux/cx2341x/fw-decoder-api.txt+565 -2970 replies
5/18cx2341x.rst: add fw-decoder-registers.txt contentDocumentation/media/v4l-drivers/cx2341x.rst Documentation/video4linux/cx2341x/fw-decoder-regs.txt+914 -9060 replies
6/18cx2341x.rst: Add the contents of fw-encoder-api.txtDocumentation/media/v4l-drivers/cx2341x.rst Documentation/video4linux/cx2341x/fw-encoder-api.txt+1241 -7090 replies
7/18cx2341x.rst: add the contents of fw-calling.txtDocumentation/media/v4l-drivers/cx2341x.rst Documentation/video4linux/cx2341x/fw-calling.txt+75 -690 replies
8/18cx2341x.rst: add contents of fw-dma.txtDocumentation/media/v4l-drivers/cx2341x.rst Documentation/video4linux/cx2341x/fw-dma.txt+99 -960 replies
9/18cx2341x.rst: add contents of fw-memory.txtDocumentation/media/v4l-drivers/cx2341x.rst Documentation/video4linux/cx2341x/fw-memory.txt+151 -1390 replies
10/18cx2341x.rst: add the contents of fw-upload.txtDocumentation/media/v4l-drivers/cx2341x.rst+53 -00 replies
11/18cx2341x.rst: add contents of fw-osd-api.txtDocumentation/media/v4l-drivers/cx2341x.rst Documentation/video4linux/cx2341x/fw-osd-api.txt Documentation/video4linux/cx2341x/fw-upload.txt+675 -3990 replies
12/18cx2341x: add contents of README.hm12Documentation/media/v4l-drivers/cx2341x.rst Documentation/video4linux/cx2341x/README.hm12+125 -1200 replies
13/18cx2341x.rst: add contents of README.vbiDocumentation/media/v4l-drivers/cx2341x.rst Documentation/video4linux/cx2341x/README.vbi+50 -450 replies
14/18cx88.rst: add contents from not-in-cx2388x-datasheet.txtDocumentation/media/v4l-drivers/cx88.rst Documentation/video4linux/not-in-cx2388x-datasheet.txt+42 -410 replies
15/18cx88.rst: add contents of hauppauge-wintv-cx88-ir.txtDocumentation/media/v4l-drivers/cx88.rst Documentation/video4linux/cx88/hauppauge-wintv-cx88-ir.txt Documentation/video4linux/hauppauge-wintv-cx88-ir.txt+62 -1080 replies
16/18get rid of Documentation/video4linux/lifeview.txtDocumentation/media/v4l-drivers/bttv.rst Documentation/media/v4l-drivers/saa7134.rst Documentation/video4linux/lifeview.txt+44 -420 replies
17/18doc-rst: fix media kAPI documentationDocumentation/media/kapi/dtv-core.rst Documentation/media/kapi/mc-core.rst Documentation/media/kapi/rc-core.rst +1 more+1 -350 replies
18/18doc-rst: better name the media booksDocumentation/index.rst Documentation/media/dvb-drivers/index.rst Documentation/media/media_kapi.rst +2 more+23 -150 replies

Reviews trailers per patch

No Reviewed-by, Acked-by or Tested-by trailers for v1 yet.

Read the v1 thread

Cover letter [PATCH 00/18] Complete moving media documentation to ReST format

This patch series finally ends the conversion of the media documents to ReST format.

After this series, *all* media documentation will be inside a ReST book.

They'll be:

- Linux Media Infrastructure userspace API
- With 5 parts:
- Video for Linux API
- Digital TV API
- Remote Controller API
- Media Controller API
- CEC API
- Media subsystem kernel internal API
- Linux Digital TV driver-specific documentation
- Video4Linux (V4L) driver-specific documentation

All those documents are built automatically, once by day, at linuxtv.org:

uAPI:
https://linuxtv.org/downloads/v4l-dvb-apis-new/media/media_uapi.html

kAPI:
https://linuxtv.org/downloads/v4l-dvb-apis-new/media/media_kapi.html

DVB drivers:
https://linuxtv.org/downloads/v4l-dvb-apis-new/media/dvb-drivers/index.html

V4L drivers:
https://linuxtv.org/downloads/v4l-dvb-apis-new/media/v4l-drivers/index.html

That's said, there are lots of old/deprecated information there. Also, as the books are actually an aggregation of stuff written on different times, by different people, they don't look all the same.

I tried to fix some things while doing the documentation patch series, but there are still lots of things to be done, specially at the DVB and V4L drivers documentation.

There are also several V4L2 core functions not documented at the kAPI book, and the V4L framework document there is not properly cross referenced.

Anyway, now that everything can be seen on 4 books via html, maybe it will now be easier to identify and fix the gaps. I intend do do it for Kernel 4.9.

I'm merging all stuff on my main development tree:
https://git.linuxtv.org//mchehab/experimental.git/log/?h=docs-next

I should be merge soon today what we currently have at media mainstream tree.

Regards,
Mauro

Mauro Carvalho Chehab (18):
[media] doc-rst: move bttv documentation to bttv.rst file [media] doc-rst: add documentation for bttv driver [media] doc-rst: add documentation for tuners
[media] doc-rst: start adding documentation for cx2341x [media] cx2341x.rst: add fw-decoder-registers.txt content [media] cx2341x.rst: Add the contents of fw-encoder-api.txt [media] cx2341x.rst: add the contents of fw-calling.txt [media] cx2341x.rst: add contents of fw-dma.txt [media] cx2341x.rst: add contents of fw-memory.txt [media] cx2341x.rst: add the contents of fw-upload.txt [media] cx2341x.rst: add contents of fw-osd-api.txt [media] cx2341x: add contents of README.hm12
[media] cx2341x.rst: add contents of README.vbi [media] cx88.rst: add contents from not-in-cx2388x-datasheet.txt [media] cx88.rst: add contents of hauppauge-wintv-cx88-ir.txt [media] get rid of Documentation/video4linux/lifeview.txt [media] doc-rst: fix media kAPI documentation
[media] doc-rst: better name the media books

 Documentation/index.rst                            |    2 +-
 Documentation/media/dvb-drivers/index.rst          |    9 +-
 Documentation/media/kapi/dtv-core.rst              |    4 -
 Documentation/media/kapi/mc-core.rst               |    8 -
 Documentation/media/kapi/rc-core.rst               |    3 +-
 Documentation/media/kapi/v4l2-core.rst             |   21 -
 .../media/{media_drivers.rst => media_kapi.rst}    |    9 +-
 Documentation/media/media_uapi.rst                 |   10 +-
 Documentation/media/v4l-drivers/bttv.rst           | 1923 ++++++++++
 Documentation/media/v4l-drivers/cx2341x.rst        | 3858 ++++++++++++++++++++
 Documentation/media/v4l-drivers/cx88.rst           |  104 +
 Documentation/media/v4l-drivers/index.rst          |   11 +-
 Documentation/media/v4l-drivers/saa7134.rst        |   36 +
 Documentation/media/v4l-drivers/tuners.rst         |  131 +
 Documentation/video4linux/bttv/CONTRIBUTORS        |   25 -
 Documentation/video4linux/bttv/Cards               |  960 -----
 Documentation/video4linux/bttv/ICs                 |   37 -
 Documentation/video4linux/bttv/Insmod-options      |  172 -
 Documentation/video4linux/bttv/MAKEDEV             |   27 -
 Documentation/video4linux/bttv/Modprobe.conf       |   11 -
 Documentation/video4linux/bttv/Modules.conf        |   14 -
 Documentation/video4linux/bttv/PROBLEMS            |   62 -
 Documentation/video4linux/bttv/README              |   90 -
 Documentation/video4linux/bttv/README.WINVIEW      |   33 -
 Documentation/video4linux/bttv/README.freeze       |   74 -
 Documentation/video4linux/bttv/README.quirks       |   83 -
 Documentation/video4linux/bttv/Sound-FAQ           |  148 -
 Documentation/video4linux/bttv/Specs               |    3 -
 Documentation/video4linux/bttv/THANKS              |   24 -
 Documentation/video4linux/bttv/Tuners              |  115 -
 Documentation/video4linux/cx2341x/README.hm12      |  120 -
 Documentation/video4linux/cx2341x/README.vbi       |   45 -
 Documentation/video4linux/cx2341x/fw-calling.txt   |   69 -
 .../video4linux/cx2341x/fw-decoder-api.txt         |  297 --
 .../video4linux/cx2341x/fw-decoder-regs.txt        |  817 -----
 Documentation/video4linux/cx2341x/fw-dma.txt       |   96 -
 .../video4linux/cx2341x/fw-encoder-api.txt         |  709 ----
 Documentation/video4linux/cx2341x/fw-memory.txt    |  139 -
 Documentation/video4linux/cx2341x/fw-osd-api.txt   |  350 --
 Documentation/video4linux/cx2341x/fw-upload.txt    |   49 -
 .../video4linux/cx88/hauppauge-wintv-cx88-ir.txt   |   54 -
 .../video4linux/hauppauge-wintv-cx88-ir.txt        |   54 -
 Documentation/video4linux/lifeview.txt             |   42 -
 .../video4linux/not-in-cx2388x-datasheet.txt       |   41 -
 44 files changed, 6079 insertions(+), 4810 deletions(-)
 rename Documentation/media/{media_drivers.rst => media_kapi.rst} (76%)
 create mode 100644 Documentation/media/v4l-drivers/bttv.rst
 create mode 100644 Documentation/media/v4l-drivers/cx2341x.rst
 create mode 100644 Documentation/media/v4l-drivers/tuners.rst
 delete mode 100644 Documentation/video4linux/bttv/CONTRIBUTORS
 delete mode 100644 Documentation/video4linux/bttv/Cards
 delete mode 100644 Documentation/video4linux/bttv/ICs
 delete mode 100644 Documentation/video4linux/bttv/Insmod-options
 delete mode 100644 Documentation/video4linux/bttv/MAKEDEV
 delete mode 100644 Documentation/video4linux/bttv/Modprobe.conf
 delete mode 100644 Documentation/video4linux/bttv/Modules.conf
 delete mode 100644 Documentation/video4linux/bttv/PROBLEMS
 delete mode 100644 Documentation/video4linux/bttv/README
 delete mode 100644 Documentation/video4linux/bttv/README.WINVIEW
 delete mode 100644 Documentation/video4linux/bttv/README.freeze
 delete mode 100644 Documentation/video4linux/bttv/README.quirks
 delete mode 100644 Documentation/video4linux/bttv/Sound-FAQ
 delete mode 100644 Documentation/video4linux/bttv/Specs
 delete mode 100644 Documentation/video4linux/bttv/THANKS
 delete mode 100644 Documentation/video4linux/bttv/Tuners
 delete mode 100644 Documentation/video4linux/cx2341x/README.hm12
 delete mode 100644 Documentation/video4linux/cx2341x/README.vbi
 delete mode 100644 Documentation/video4linux/cx2341x/fw-calling.txt
 delete mode 100644 Documentation/video4linux/cx2341x/fw-decoder-api.txt
 delete mode 100644 Documentation/video4linux/cx2341x/fw-decoder-regs.txt
 delete mode 100644 Documentation/video4linux/cx2341x/fw-dma.txt
 delete mode 100644 Documentation/video4linux/cx2341x/fw-encoder-api.txt
 delete mode 100644 Documentation/video4linux/cx2341x/fw-memory.txt
 delete mode 100644 Documentation/video4linux/cx2341x/fw-osd-api.txt
 delete mode 100644 Documentation/video4linux/cx2341x/fw-upload.txt
 delete mode 100644 Documentation/video4linux/cx88/hauppauge-wintv-cx88-ir.txt
 delete mode 100644 Documentation/video4linux/hauppauge-wintv-cx88-ir.txt
 delete mode 100644 Documentation/video4linux/lifeview.txt
 delete mode 100644 Documentation/video4linux/not-in-cx2388x-datasheet.txt
Signature · 1 line
2.7.4