media: docs: move user-facing docs to the admin guide

Most of the driver-specific documentation is meant to help users of the media subsystem. Move them to the admin-guide. It should be noticed, however, that several of those files are outdated and will require further work in order to make them useful again. Signed-off-by: Mauro Carvalho Chehab <[email protected]>
chewitt · Apr 14, 2020 · 32e2eae · 32e2eae
1 parent 2e9a7e0
commit 32e2eae
Show file tree

Hide file tree

Showing 72 changed files with 136 additions and 101 deletions.
diff --git a/Documentation/admin-guide/index.rst b/Documentation/admin-guide/index.rst
@@ -93,6 +93,7 @@ configure specific aspects of kernel behavior to your liking.
    lockup-watchdogs
    LSM/index
    md
+   media/index
    mm/index
    module-signing
    mono

diff --git a/Documentation/admin-guide/kernel-parameters.txt b/Documentation/admin-guide/kernel-parameters.txt
@@ -458,7 +458,7 @@
 	bttv.card=	[HW,V4L] bttv (bt848 + bt878 based grabber cards)
 	bttv.radio=	Most important insmod options are available as
 			kernel args too.
-	bttv.pll=	See Documentation/media/v4l-drivers/bttv.rst
+	bttv.pll=	See Documentation/admin-guide/media/bttv.rst
 	bttv.tuner=
 
 	bulk_remove=off	[PPC]  This parameter disables the use of the pSeries
@@ -2705,7 +2705,7 @@
 			See Documentation/admin-guide/pm/sleep-states.rst.
 
 	meye.*=		[HW] Set MotionEye Camera parameters
-			See Documentation/media/v4l-drivers/meye.rst.
+			See Documentation/admin-guide/media/meye.rst.
 
 	mfgpt_irq=	[IA-32] Specify the IRQ to use for the
 			Multi-Function General Purpose Timers on AMD Geode

diff --git a/...ion/media/v4l-drivers/au0828-cardlist.rst → ...ion/admin-guide/media/au0828-cardlist.rst b/...ion/media/v4l-drivers/au0828-cardlist.rst → ...ion/admin-guide/media/au0828-cardlist.rst
diff --git a/...mentation/media/dvb-drivers/avermedia.rst → ...mentation/admin-guide/media/avermedia.rst b/...mentation/media/dvb-drivers/avermedia.rst → ...mentation/admin-guide/media/avermedia.rst
diff --git a/Documentation/media/dvb-drivers/bt8xx.rst → Documentation/admin-guide/media/bt8xx.rst b/Documentation/media/dvb-drivers/bt8xx.rst → Documentation/admin-guide/media/bt8xx.rst
@@ -20,7 +20,7 @@ General information
 
 This class of cards has a bt878a as the PCI interface, and require the bttv driver
 for accessing the i2c bus and the gpio pins of the bt8xx chipset.
-Please see Documentation/media/dvb-drivers/cards.rst => o Cards based on the Conexant Bt8xx PCI bridge:
+Please see Documentation/admin-guide/media/cards.rst => o Cards based on the Conexant Bt8xx PCI bridge:
 
 Compiling kernel please enable:
 
@@ -47,7 +47,7 @@ Loading Modules
 Regular case: If the bttv driver detects a bt8xx-based DVB card, all frontend and backend modules will be loaded automatically.
 Exceptions are:
 - Old TwinHan DST cards or clones with or without CA slot and not containing an Eeprom.
-People running udev please see Documentation/media/dvb-drivers/udev.rst.
+People running udev please see Documentation/admin-guide/media/udev.rst.
 
 In the following cases overriding the PCI type detection for dvb-bt8xx might be necessary:
 
@@ -74,7 +74,7 @@ Useful parameters for verbosity level and debugging the dst module:
 The autodetected values are determined by the cards' "response string".
 In your logs see f. ex.: dst_get_device_id: Recognize [DSTMCI].
 For bug reports please send in a complete log with verbose=4 activated.
-Please also see Documentation/media/dvb-drivers/ci.rst.
+Please also see Documentation/admin-guide/media/ci.rst.
 
 Running multiple cards
 ~~~~~~~~~~~~~~~~~~~~~~
