kernel/linux
0
Fork 0
mirror of https://git.kernel.org/pub/scm/linux/kernel/git/stable/linux.git/ synced 2026-11-13 07:31:07 +00:00
Code Issues Releases Packages Activity
linux/Documentation/media/Makefile

67 lines
2 KiB
Raw Permalink Normal View History

docs-rst: media/Makefile: reorganize the rules Better organize the media/Makefile, in order to better split what's related to image conversion from the ones related to parse-headers.pl. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2016-11-30 08:00:18 -02:00
docs-rst: auto-generate PDF image files The PDF files that contain media images were actually generated offline from their SVG or PNG source files. Sphinx can handle PNG sources automatially. So, let's just drop their PDF counterparts. For SVG, however, Sphinx doesn't produce the right tags to use the TexLive SVG support. Also, the SVG support is done via shell execution, with is not nice. So, while we don't have any support for SVG inside Sphinx core or as an extension, move the logic to build them to Makefile, producing the PDF images on runtime. NOTE: due to the way Sphinx works, the PDF images should be generated inside the Kernel source tree, as otherwise Sphinx won't find it, not obeying what's specified by "O=" makefile parameter. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2016-11-14 14:32:32 -02:00
docs-rst: Don't use explicit Makefile rules to build SVG and DOT files Now that we have an extension to handle images, use it. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2017-03-09 15:14:52 -03:00
docs-rst: media/Makefile: reorganize the rules Better organize the media/Makefile, in order to better split what's related to image conversion from the ones related to parse-headers.pl. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2016-11-30 08:00:18 -02:00
docs-rst: auto-generate PDF image files The PDF files that contain media images were actually generated offline from their SVG or PNG source files. Sphinx can handle PNG sources automatially. So, let's just drop their PDF counterparts. For SVG, however, Sphinx doesn't produce the right tags to use the TexLive SVG support. Also, the SVG support is done via shell execution, with is not nice. So, while we don't have any support for SVG inside Sphinx core or as an extension, move the logic to build them to Makefile, producing the PDF images on runtime. NOTE: due to the way Sphinx works, the PDF images should be generated inside the Kernel source tree, as otherwise Sphinx won't find it, not obeying what's specified by "O=" makefile parameter. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2016-11-14 14:32:32 -02:00
docs-rst: media/Makefile: reorganize the rules Better organize the media/Makefile, in order to better split what's related to image conversion from the ones related to parse-headers.pl. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2016-11-30 08:00:18 -02:00
doc-rst: auto-generate: fixed include "output/*.h.rst" content Include auto-generate reST header files. BTW fixed linux_tv/Makefile. Signed-off-by: Markus Heiser <markus.heiser@darmarIT.de> Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2016-07-08 14:15:03 +02:00
docs-rst: media/Makefile: reorganize the rules Better organize the media/Makefile, in order to better split what's related to image conversion from the ones related to parse-headers.pl. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2016-11-30 08:00:18 -02:00
doc-rst: auto-build the frontend.h.rst This file is auto-generated with DocBook, from the uapi header. Do the same with Sphinx. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2016-07-07 00:21:37 -03:00
doc-rst: linux_tv/Makefile: Honor quiet mode Cleanup the Makefile and handle the V=1 flag and make it to work when specifying an output directory with O=dir Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2016-07-07 09:29:48 -03:00
doc-rst: auto-generate ca.h.rst This file comes from the uAPI definition header, and should be auto-generated, to be in sync with Kernel changes. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2016-07-07 07:51:03 -03:00
doc-rst: linux_tv/Makefile: Honor quiet mode Cleanup the Makefile and handle the V=1 flag and make it to work when specifying an output directory with O=dir Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2016-07-07 09:29:48 -03:00
doc-rst: auto-generate dmx.h.rst This file should be auto-generated from the header files, and not hardcoded. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2016-07-07 07:11:46 -03:00
doc-rst: linux_tv/Makefile: Honor quiet mode Cleanup the Makefile and handle the V=1 flag and make it to work when specifying an output directory with O=dir Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2016-07-07 09:29:48 -03:00
doc-rst: auto-generate audio.h.rst This is an auto-generated header. Remove the hardcoded one and do the right thing here. NOTE: this is a deprecated API. So, we won't make any effort to try identifying the meaning of this obscure API that is used only on a legacy driver. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2016-07-07 07:42:18 -03:00
doc-rst: linux_tv/Makefile: Honor quiet mode Cleanup the Makefile and handle the V=1 flag and make it to work when specifying an output directory with O=dir Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2016-07-07 09:29:48 -03:00
doc-rst: auto-generate net.h.rst This file comes from the uAPI definition header, and should be auto-generated, to be in sync with Kernel changes. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2016-07-07 08:28:43 -03:00
doc-rst: linux_tv/Makefile: Honor quiet mode Cleanup the Makefile and handle the V=1 flag and make it to work when specifying an output directory with O=dir Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2016-07-07 09:29:48 -03:00
doc-rst: auto-generate video.h.rst This file comes from the uAPI definition header, and should be auto-generated, to be in sync with Kernel changes. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2016-07-07 08:46:49 -03:00
doc-rst: linux_tv/Makefile: Honor quiet mode Cleanup the Makefile and handle the V=1 flag and make it to work when specifying an output directory with O=dir Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2016-07-07 09:29:48 -03:00
doc-rst: auto-generate: fixed include "output/*.h.rst" content Include auto-generate reST header files. BTW fixed linux_tv/Makefile. Signed-off-by: Markus Heiser <markus.heiser@darmarIT.de> Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2016-07-08 14:15:03 +02:00
doc-rst: linux_tv/Makefile: Honor quiet mode Cleanup the Makefile and handle the V=1 flag and make it to work when specifying an output directory with O=dir Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2016-07-07 09:29:48 -03:00
doc-rst: autogenerate videodev2.h.rst file This file comes from the uAPI definitions for V4L2, with is dynamic and updated on almost every Kernel version. So, this file needs to be auto-updated, as otherwise the documentation will become obsolete too early. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2016-07-07 11:05:38 -03:00
[media] doc-rst: add media.h header to media contrller Adding the header file is interesting for several reasons: 1) It makes MC documentation consistend with other parts; 2) The header file can be used as a quick index to all API elements; 3) The cross-reference check helps to identify symbols that aren't documented. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2016-07-09 08:54:35 -03:00
[media] cec: move the CEC framework out of staging and to media The last open issues have been addressed, so it is time to move this out of staging and into the mainline and to move the public cec headers to include/uapi/linux. Signed-off-by: Hans Verkuil <hans.verkuil@cisco.com> Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2016-11-02 08:25:28 -02:00
[media] doc-rst: add CEC header file to the documentation Adding the header file is interesting for several reasons: 1) It makes MC documentation consistend with other parts; 2) The header file can be used as a quick index to all API elements; 3) The cross-reference check helps to identify symbols that aren't documented. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2016-07-09 10:25:05 -03:00
[media] doc-rst: add LIRC header to the book Just like the other parts of the document, let's add the LIRC header, as it is part of the API. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2016-07-10 07:18:52 -03:00
docs-rst: media/Makefile: reorganize the rules Better organize the media/Makefile, in order to better split what's related to image conversion from the ones related to parse-headers.pl. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2016-11-30 08:00:18 -02:00
Add a target to check broken external links in the Documentation Documentation shouldn't have broken links. sphinx linkcheck builder scans all documents for external links, tries to open them with urllib2, and writes an overview which ones are broken and redirected to standard output and to output.txt in the output directory. Reviewed-by: Jani Nikula <jani.nikula@intel.com> Tested-by: Jani Nikula <jani.nikula@intel.com> Signed-off-by: Rémy Léone <remy.leone@gmail.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2017-02-15 13:16:35 +01:00
docs-rst: media/Makefile: reorganize the rules Better organize the media/Makefile, in order to better split what's related to image conversion from the ones related to parse-headers.pl. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2016-11-30 08:00:18 -02:00
docs-rst: fix media cleandocs target The builddir prefix was missing on make cleandocs. Fix it. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2016-11-30 08:00:19 -02:00
docs-rst: media/Makefile: reorganize the rules Better organize the media/Makefile, in order to better split what's related to image conversion from the ones related to parse-headers.pl. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2016-11-30 08:00:18 -02:00