media: docs: split vimc.rst into devel and admin parts
authorMauro Carvalho Chehab <mchehab+huawei@kernel.org>
Wed, 4 Mar 2020 16:10:12 +0000 (17:10 +0100)
committerMauro Carvalho Chehab <mchehab+huawei@kernel.org>
Tue, 14 Apr 2020 08:29:06 +0000 (10:29 +0200)
The vimc driver has some kerneldoc markups, plus admin info.
Split it into two files.

Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
Documentation/media/v4l-drivers/index.rst
Documentation/media/v4l-drivers/vimc-devel.rst [new file with mode: 0644]
Documentation/media/v4l-drivers/vimc.rst

index 5a87bd1..2b8e2cb 100644 (file)
@@ -67,4 +67,6 @@ For more details see the file COPYING in the source distribution of Linux.
        zr364xx
 
        cpia2_devel
+       vimc-devel
+
        meye-uapi
diff --git a/Documentation/media/v4l-drivers/vimc-devel.rst b/Documentation/media/v4l-drivers/vimc-devel.rst
new file mode 100644 (file)
index 0000000..b2aa2ee
--- /dev/null
@@ -0,0 +1,15 @@
+.. SPDX-License-Identifier: GPL-2.0
+
+The Virtual Media Controller Driver (vimc)
+==========================================
+
+Source code documentation
+-------------------------
+
+vimc-streamer
+~~~~~~~~~~~~~
+
+.. kernel-doc:: drivers/media/platform/vimc/vimc-streamer.h
+   :internal:
+
+.. kernel-doc:: drivers/media/platform/vimc/vimc-streamer.c
index 8f5d7f8..211cc89 100644 (file)
@@ -88,14 +88,3 @@ Vimc has a module parameter to configure the driver.
         height, so the image size will be ``sca_mult^2`` bigger than the
         original one. Currently, only supports scaling up (the default value
         is 3).
-
-Source code documentation
--------------------------
-
-vimc-streamer
-~~~~~~~~~~~~~
-
-.. kernel-doc:: drivers/media/platform/vimc/vimc-streamer.h
-   :internal:
-
-.. kernel-doc:: drivers/media/platform/vimc/vimc-streamer.c