@@ -102,7 +102,7 @@ Examples of card ID's:
 
 	$ modprobe bttv card=113 card=135
 
-For a full list of card ID's please see Documentation/media/v4l-drivers/bttv-cardlist.rst.
+For a full list of card ID's please see Documentation/admin-guide/media/bttv-cardlist.rst.
 In case of further problems please subscribe and send questions to the mailing list: [email protected].
 
 Probing the cards with broken PCI subsystem ID

diff --git a/...ation/media/v4l-drivers/bttv-cardlist.rst → ...ation/admin-guide/media/bttv-cardlist.rst b/...ation/media/v4l-drivers/bttv-cardlist.rst → ...ation/admin-guide/media/bttv-cardlist.rst
diff --git a/Documentation/media/v4l-drivers/bttv.rst → Documentation/admin-guide/media/bttv.rst b/Documentation/media/v4l-drivers/bttv.rst → Documentation/admin-guide/media/bttv.rst
diff --git a/...mentation/media/v4l-drivers/cafe_ccic.rst → ...mentation/admin-guide/media/cafe_ccic.rst b/...mentation/media/v4l-drivers/cafe_ccic.rst → ...mentation/admin-guide/media/cafe_ccic.rst
diff --git a/Documentation/media/v4l-drivers/cardlist.rst → Documentation/admin-guide/media/cardlist.rst b/Documentation/media/v4l-drivers/cardlist.rst → Documentation/admin-guide/media/cardlist.rst
diff --git a/Documentation/media/dvb-drivers/cards.rst → Documentation/admin-guide/media/cards.rst b/Documentation/media/dvb-drivers/cards.rst → Documentation/admin-guide/media/cards.rst
diff --git a/Documentation/media/dvb-drivers/ci.rst → Documentation/admin-guide/media/ci.rst b/Documentation/media/dvb-drivers/ci.rst → Documentation/admin-guide/media/ci.rst
diff --git a/Documentation/media/v4l-drivers/cpia2.rst → Documentation/admin-guide/media/cpia2.rst b/Documentation/media/v4l-drivers/cpia2.rst → Documentation/admin-guide/media/cpia2.rst
diff --git a/...on/media/v4l-drivers/cx23885-cardlist.rst → ...on/admin-guide/media/cx23885-cardlist.rst b/...on/media/v4l-drivers/cx23885-cardlist.rst → ...on/admin-guide/media/cx23885-cardlist.rst
diff --git a/...ation/media/v4l-drivers/cx88-cardlist.rst → ...ation/admin-guide/media/cx88-cardlist.rst b/...ation/media/v4l-drivers/cx88-cardlist.rst → ...ation/admin-guide/media/cx88-cardlist.rst
diff --git a/Documentation/media/v4l-drivers/cx88.rst → Documentation/admin-guide/media/cx88.rst b/Documentation/media/v4l-drivers/cx88.rst → Documentation/admin-guide/media/cx88.rst
diff --git a/...tation/media/v4l-drivers/davinci-vpbe.rst → ...tation/admin-guide/media/davinci-vpbe.rst b/...tation/media/v4l-drivers/davinci-vpbe.rst → ...tation/admin-guide/media/davinci-vpbe.rst
diff --git a/...ion/media/v4l-drivers/em28xx-cardlist.rst → ...ion/admin-guide/media/em28xx-cardlist.rst b/...ion/media/v4l-drivers/em28xx-cardlist.rst → ...ion/admin-guide/media/em28xx-cardlist.rst
diff --git a/Documentation/media/dvb-drivers/faq.rst → Documentation/admin-guide/media/faq.rst b/Documentation/media/dvb-drivers/faq.rst → Documentation/admin-guide/media/faq.rst
diff --git a/Documentation/media/v4l-drivers/fimc.rst → Documentation/admin-guide/media/fimc.rst b/Documentation/media/v4l-drivers/fimc.rst → Documentation/admin-guide/media/fimc.rst
diff --git a/...tion/media/v4l-drivers/gspca-cardlist.rst → ...tion/admin-guide/media/gspca-cardlist.rst b/...tion/media/v4l-drivers/gspca-cardlist.rst → ...tion/admin-guide/media/gspca-cardlist.rst
diff --git a/Documentation/media/v4l-drivers/imx.rst → Documentation/admin-guide/media/imx.rst b/Documentation/media/v4l-drivers/imx.rst → Documentation/admin-guide/media/imx.rst
diff --git a/Documentation/media/v4l-drivers/imx7.rst → Documentation/admin-guide/media/imx7.rst b/Documentation/media/v4l-drivers/imx7.rst → Documentation/admin-guide/media/imx7.rst
diff --git a/Documentation/admin-guide/media/index.rst b/Documentation/admin-guide/media/index.rst
@@ -0,0 +1,104 @@
+.. SPDX-License-Identifier: GPL-2.0
+
+.. include:: <isonum.txt>
+
+**Copyright** |copy| 1999-2020 : LinuxTV Developers
+
+This documentation is free software; you can redistribute it and/or modify it
+under the terms of the GNU General Public License as published by the Free
+Software Foundation version 2 of the License.
+
+This program is distributed in the hope that it will be useful, but WITHOUT
+ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
+more details.
+
+For more details see the file COPYING in the source distribution of Linux.
+
+.. _uapi-v4l-drivers:
+
+################################################
+Video4Linux (V4L)  driver-specific documentation
+################################################
+
+.. only:: html
+
+    .. class:: toc-title
+
+        Table of Contents
+
+.. toctree::
+	:maxdepth: 5
+	:numbered:
+
+	cardlist
+
+	v4l-with-ir
+
+	bttv
+	cafe_ccic
+	cpia2
+	cx88
+	davinci-vpbe
+	fimc
+	imx
+	imx7
+	ipu3
+	ivtv
+	meye
+	omap3isp
+	omap4_camera
+	philips
+	qcom_camss
+	rcar-fdp1
+	saa7134
+	si470x
+	si4713
+	si476x
+	vimc
+	vivid
+
+##############################################
+Linux Digital TV driver-specific documentation
+##############################################
+
+.. only:: html
+
+    .. class:: toc-title
+
+        Table of Contents
+
+.. toctree::
+	:maxdepth: 5
+	:numbered:
+
+	intro
+
+	cards
+	ci
+	faq
+
+	avermedia
+	bt8xx
+	lmedm04
+	opera-firmware
+	technisat
+	ttusb-dec
+	udev
+	zr364xx
+
+#################################
+CEC driver-specific documentation
+#################################
+
+.. only:: html
+
+    .. class:: toc-title
+
+        Table of Contents
+
+.. toctree::
+	:maxdepth: 5
+	:numbered:
+
+	pulse8-cec
diff --git a/Documentation/media/dvb-drivers/intro.rst → Documentation/admin-guide/media/intro.rst b/Documentation/media/dvb-drivers/intro.rst → Documentation/admin-guide/media/intro.rst
diff --git a/Documentation/media/v4l-drivers/ipu3.rst → Documentation/admin-guide/media/ipu3.rst b/Documentation/media/v4l-drivers/ipu3.rst → Documentation/admin-guide/media/ipu3.rst
diff --git a/Documentation/media/v4l-drivers/ipu3_rcb.svg → Documentation/admin-guide/media/ipu3_rcb.svg b/Documentation/media/v4l-drivers/ipu3_rcb.svg → Documentation/admin-guide/media/ipu3_rcb.svg
diff --git a/...ation/media/v4l-drivers/ivtv-cardlist.rst → ...ation/admin-guide/media/ivtv-cardlist.rst b/...ation/media/v4l-drivers/ivtv-cardlist.rst → ...ation/admin-guide/media/ivtv-cardlist.rst
diff --git a/Documentation/media/v4l-drivers/ivtv.rst → Documentation/admin-guide/media/ivtv.rst b/Documentation/media/v4l-drivers/ivtv.rst → Documentation/admin-guide/media/ivtv.rst
diff --git a/Documentation/media/dvb-drivers/lmedm04.rst → Documentation/admin-guide/media/lmedm04.rst b/Documentation/media/dvb-drivers/lmedm04.rst → Documentation/admin-guide/media/lmedm04.rst
diff --git a/Documentation/media/v4l-drivers/meye.rst → Documentation/admin-guide/media/meye.rst b/Documentation/media/v4l-drivers/meye.rst → Documentation/admin-guide/media/meye.rst
diff --git a/Documentation/media/v4l-drivers/omap3isp.rst → Documentation/admin-guide/media/omap3isp.rst b/Documentation/media/v4l-drivers/omap3isp.rst → Documentation/admin-guide/media/omap3isp.rst
diff --git a/...tation/media/v4l-drivers/omap4_camera.rst → ...tation/admin-guide/media/omap4_camera.rst b/...tation/media/v4l-drivers/omap4_camera.rst → ...tation/admin-guide/media/omap4_camera.rst
diff --git a/...tion/media/dvb-drivers/opera-firmware.rst → ...tion/admin-guide/media/opera-firmware.rst b/...tion/media/dvb-drivers/opera-firmware.rst → ...tion/admin-guide/media/opera-firmware.rst
diff --git a/Documentation/media/v4l-drivers/philips.rst → Documentation/admin-guide/media/philips.rst b/Documentation/media/v4l-drivers/philips.rst → Documentation/admin-guide/media/philips.rst
diff --git a/...entation/media/cec-drivers/pulse8-cec.rst → ...entation/admin-guide/media/pulse8-cec.rst b/...entation/media/cec-drivers/pulse8-cec.rst → ...entation/admin-guide/media/pulse8-cec.rst
diff --git a/...entation/media/v4l-drivers/qcom_camss.rst → ...entation/admin-guide/media/qcom_camss.rst b/...entation/media/v4l-drivers/qcom_camss.rst → ...entation/admin-guide/media/qcom_camss.rst
diff --git a/...dia/v4l-drivers/qcom_camss_8x96_graph.dot → ...min-guide/media/qcom_camss_8x96_graph.dot b/...dia/v4l-drivers/qcom_camss_8x96_graph.dot → ...min-guide/media/qcom_camss_8x96_graph.dot
diff --git a/...on/media/v4l-drivers/qcom_camss_graph.dot → ...on/admin-guide/media/qcom_camss_graph.dot b/...on/media/v4l-drivers/qcom_camss_graph.dot → ...on/admin-guide/media/qcom_camss_graph.dot
diff --git a/...mentation/media/v4l-drivers/rcar-fdp1.rst → ...mentation/admin-guide/media/rcar-fdp1.rst b/...mentation/media/v4l-drivers/rcar-fdp1.rst → ...mentation/admin-guide/media/rcar-fdp1.rst
diff --git a/...on/media/v4l-drivers/saa7134-cardlist.rst → ...on/admin-guide/media/saa7134-cardlist.rst b/...on/media/v4l-drivers/saa7134-cardlist.rst → ...on/admin-guide/media/saa7134-cardlist.rst
diff --git a/Documentation/media/v4l-drivers/saa7134.rst → Documentation/admin-guide/media/saa7134.rst b/Documentation/media/v4l-drivers/saa7134.rst → Documentation/admin-guide/media/saa7134.rst
diff --git a/...on/media/v4l-drivers/saa7164-cardlist.rst → ...on/admin-guide/media/saa7164-cardlist.rst b/...on/media/v4l-drivers/saa7164-cardlist.rst → ...on/admin-guide/media/saa7164-cardlist.rst
diff --git a/Documentation/media/v4l-drivers/si470x.rst → Documentation/admin-guide/media/si470x.rst b/Documentation/media/v4l-drivers/si470x.rst → Documentation/admin-guide/media/si470x.rst
diff --git a/Documentation/media/v4l-drivers/si4713.rst → Documentation/admin-guide/media/si4713.rst b/Documentation/media/v4l-drivers/si4713.rst → Documentation/admin-guide/media/si4713.rst
diff --git a/Documentation/media/v4l-drivers/si476x.rst → Documentation/admin-guide/media/si476x.rst b/Documentation/media/v4l-drivers/si476x.rst → Documentation/admin-guide/media/si476x.rst
diff --git a/...mentation/media/dvb-drivers/technisat.rst → ...mentation/admin-guide/media/technisat.rst b/...mentation/media/dvb-drivers/technisat.rst → ...mentation/admin-guide/media/technisat.rst
diff --git a/...ion/media/v4l-drivers/tm6000-cardlist.rst → ...ion/admin-guide/media/tm6000-cardlist.rst b/...ion/media/v4l-drivers/tm6000-cardlist.rst → ...ion/admin-guide/media/tm6000-cardlist.rst
diff --git a/...mentation/media/dvb-drivers/ttusb-dec.rst → ...mentation/admin-guide/media/ttusb-dec.rst b/...mentation/media/dvb-drivers/ttusb-dec.rst → ...mentation/admin-guide/media/ttusb-dec.rst
diff --git a/...tion/media/v4l-drivers/tuner-cardlist.rst → ...tion/admin-guide/media/tuner-cardlist.rst b/...tion/media/v4l-drivers/tuner-cardlist.rst → ...tion/admin-guide/media/tuner-cardlist.rst
diff --git a/Documentation/media/dvb-drivers/udev.rst → Documentation/admin-guide/media/udev.rst b/Documentation/media/dvb-drivers/udev.rst → Documentation/admin-guide/media/udev.rst
diff --git a/.../media/v4l-drivers/usbvision-cardlist.rst → .../admin-guide/media/usbvision-cardlist.rst b/.../media/v4l-drivers/usbvision-cardlist.rst → .../admin-guide/media/usbvision-cardlist.rst
diff --git a/...ntation/media/v4l-drivers/v4l-with-ir.rst → ...ntation/admin-guide/media/v4l-with-ir.rst b/...ntation/media/v4l-drivers/v4l-with-ir.rst → ...ntation/admin-guide/media/v4l-with-ir.rst
diff --git a/Documentation/media/v4l-drivers/vimc.dot → Documentation/admin-guide/media/vimc.dot b/Documentation/media/v4l-drivers/vimc.dot → Documentation/admin-guide/media/vimc.dot
diff --git a/Documentation/media/v4l-drivers/vimc.rst → Documentation/admin-guide/media/vimc.rst b/Documentation/media/v4l-drivers/vimc.rst → Documentation/admin-guide/media/vimc.rst
diff --git a/Documentation/media/v4l-drivers/vivid.rst → Documentation/admin-guide/media/vivid.rst b/Documentation/media/v4l-drivers/vivid.rst → Documentation/admin-guide/media/vivid.rst
diff --git a/Documentation/media/v4l-drivers/zr364xx.rst → Documentation/admin-guide/media/zr364xx.rst b/Documentation/media/v4l-drivers/zr364xx.rst → Documentation/admin-guide/media/zr364xx.rst
diff --git a/Documentation/media/cec-drivers/index.rst b/Documentation/media/cec-drivers/index.rst
diff --git a/Documentation/media/dvb-drivers/index.rst b/Documentation/media/dvb-drivers/index.rst
@@ -29,17 +29,6 @@ For more details see the file COPYING in the source distribution of Linux.
 	:maxdepth: 5
 	:numbered:
 
