[PATCH v2] media: net.h: add kernel-doc and use it at Documentation/

2017-09-03 Thread Mauro Carvalho Chehab
As we did with frontend.h, ca.h and dmx.h, move the struct definition to net.h. That should help to keep it updated, as more stuff gets added there. Signed-off-by: Mauro Carvalho Chehab --- v2: - Version 1 was broken: it was missing net-types.rst file and if_num was called "ifnum", causin

[PATCH 2/7] media: v4l2 uapi book: get rid of driver programming's chapter

2017-09-03 Thread Mauro Carvalho Chehab
It doesn't make any sense having a driver programming's chapter at the uAPI book, as this is related to kernel API. Also, we now have such kAPI book where V4L2 driver programming is covered. So, get rid of this left-over. Signed-off-by: Mauro Carvalho Chehab --- Documentation/media/uapi/v4l/dri

[PATCH 5/7] media: fix build breakage with Sphinx 1.6

2017-09-03 Thread Mauro Carvalho Chehab
Not sure why, but, on this particular document, on Sphinx 1.4 and 1.5, the usage of \small here causes it to write the table at the same column where the text before it ended, with makes the table to go out of the page. A possible solution would be to add a \newline on latex raw, with was the appr

[PATCH 4/7] media: vidioc-g-fmt.rst: adjust table format

2017-09-03 Thread Mauro Carvalho Chehab
While doing a visual inspection with Sphinx 1.5, I noticed that one of the columns was smaller than the text written there. As this is the only thing I noticed with Sphinx 1.5, I suspect that this was also a problem with Sphinx 1.4. Yet, I opted to touch it in a way that wouldn't cause backward is

[PATCH 6/7] media: pixfmt*.rst: replace a two dots by a comma

2017-09-03 Thread Mauro Carvalho Chehab
On several tables, the color sample location table preamble is written as: Color Sample Location.. Instead of: Color Sample Location: I suspect that the repetition of such pattern was due to some copy-and-paste (or perhaps some error during DocBook conversion). Anyway, fix it. Si

[PATCH 1/7] media: format.rst: use the right markup for important notes

2017-09-03 Thread Mauro Carvalho Chehab
There's an important note there, but it is not using the ReST markup. So, it doesn't get any visual highlight on the output. Signed-off-by: Mauro Carvalho Chehab --- Documentation/media/uapi/v4l/format.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Documentation/media/ua

[PATCH 7/7] media: index.rst: don't write "Contents:" on PDF output

2017-09-03 Thread Mauro Carvalho Chehab
Right now, Sphinx unconditionally creates a blank page with just "Contents:" on it, on PDF output. While this makes sense for html, it doesn't o PDF, as LaTeX does what's required automatically. Fix it. Signed-off-by: Mauro Carvalho Chehab --- Documentation/media/index.rst | 6 +- 1 file ch

[PATCH 3/7] media: vivid.rst: add a blank line to correct ReST format

2017-09-03 Thread Mauro Carvalho Chehab
On all vivid parameters, there's an space after the parameter, except for "DV Timings Signal Mode". That makes this single one to be written in bold, and, at PDF output, at the same line as its description. Use the same convention as the other parameters, in order to adjust its output. Signed-off

[PATCH 0/7] Another set of fixes for PDF output

2017-09-03 Thread Mauro Carvalho Chehab
There are other things that are needed for a proper PDF output, and a fix for yet another Sphinx 1.6 breakage. After this patch series, PDF output now looks OK on Sphinx 1.4 to 1.6. There's, however, one step back on Sphinx 1.6: I couldn't find any way to use a background color for notifications

[PATCH 2/2] docs-rst: conf.py: only setup notice box colors if Sphinx < 1.6

2017-09-03 Thread Mauro Carvalho Chehab
Sphinx 1.5 added a new way to change backward colors for note boxes, but kept backward compatibility with 1.4. On Sphinx 1.6, the old way stopped working, in favor of a new less hackish way. Unfortunately, this is currently too buggy to be used, and the old way doesn't work anymore. So, we have no

[PATCH 1/2] docs-rst: conf.py: remove lscape from LaTeX preamble

