Re: [PATCH v2 19/22] media: docs: move user-facing docs to the admin guide
From: Hans Verkuil
Date: Thu Mar 12 2020 - 03:25:24 EST
On 3/10/20 2:43 PM, Mauro Carvalho Chehab wrote:
> 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 <mchehab+huawei@xxxxxxxxxx>
> ---
> Documentation/admin-guide/index.rst | 1 +
> .../admin-guide/kernel-parameters.txt | 4 +-
> .../media}/au0828-cardlist.rst | 0
> .../media}/avermedia.rst | 0
> .../media}/bt8xx.rst | 8 +-
> .../media}/bttv-cardlist.rst | 0
> .../media}/bttv.rst | 0
> .../media}/cafe_ccic.rst | 0
> .../media}/cardlist.rst | 0
> .../media}/cards.rst | 0
> .../dvb-drivers => admin-guide/media}/ci.rst | 0
> .../media}/cpia2.rst | 0
> .../media}/cx23885-cardlist.rst | 0
> .../media}/cx88-cardlist.rst | 0
> .../media}/cx88.rst | 0
> .../media}/davinci-vpbe.rst | 0
> .../media}/em28xx-cardlist.rst | 0
> .../dvb-drivers => admin-guide/media}/faq.rst | 0
> .../media}/fimc.rst | 0
> .../media}/gspca-cardlist.rst | 0
> .../v4l-drivers => admin-guide/media}/imx.rst | 0
> .../media}/imx7.rst | 0
> Documentation/admin-guide/media/index.rst | 104 ++++++++++++++++++
> .../media}/intro.rst | 0
> .../media}/ipu3.rst | 0
> .../media}/ipu3_rcb.svg | 0
> .../media}/ivtv-cardlist.rst | 0
> .../media}/ivtv.rst | 0
> .../media}/lmedm04.rst | 0
> .../media}/meye.rst | 0
> .../media}/omap3isp.rst | 0
> .../media}/omap4_camera.rst | 0
> .../media}/opera-firmware.rst | 0
> .../media}/philips.rst | 0
> .../media}/pulse8-cec.rst | 0
> .../media}/qcom_camss.rst | 0
> .../media}/qcom_camss_8x96_graph.dot | 0
> .../media}/qcom_camss_graph.dot | 0
> .../media}/rcar-fdp1.rst | 0
> .../media}/saa7134-cardlist.rst | 0
> .../media}/saa7134.rst | 0
> .../media}/saa7164-cardlist.rst | 0
> .../media}/si470x.rst | 0
> .../media}/si4713.rst | 0
> .../media}/si476x.rst | 0
> .../media}/technisat.rst | 0
> .../media}/tm6000-cardlist.rst | 0
> .../media}/ttusb-dec.rst | 0
> .../media}/tuner-cardlist.rst | 0
> .../media}/udev.rst | 0
> .../media}/usbvision-cardlist.rst | 0
> .../media}/v4l-with-ir.rst | 0
> .../media}/vimc.dot | 0
> .../media}/vimc.rst | 0
> .../media}/vivid.rst | 0
> .../media}/zr364xx.rst | 0
> Documentation/media/cec-drivers/index.rst | 34 ------
> Documentation/media/dvb-drivers/index.rst | 11 --
> Documentation/media/index.rst | 4 +-
> Documentation/media/v4l-drivers/index.rst | 25 -----
> .../zh_CN/video4linux/omap3isp.txt | 4 +-
> .../media/v4l/dev-sliced-vbi.rst | 2 +-
> .../media/v4l/ext-ctrls-codec.rst | 2 +-
> .../media/v4l/ext-ctrls-image-process.rst | 2 +-
> .../media/v4l/pixfmt-reserved.rst | 2 +-
> MAINTAINERS | 22 ++--
> drivers/media/pci/bt8xx/Kconfig | 2 +-
> drivers/media/pci/meye/Kconfig | 2 +-
> drivers/media/radio/si470x/Kconfig | 2 +-
> drivers/media/usb/dvb-usb-v2/lmedm04.c | 2 +-
> drivers/media/usb/gspca/Kconfig | 2 +-
> drivers/media/usb/zr364xx/Kconfig | 2 +-
> 72 files changed, 136 insertions(+), 101 deletions(-)
> rename Documentation/{media/v4l-drivers => admin-guide/media}/au0828-cardlist.rst (100%)
> rename Documentation/{media/dvb-drivers => admin-guide/media}/avermedia.rst (100%)
> rename Documentation/{media/dvb-drivers => admin-guide/media}/bt8xx.rst (93%)
I would personally prefer to keep the split between v4l and dvb drivers, rather
then putting them all in the same directory.
What was the reason behind this choice?
Regards,
Hans