-	intro
-	avermedia
-	bt8xx
-	cards
-	ci
 	dvb-usb
-	faq
-	lmedm04
-	opera-firmware
-	technisat
-	ttusb-dec
-	udev
 	frontends
 	contributors
diff --git a/Documentation/media/index.rst b/Documentation/media/index.rst
@@ -14,9 +14,9 @@ Linux Media Subsystem Documentation
 
    ../userspace-api/media/index
    ../driver-api/media/index
-   dvb-drivers/index
+
    v4l-drivers/index
-   cec-drivers/index
+   dvb-drivers/index
 
 .. only:: html and subproject
 

diff --git a/Documentation/media/v4l-drivers/index.rst b/Documentation/media/v4l-drivers/index.rst
@@ -31,38 +31,13 @@ For more details see the file COPYING in the source distribution of Linux.
 	:maxdepth: 5
 	:numbered:
 
-	v4l-with-ir
 	tuners
-	cardlist
-	bttv
-	cafe_ccic
-	cpia2
-	cx88
-	davinci-vpbe
-	fimc
-	imx
-	imx7
-	ipu3
-	ivtv
 	max2175
-	meye
-	omap3isp
-	omap4_camera
-	philips
 	pvrusb2
 	pxa_camera
-	qcom_camss
 	radiotrack