2017-09-03 Thread Mauro Carvalho Chehab
Only the media book used this extension in the past, but it is not required anymore. Cleanup patch only. Signed-off-by: Mauro Carvalho Chehab --- Documentation/conf.py | 3 --- 1 file changed, 3 deletions(-) diff --git a/Documentation/conf.py b/Documentation/conf.py index f9054ab60cb1..38a606b

[PATCH 0/2] Two cleanups for Sphinx conf.py

2017-09-03 Thread Mauro Carvalho Chehab
Hi Jon, Those patches are just cleanups for Documentation/conf.py. The first one removes a package usage directive for a LateX package that it is not used. The second one moves some LaTeX preamble code that it is used only on Sphinx 1.4 and 1.5 to a separate if. On Sphinx 1.6, the macros there

Re: [PATCH v2 00/26] Improve DVB documentation and reduce its gap

2017-09-03 Thread Honza Petrouš
> There is still a gap at the CA API, as there are three ioctls that are used > only by a few drivers and whose structs are not properly documented: > CA_GET_MSG, CA_SEND_MSG and CA_SET_DESCR. > > The first two ones seem to be related to a way that a few drivers > provide to send/receive messages.

[PATCH 1/1] docs-rst: media: Don't use \small for V4L2_PIX_FMT_SRGGB10 documentation

2017-09-03 Thread Sakari Ailus
There appears to be an issue in using \small in certain cases on Sphinx 1.4 and 1.5. Other format documents don't use \small either, remove it from here as well. Signed-off-by: Sakari Ailus --- Hi Mauro, What would you think of this as an alternative approach? No hacks needed. Just a recognition

Re: [PATCH v2 00/26] Improve DVB documentation and reduce its gap

2017-09-03 Thread Honza Petrouš
> There is still a gap at the CA API, as there are three ioctls that are used > only by a few drivers and whose structs are not properly documented: > CA_GET_MSG, CA_SEND_MSG and CA_SET_DESCR. > > The first two ones seem to be related to a way that a few drivers > provide to send/receive messages.

[PULL] Documentation for 4.14

2017-09-03 Thread Jonathan Corbet
After a fair amount of churn in the last couple of cycles, docs are taking it easier this time around. Lots of fixes and some new documentation, but nothing all that radical. Perhaps the most interesting change for many is the scripts/sphinx-pre-install tool from Mauro; it will tell you exactly w

Re: [PATCH v2 00/26] Improve DVB documentation and reduce its gap

2017-09-03 Thread Mauro Carvalho Chehab
Em Sun, 3 Sep 2017 22:05:23 +0200 Honza Petrouš escreveu: > 1) #define CA_SET_DESCR _IOW('o', 134, ca_descr_t) > > > CA_SET_DESCR is used for feeding descrambler device > with correct keys (called here "control words") what > allows to get servic

Re: [PATCH 00/15] Improve DVB documentation and reduce its gap

2017-09-03 Thread Soeren Moch
Hi Mauro, On 01.09.2017 11:32, Mauro Carvalho Chehab wrote: > Em Fri, 1 Sep 2017 10:40:28 +0200 > Honza Petrouš escreveu: > >> 2017-09-01 1:46 GMT+02:00 Mauro Carvalho Chehab : >>> The DVB documentation was negligected for a long time, with >>> resulted on several gaps between the API description

Re: [PATCH v2 00/26] Improve DVB documentation and reduce its gap

2017-09-03 Thread Mauro Carvalho Chehab
Em Sun, 3 Sep 2017 22:05:23 +0200 Honza Petrouš escreveu: > > There is still a gap at the CA API, as there are three ioctls that are used > > only by a few drivers and whose structs are not properly documented: > > CA_GET_MSG, CA_SEND_MSG and CA_SET_DESCR. > > > > The first two ones seem to be re

Re: [PATCH 1/1] docs-rst: media: Don't use \small for V4L2_PIX_FMT_SRGGB10 documentation

2017-09-03 Thread Mauro Carvalho Chehab
Em Sun, 3 Sep 2017 23:12:33 +0300 Sakari Ailus escreveu: > There appears to be an issue in using \small in certain cases on Sphinx > 1.4 and 1.5. Other format documents don't use \small either, remove it > from here as well. > > Signed-off-by: Sakari Ailus > --- > Hi Mauro, > > What would you

[no subject]

2017-09-03 Thread clownscrytoo
13379.doc Description: MS-Word document