- 23 8月, 2016 12 次提交
-
-
由 Mauro Carvalho Chehab 提交于
Now that we have an override for the c domain that will do the right thing for the Kernel, stop abusing on the cpp domain. Signed-off-by: NMauro Carvalho Chehab <mchehab@s-opensource.com>
-
由 Mauro Carvalho Chehab 提交于
Enrich math formulas by using the Sphinx math. That will allow using those formulas on pdf documents as well. Signed-off-by: NMauro Carvalho Chehab <mchehab@s-opensource.com>
-
由 Mauro Carvalho Chehab 提交于
We need adjustbox to allow adjusting the size of tables that are bigger than the line width. There are quite a few of them at the media books. Signed-off-by: NMauro Carvalho Chehab <mchehab@s-opensource.com> Signed-off-by: NJonathan Corbet <corbet@lwn.net>
-
由 Mauro Carvalho Chehab 提交于
When XeLaTeX is in interactive mode, it complains that py@noticelength already exists. Rename it and declare it only once to avoid such messages. Signed-off-by: NMauro Carvalho Chehab <mchehab@s-opensource.com> Signed-off-by: NJonathan Corbet <corbet@lwn.net>
-
由 Mauro Carvalho Chehab 提交于
Instead of painting the box with gray, let's use a colored box. IMHO, that makes easier to warn users about some issue pointed by the Sphinx. It also matches to what we do already with the HTML output. Signed-off-by: NMauro Carvalho Chehab <mchehab@s-opensource.com> Signed-off-by: NJonathan Corbet <corbet@lwn.net>
-
由 Mauro Carvalho Chehab 提交于
While the current implementation works well when using as a paragraph, it doesn't work properly if inside a table. As we have quite a few such cases, fix the logic to take the column size into account. PS.: I took the logic there from the latest version of Sphinx.sty Signed-off-by: NMauro Carvalho Chehab <mchehab@s-opensource.com> Signed-off-by: NJonathan Corbet <corbet@lwn.net>
-
由 Mauro Carvalho Chehab 提交于
Sphinx supports LaTeX output. Sometimes, it is interesting to call it directly, instead of also generating a PDF. As it comes for free, add a target for it. Signed-off-by: NMauro Carvalho Chehab <mchehab@s-opensource.com> Signed-off-by: NJonathan Corbet <corbet@lwn.net>
-
由 Markus Heiser 提交于
This is only one example, demonstrating the benefits of the patch series. The CEC_DQEVENT ioctl is migrated to the sphinx c-domain and referred by ":name: CEC_DQEVENT". With this change the indirection using ":ref:`CEC_DQEVENT` is no longer needed, we can refer the ioctl directly with ":c:func:`CEC_DQEVENT`". As addition in the index, there is a entry "CEC_DQEVENT (C function)". Signed-off-by: NMarkus Heiser <markus.heiser@darmarIT.de> Signed-off-by: NJonathan Corbet <corbet@lwn.net>
-
由 Markus Heiser 提交于
Moved the *duplicate C object description* warnings for function declarations in the nitpicky mode. In nitpick mode, you can suppress those warnings (e.g. ioctl) with:: nitpicky = True nitpick_ignore = [ ("c:func", "ioctl"), ] See Sphinx documentation for the config values for ``nitpick`` and ``nitpick_ignore`` [1]. With this change all the ".. cpp:function:: int ioctl(..)" descriptions (found in the media book) can be migrated to ".. c:function:: int ioctl(..)", without getting any warnings. E.g.:: .. cpp:function:: int ioctl( int fd, int request, struct cec_event *argp ) .. c:function:: int ioctl( int fd, int request, struct cec_event *argp ) The main effect, is that we get those *CPP-types* back into Sphinx's C- namespace and we need no longer to distinguish between c/cpp references, when we refer a function like the ioctl. [1] http://www.sphinx-doc.org/en/stable/config.html?highlight=nitpick#confval-nitpickySigned-off-by: NMarkus Heiser <markus.heiser@darmarIT.de> Signed-off-by: NJonathan Corbet <corbet@lwn.net>
-
由 Markus Heiser 提交于
Add option 'name' to the "c:function:" directive. With option 'name' the ref-name of a function can be modified. E.g.:: .. c:function:: int ioctl( int fd, int request ) :name: VIDIOC_LOG_STATUS The func-name (e.g. ioctl) remains in the output but the ref-name changed from ``ioctl`` to ``VIDIOC_LOG_STATUS``. The index entry for this function is also changed to ``VIDIOC_LOG_STATUS`` and the function can now referenced by:: :c:func:`VIDIOC_LOG_STATUS` Signed-off-by: NMarkus Heiser <markus.heiser@darmarIT.de> Signed-off-by: NJonathan Corbet <corbet@lwn.net>
-
由 Markus Heiser 提交于
Add a sphinx-extension to customize the sphinx c-domain. No functional changes right yet, just the boilerplate code. Signed-off-by: NMarkus Heiser <markus.heiser@darmarIT.de> [ jc: coding-style tweak ] Signed-off-by: NJonathan Corbet <corbet@lwn.net>
-
由 Songjun Wu 提交于
DT binding documentation for ISC driver. Acked-by: NRob Herring <robh@kernel.org> Signed-off-by: NSongjun Wu <songjun.wu@microchip.com> Signed-off-by: NHans Verkuil <hans.verkuil@cisco.com> Signed-off-by: NMauro Carvalho Chehab <mchehab@s-opensource.com>
-
- 22 8月, 2016 28 次提交
-
-
由 Mauro Carvalho Chehab 提交于
On some places, either an space or the second ':' is missing. Fix them. Signed-off-by: NMauro Carvalho Chehab <mchehab@s-opensource.com>
-
由 Mauro Carvalho Chehab 提交于
There are several minor issues that are seen when building PDF on interactive mode. Fix them. Signed-off-by: NMauro Carvalho Chehab <mchehab@s-opensource.com>
-
由 Mauro Carvalho Chehab 提交于
A few tables are not properly output on LaTeX format. Fix them. Signed-off-by: NMauro Carvalho Chehab <mchehab@s-opensource.com>
-
由 Mauro Carvalho Chehab 提交于
One table here is not being properly displayed on LaTeX format. Adjust it. Signed-off-by: NMauro Carvalho Chehab <mchehab@s-opensource.com>
-
由 Mauro Carvalho Chehab 提交于
The table is too big to fit into a single page on LaTeX format. Signed-off-by: NMauro Carvalho Chehab <mchehab@s-opensource.com>
-
由 Mauro Carvalho Chehab 提交于
There are two big tables here that are very hard to adjust its size. The first one would fit into one page, but the latex.py logic at Sphinx auto-switches to longtable when there are more than 30 rows. There's no way to override without coding. The second one is really big, and won't fit on a single page. So, it has to use tiny font to fit. Signed-off-by: NMauro Carvalho Chehab <mchehab@s-opensource.com>
-
由 Mauro Carvalho Chehab 提交于
It is painful to put code/verbatim code in bold. It seems that the only way is to arrange it like: ``foo`` bar At least on LaTeX output, when this happens, the "foo" string is not hidentable/breakable. The entire string should fit into a single line. Add a workaround for this ReST limitation by splitting the foo string into two strings, on separate lines. The output is not the best, but it works. Signed-off-by: NMauro Carvalho Chehab <mchehab@s-opensource.com>
-
由 Mauro Carvalho Chehab 提交于
There are still a few tables with wrong columns at the uAPI docs. Fix them. Signed-off-by: NMauro Carvalho Chehab <mchehab@s-opensource.com>
-
由 Mauro Carvalho Chehab 提交于
Sphinx is really pedantic with respect to the order where table tags and references are created. Putting things at the wrong order causes troubles. The order that seems to work is: .. raw:: latex .. tabularcolumns:: .. _foo_name: .. cssclass: longtable .. flat-table:: Reorder the tags to the above order, to avoid troubles, and fix remaining warnings introduced by media recent patches. Signed-off-by: NMauro Carvalho Chehab <mchehab@s-opensource.com>
-
由 Mauro Carvalho Chehab 提交于
Fix the generic errors table to avoid column overflows on LaTeX output. Signed-off-by: NMauro Carvalho Chehab <mchehab@s-opensource.com>
-
由 Mauro Carvalho Chehab 提交于
Fix tables to avoid text to overflow the cell limits. Signed-off-by: NMauro Carvalho Chehab <mchehab@s-opensource.com>
-
由 Mauro Carvalho Chehab 提交于
There are some things there that aren't ok for ReST format. Fix them. Signed-off-by: NMauro Carvalho Chehab <mchehab@s-opensource.com>
-
由 Mauro Carvalho Chehab 提交于
The CEC kAPI documentation should also be part of the media book. Signed-off-by: NMauro Carvalho Chehab <mchehab@s-opensource.com>
-
由 Mauro Carvalho Chehab 提交于
A few tables at the media uAPI documentation have columns not well dimentioned. Adjust them. Signed-off-by: NMauro Carvalho Chehab <mchehab@s-opensource.com>
-
由 Mauro Carvalho Chehab 提交于
There are a few broken tables on LaTeX output at the DVB uAPI documentation. Fix them. Signed-off-by: NMauro Carvalho Chehab <mchehab@s-opensource.com>
-
由 Mauro Carvalho Chehab 提交于
Add position hints for some tables, in order for them to be shown properly on LaTeX output. Signed-off-by: NMauro Carvalho Chehab <mchehab@s-opensource.com>
-
由 Mauro Carvalho Chehab 提交于
Adjust the tables there to fit inside the page margins. Signed-off-by: NMauro Carvalho Chehab <mchehab@s-opensource.com>
-
由 Mauro Carvalho Chehab 提交于
Several tables are missing column definitions and/or are too big to fit into the page. Adjust them. Signed-off-by: NMauro Carvalho Chehab <mchehab@s-opensource.com>
-
由 Mauro Carvalho Chehab 提交于
The tuner type table misses descriptions for each type. While most of stuff are obvious, the two SDR definitions aren't. So, add descriptions to all of them. Signed-off-by: NMauro Carvalho Chehab <mchehab@s-opensource.com>
-
由 Mauro Carvalho Chehab 提交于
Adjust simple cases where the columns on some vidioc files are overriding their neighbours. Signed-off-by: NMauro Carvalho Chehab <mchehab@s-opensource.com>
-
由 Mauro Carvalho Chehab 提交于
The tables don't fit at the page on this file. As noticed before, Sphinx (or LaTeX?) does a crap job on tables with cell span, and some work has to be done to make it fit. Move the see also reference to a footnote, break one paragraph into two and adjust the table columns to make it visible. Signed-off-by: NMauro Carvalho Chehab <mchehab@s-opensource.com>
-
由 Mauro Carvalho Chehab 提交于
This table is too big for LaTeX output, and lacks columns specs for LaTeX format. Also, it has a hidden column, as there are some cell spans with the wrong values. Fix it, so it can be displayed properly on LaTeX/PDF. Signed-off-by: NMauro Carvalho Chehab <mchehab@s-opensource.com>
-
由 Mauro Carvalho Chehab 提交于
Some tables are not properly displayed on LaTeX. Fix them. Signed-off-by: NMauro Carvalho Chehab <mchehab@s-opensource.com>
-
由 Mauro Carvalho Chehab 提交于
There are two tables with mangled columns. Fix it. Signed-off-by: NMauro Carvalho Chehab <mchehab@s-opensource.com>
-
由 Mauro Carvalho Chehab 提交于
Better adjust the columns for LaTeX output Signed-off-by: NMauro Carvalho Chehab <mchehab@s-opensource.com>
-
由 Mauro Carvalho Chehab 提交于
This table has several troubles: - a duplicated "struct" on its name; - a reference to a V4L version 1 struct that will never point to something (as we got rid of V4L1 API a long time ago); - misses hints for LaTeX output (column size and longtable style). Fix them. It should be noticed that the first column of this table is not aligned with the rest. I suspect that this is a bug at the flat-table extension. Signed-off-by: NMauro Carvalho Chehab <mchehab@s-opensource.com>
-
由 Mauro Carvalho Chehab 提交于
Fix mosto fo the tables there in order to make them fit at the page size. There are, however, two exceptions: RGB and YUV big tables, where adding the raw latex adjustbox caused the tables to not be properly formatted. I suspect that the problem is because those are long tables, but not really sure. The thing is that Sphinx lacks an "adjustbox" tag that would avoid the raw latex hacks. Signed-off-by: NMauro Carvalho Chehab <mchehab@s-opensource.com>
-
由 Mauro Carvalho Chehab 提交于
The table there is too big and doesn't have format hints for LaTeX output. Fix it. Signed-off-by: NMauro Carvalho Chehab <mchehab@s-opensource.com>
-