-	rcar-fdp1
-	saa7134
 	sh_mobile_ceu_camera
-	si470x
-	si4713
-	si476x
 	uvcvideo
-	vimc
-	vivid
-	zr364xx
 
 	bttv-devel
 	cpia2_devel

diff --git a/Documentation/translations/zh_CN/video4linux/omap3isp.txt b/Documentation/translations/zh_CN/video4linux/omap3isp.txt
@@ -1,4 +1,4 @@
-Chinese translated version of Documentation/media/v4l-drivers/omap3isp.rst
+Chinese translated version of Documentation/admin-guide/media/omap3isp.rst
 
 If you have any comment or update to the content, please contact the
 original document maintainer directly.  However, if you have a problem
@@ -11,7 +11,7 @@ Maintainer: Laurent Pinchart <[email protected]>
 	  David Cohen <[email protected]>
 Chinese maintainer: Fu Wei <[email protected]>
 ---------------------------------------------------------------------
-Documentation/media/v4l-drivers/omap3isp.rst 的中文翻译
+Documentation/admin-guide/media/omap3isp.rst 的中文翻译
 
 如果想评论或更新本文的内容，请直接联系原文档的维护者。如果你使用英文
 交流有困难的话，也可以向中文版维护者求助。如果本翻译更新不及时或者翻

