linux-doc.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Hans Verkuil <hverkuil@xs4all.nl>
To: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>,
	Linux Doc Mailing List <linux-doc@vger.kernel.org>
Cc: linux-kernel@vger.kernel.org, Jonathan Corbet <corbet@lwn.net>,
	linux-media@vger.kernel.org,
	Steve Longerbeam <slongerbeam@gmail.com>,
	Philipp Zabel <p.zabel@pengutronix.de>,
	Shawn Guo <shawnguo@kernel.org>,
	Sascha Hauer <s.hauer@pengutronix.de>,
	Pengutronix Kernel Team <kernel@pengutronix.de>,
	Fabio Estevam <festevam@gmail.com>,
	NXP Linux Team <linux-imx@nxp.com>,
	Rui Miguel Silva <rmfrfs@gmail.com>,
	Sakari Ailus <sakari.ailus@linux.intel.com>,
	Andy Walls <awalls@md.metrocast.net>,
	Todor Tomov <todor.too@gmail.com>,
	Antoine Jacquet <royale@zerezo.com>,
	Harry Wei <harryxiyou@gmail.com>,
	Alex Shi <alex.shi@linux.alibaba.com>,
	Malcolm Priestley <tvboxspy@gmail.com>,
	linux-arm-kernel@lists.infradead.org, linux-usb@vger.kernel.org
Subject: Re: [PATCH v2 19/22] media: docs: move user-facing docs to the admin guide
Date: Thu, 12 Mar 2020 08:25:09 +0100	[thread overview]
Message-ID: <ec753b2f-955d-fb8c-2cf6-9a26c30a57d0@xs4all.nl> (raw)
In-Reply-To: <05c08367b2c6a5b3f8f29499093d34b1f0d864fe.1583847557.git.mchehab+huawei@kernel.org>

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@kernel.org>
> ---
>  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

  reply	other threads:[~2020-03-12  7:25 UTC|newest]

Thread overview: 26+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2020-03-10 13:42 [PATCH v2 00/22] Move media documentation files Mauro Carvalho Chehab
2020-03-10 13:42 ` [PATCH v2 01/22] media: docs: avermedia.rst: mark a table as such Mauro Carvalho Chehab
2020-03-10 13:42 ` [PATCH v2 02/22] media: docs: move soc-camera.rst to staging Mauro Carvalho Chehab
2020-03-10 13:42 ` [PATCH v2 03/22] media: docs: split cpia2.rst on two files Mauro Carvalho Chehab
2020-03-12  7:18   ` Hans Verkuil
2020-03-10 13:42 ` [PATCH v2 04/22] media: docs: split ci.rst into uAPI and user guide docs Mauro Carvalho Chehab
2020-03-10 13:42 ` [PATCH v2 05/22] media: docs: split meye.rst into admin and uAPI docs Mauro Carvalho Chehab
2020-03-10 13:42 ` [PATCH v2 06/22] media: docs: split vimc.rst into devel and admin parts Mauro Carvalho Chehab
2020-03-10 13:42 ` [PATCH v2 07/22] media: docs: split development info from bttv.rst Mauro Carvalho Chehab
2020-03-10 13:42 ` [PATCH v2 08/22] media: docs: split development info from cx88.rst Mauro Carvalho Chehab
2020-03-10 13:43 ` [PATCH v2 09/22] media: docs: split cx2341x.rst into different audiences Mauro Carvalho Chehab
2020-03-10 13:43 ` [PATCH v2 10/22] media: docs: cx18-streams.c: fix broken references to docs Mauro Carvalho Chehab
2020-03-10 13:43 ` [PATCH v2 11/22] media: docs: split uAPI info from davinci-vpbe.rst Mauro Carvalho Chehab
2020-03-10 13:43 ` [PATCH v2 12/22] media: docs: split uAPI info from fimc.rst Mauro Carvalho Chehab
2020-03-10 13:43 ` [PATCH v2 13/22] media: docs: split uAPI info from saa7134-devel.rst Mauro Carvalho Chehab
2020-03-10 13:43 ` [PATCH v2 14/22] media: docs: split uAPI info from omap3isp.rst Mauro Carvalho Chehab
2020-03-10 13:43 ` [PATCH v2 15/22] media: docs: split uAPI info from imx.rst Mauro Carvalho Chehab
2020-03-10 13:43 ` [PATCH v2 17/22] media: docs: kAPI docs: move them to driver-api Mauro Carvalho Chehab
2020-03-10 13:43 ` [PATCH v2 18/22] media: docs: move fourcc file to the uAPI document Mauro Carvalho Chehab
2020-03-10 13:43 ` [PATCH v2 19/22] media: docs: move user-facing docs to the admin guide Mauro Carvalho Chehab
2020-03-12  7:25   ` Hans Verkuil [this message]
2020-03-10 13:43 ` [PATCH v2 20/22] media: docs: move driver-specific info to driver-api Mauro Carvalho Chehab
2020-03-12  7:26   ` Hans Verkuil
2020-03-10 13:43 ` [PATCH v2 21/22] media: docs: add an uAPI chapter for driver-specific stuff Mauro Carvalho Chehab
2020-03-12  7:31   ` Hans Verkuil
2020-03-10 13:43 ` [PATCH v2 22/22] media: docs: get rid of Documentation/media/ Mauro Carvalho Chehab

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=ec753b2f-955d-fb8c-2cf6-9a26c30a57d0@xs4all.nl \
    --to=hverkuil@xs4all.nl \
    --cc=alex.shi@linux.alibaba.com \
    --cc=awalls@md.metrocast.net \
    --cc=corbet@lwn.net \
    --cc=festevam@gmail.com \
    --cc=harryxiyou@gmail.com \
    --cc=kernel@pengutronix.de \
    --cc=linux-arm-kernel@lists.infradead.org \
    --cc=linux-doc@vger.kernel.org \
    --cc=linux-imx@nxp.com \
    --cc=linux-kernel@vger.kernel.org \
    --cc=linux-media@vger.kernel.org \
    --cc=linux-usb@vger.kernel.org \
    --cc=mchehab+huawei@kernel.org \
    --cc=p.zabel@pengutronix.de \
    --cc=rmfrfs@gmail.com \
    --cc=royale@zerezo.com \
    --cc=s.hauer@pengutronix.de \
    --cc=sakari.ailus@linux.intel.com \
    --cc=shawnguo@kernel.org \
    --cc=slongerbeam@gmail.com \
    --cc=todor.too@gmail.com \
    --cc=tvboxspy@gmail.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).