summaryrefslogtreecommitdiff
path: root/Documentation/media/conf_nitpick.py
AgeCommit message (Collapse)Author
2016-09-09[media] conf_nitpick.py: ignore C domain data used on vb2Mauro Carvalho Chehab
Ignore external C domain structs and functions used by VB2 header. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2016-09-09[media] conf_nitpick.py: ignore an opaque struct from v4l2-mem2mem.hMauro Carvalho Chehab
The v4l2_m2m_dev is opaque: its meaning is only known by v4l2-mem2mem.c. Ignore it on nitpick mode. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2016-09-09[media] v4l2-ioctl.h: document the remaining functionsMauro Carvalho Chehab
There are several undocumented functions here; document them. While here, make checkpatch.pl happy. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2016-09-09[media] conf_nitpick.py: ignore external functions used on mediactlMauro Carvalho Chehab
There are some functions/macros used by the mediactl documentation that are alien to the media subsystem. Ignore them. After this patch, the media core will only complain about this static function: Documentation/media/kapi/mc-core.rst:97: WARNING: c:func reference target not found: media_devnode_release Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2016-09-09[media] conf_nitpick.py: add external vars to ignore listMauro Carvalho Chehab
There a some other types and functions that aren't declared inside the media document but are elsewhere. Add them to the ignore list. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2016-08-22[media] docs-next: stop abusing on the cpp domainMauro 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: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2016-08-14doc-rst: add media/conf_nitpick.pyMarkus Heiser
The media/conf_nitpick.py is a *build-theme* wich uses the nit-picking mode of sphinx. To compile only the html of 'media' with the nit-picking build use:: make SPHINXDIRS=media SPHINX_CONF=conf_nitpick.py htmldocs With this, the Documentation/conf.py is read first and updated with the configuration values from the Documentation/media/conf_nitpick.py. The origin media/conf_nitpick.py comes from Mauro's experimental docs-next branch:: https://git.linuxtv.org/mchehab/experimental.git mchehab/docs-next BTW fixed python indentation in media/conf_nitpick.py. Python indentation is 4 spaces [1] and Python 3 disallows mixing the use of tabs and spaces for indentation [2]. [1] https://www.python.org/dev/peps/pep-0008/#indentation [2] https://www.python.org/dev/peps/pep-0008/#tabs-or-spaces Signed-off-by: Markus Heiser <markus.heiser@darmarIT.de> Signed-off-by: Jonathan Corbet <corbet@lwn.net>