diff --git a/Documentation/userspace-api/media/v4l/dev-sliced-vbi.rst b/Documentation/userspace-api/media/v4l/dev-sliced-vbi.rst
@@ -438,7 +438,7 @@ MPEG stream.
 *Historical context*: This format specification originates from a
 custom, embedded, sliced VBI data format used by the ``ivtv`` driver.
 This format has already been informally specified in the kernel sources
-in the file ``Documentation/media/v4l-drivers/cx2341x.rst`` . The
+in the file ``Documentation/media/v4l-drivers/cx2341x-uapi.rst`` . The
 maximum size of the payload and other aspects of this format are driven
 by the CX23415 MPEG decoder's capabilities and limitations with respect
 to extracting, decoding, and displaying sliced VBI data embedded within

diff --git a/Documentation/userspace-api/media/v4l/ext-ctrls-codec.rst b/Documentation/userspace-api/media/v4l/ext-ctrls-codec.rst
@@ -116,7 +116,7 @@ enum v4l2_mpeg_stream_vbi_fmt -
     * - ``V4L2_MPEG_STREAM_VBI_FMT_IVTV``
       - VBI in private packets, IVTV format (documented in the kernel
 	sources in the file
-	``Documentation/media/v4l-drivers/cx2341x.rst``)
+	``Documentation/media/v4l-drivers/cx2341x-uapi.rst``)
 
 
 

