From: Hans Verkuil <hverkuil@xs4all.nl>
To: Mauro Carvalho Chehab <mchehab@s-opensource.com>,
Linux Media Mailing List <linux-media@vger.kernel.org>
Cc: Mauro Carvalho Chehab <mchehab@infradead.org>
Subject: Re: [PATCH 00/18] Complete moving media documentation to ReST format
Date: Tue, 19 Jul 2016 11:19:11 +0200 [thread overview]
Message-ID: <578DF08F.8080701@xs4all.nl> (raw)
In-Reply-To: <cover.1468865380.git.mchehab@s-opensource.com>
On 07/18/16 20:30, Mauro Carvalho Chehab wrote:
> 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
Erm, there is nothing there, only the top-level menu.
Regards,
Hans
>
> 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
>
next prev parent reply other threads:[~2016-07-19 9:19 UTC|newest]
Thread overview: 36+ messages / expand[flat|nested] mbox.gz Atom feed top
2016-07-18 18:30 [PATCH 00/18] Complete moving media documentation to ReST format Mauro Carvalho Chehab
2016-07-18 18:30 ` [PATCH 01/18] [media] doc-rst: move bttv documentation to bttv.rst file Mauro Carvalho Chehab
2016-07-18 18:30 ` [PATCH 02/18] [media] doc-rst: add documentation for bttv driver Mauro Carvalho Chehab
2016-07-18 18:30 ` [PATCH 03/18] [media] doc-rst: add documentation for tuners Mauro Carvalho Chehab
2016-07-18 18:30 ` [PATCH 04/18] [media] doc-rst: start adding documentation for cx2341x Mauro Carvalho Chehab
2016-07-18 18:30 ` [PATCH 05/18] [media] cx2341x.rst: add fw-decoder-registers.txt content Mauro Carvalho Chehab
2016-07-18 18:30 ` [PATCH 06/18] [media] cx2341x.rst: Add the contents of fw-encoder-api.txt Mauro Carvalho Chehab
2016-07-18 18:30 ` [PATCH 07/18] [media] cx2341x.rst: add the contents of fw-calling.txt Mauro Carvalho Chehab
2016-07-18 18:30 ` [PATCH 08/18] [media] cx2341x.rst: add contents of fw-dma.txt Mauro Carvalho Chehab
2016-07-18 18:30 ` [PATCH 09/18] [media] cx2341x.rst: add contents of fw-memory.txt Mauro Carvalho Chehab
2016-07-18 18:30 ` [PATCH 10/18] [media] cx2341x.rst: add the contents of fw-upload.txt Mauro Carvalho Chehab
2016-07-18 18:30 ` [PATCH 11/18] [media] cx2341x.rst: add contents of fw-osd-api.txt Mauro Carvalho Chehab
2016-07-18 18:30 ` [PATCH 12/18] [media] cx2341x: add contents of README.hm12 Mauro Carvalho Chehab
2016-07-18 18:30 ` [PATCH 13/18] [media] cx2341x.rst: add contents of README.vbi Mauro Carvalho Chehab
2016-07-18 18:30 ` [PATCH 14/18] [media] cx88.rst: add contents from not-in-cx2388x-datasheet.txt Mauro Carvalho Chehab
2016-07-18 18:30 ` [PATCH 15/18] [media] cx88.rst: add contents of hauppauge-wintv-cx88-ir.txt Mauro Carvalho Chehab
2016-07-18 18:30 ` [PATCH 16/18] [media] get rid of Documentation/video4linux/lifeview.txt Mauro Carvalho Chehab
2016-07-18 18:30 ` [PATCH 17/18] [media] doc-rst: fix media kAPI documentation Mauro Carvalho Chehab
2016-07-18 18:30 ` [PATCH 18/18] [media] doc-rst: better name the media books Mauro Carvalho Chehab
2016-07-19 9:19 ` Hans Verkuil [this message]
2016-07-19 11:12 ` [PATCH 00/18] Complete moving media documentation to ReST format Mauro Carvalho Chehab
2016-07-19 12:31 ` Markus Heiser
2016-07-19 14:53 ` Mauro Carvalho Chehab
2016-07-19 15:40 ` Mauro Carvalho Chehab
2016-07-19 16:42 ` Markus Heiser
2016-07-19 17:18 ` Mauro Carvalho Chehab
2016-07-21 15:17 ` Markus Heiser
2016-07-22 9:46 ` Mauro Carvalho Chehab
2016-07-22 10:55 ` Markus Heiser
2016-07-19 22:49 ` Jonathan Corbet
2016-07-20 0:00 ` Mauro Carvalho Chehab
2016-07-20 6:07 ` Markus Heiser
2016-07-20 10:19 ` Mauro Carvalho Chehab
2016-07-20 23:28 ` Jonathan Corbet
2016-07-21 14:41 ` Markus Heiser
2016-07-21 16:59 ` Jonathan Corbet
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=578DF08F.8080701@xs4all.nl \
--to=hverkuil@xs4all.nl \
--cc=linux-media@vger.kernel.org \
--cc=mchehab@infradead.org \
--cc=mchehab@s-opensource.com \
/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).