From: Mauro Carvalho Chehab <mchehab@s-opensource.com>
To: LMML <linux-media@vger.kernel.org>,
Linux Doc <linux-doc@vger.kernel.org>
Subject: [ANN] Media documentation converted to ReST markup language
Date: Fri, 8 Jul 2016 10:34:20 -0300 [thread overview]
Message-ID: <20160708103420.27453f0d@recife.lan> (raw)
As commented on the patch series I just submitted, we finished the conversion
of the Media uAPI book from DocBook to ReST.
For now, I'm placing the new documentation, after parsed by Sphinx, at this
place:
https://mchehab.fedorapeople.org/media_API_book/
There are some instructions there about how to use Sphinx too, with can be
useful for the ones writing patches. Those are part of the docs-next that
will be sent to Kernel 4.8, thanks to Jani Nikula an Jonathan Corbet.
The media docbook itself is located at:
https://mchehab.fedorapeople.org/media_API_book/linux_tv/index.html
And the patches are already at the media tree, under the "docs-next"
branch:
https://git.linuxtv.org/media_tree.git/log/?h=docs-next
If you find anything inconsistent, wrong or incomplete, feel free to
submit patches to it. My plan is to merge this branch on Kernel 4.8-rc1
and then remove the Documentation/DocBook/media stuff from the Kernel.
PS.: I'll soon be adding one extra patch there renaming the media
directory. "linux_tv" is not the best name for the media contents,
but, on the other hand, having a "media/media" directory also doesn't
make sense. So, I need to think for a better name before doing the
change. Pehaps I'll go for:
Documentation/media - for all media documentation, were we
should also store things that are now under
/video4linux and under /dvb;
and:
Documentation/media/uapi - for the above book that were just
converted from DocBook.
Enjoy!
Thanks,
Mauro
next reply other threads:[~2016-07-08 13:34 UTC|newest]
Thread overview: 7+ messages / expand[flat|nested] mbox.gz Atom feed top
2016-07-08 13:34 Mauro Carvalho Chehab [this message]
2016-07-08 13:45 ` [ANN] Media documentation converted to ReST markup language Hans Verkuil
2016-07-08 15:31 ` Mauro Carvalho Chehab
2016-07-09 14:36 ` Mauro Carvalho Chehab
2016-07-09 17:10 ` Laurent Pinchart
2016-07-13 14:11 ` Mauro Carvalho Chehab
2016-07-14 2:00 ` Laurent Pinchart
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=20160708103420.27453f0d@recife.lan \
--to=mchehab@s-opensource.com \
--cc=linux-doc@vger.kernel.org \
--cc=linux-media@vger.kernel.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 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).