diff --git a/Documentation/userspace-api/media/v4l/ext-ctrls-image-process.rst b/Documentation/userspace-api/media/v4l/ext-ctrls-image-process.rst
@@ -53,7 +53,7 @@ Image Process Control IDs
 
 ``V4L2_CID_DEINTERLACING_MODE (menu)``
     The video deinterlacing mode (such as Bob, Weave, ...). The menu items are
-    driver specific and are documented in :ref:`v4l-drivers`.
+    driver specific and are documented in :ref:`uapi-v4l-drivers`.
 
 ``V4L2_CID_DIGITAL_GAIN (integer)``
     Digital gain is the value by which all colour components

diff --git a/Documentation/userspace-api/media/v4l/pixfmt-reserved.rst b/Documentation/userspace-api/media/v4l/pixfmt-reserved.rst
@@ -58,7 +58,7 @@ please make a proposal on the linux-media mailing list.
       - YUV 4:2:0 format used by the IVTV driver.
 
 	The format is documented in the kernel sources in the file
-	``Documentation/media/v4l-drivers/cx2341x.rst``
+	``Documentation/media/v4l-drivers/cx2341x-uapi.rst``
     * .. _V4L2-PIX-FMT-CPIA1:
 
       - ``V4L2_PIX_FMT_CPIA1``