]> git.karo-electronics.de Git - karo-tx-linux.git/commitdiff
doc-rst: linux_tv: use Example x.y. instead of a single number
authorMauro Carvalho Chehab <mchehab@s-opensource.com>
Sun, 3 Jul 2016 14:24:58 +0000 (11:24 -0300)
committerMauro Carvalho Chehab <mchehab@s-opensource.com>
Sun, 3 Jul 2016 14:24:58 +0000 (11:24 -0300)
On the example captions, use always <chapter>.<number>., because:
1) it matches the DocBook;
2) it would mean less changes if we need to add a new example,
as only one chapter will be affected.

Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
Documentation/linux_tv/media/v4l/audio.rst
Documentation/linux_tv/media/v4l/control.rst
Documentation/linux_tv/media/v4l/crop.rst
Documentation/linux_tv/media/v4l/standard.rst
Documentation/linux_tv/media/v4l/video.rst

index e9d99f6a259a6ea0550d13233dff1bbfa841247f..bc2db0d8f389a1096679522a5c763098d3fe89a7 100644 (file)
@@ -55,7 +55,7 @@ the :ref:`VIDIOC_QUERYCAP` ioctl.
 
 
 .. code-block:: c
-    :caption: Example 3: Information about the current audio input
+    :caption: Example 1.3. Information about the current audio input
 
     struct v4l2_audio audio;
 
@@ -70,7 +70,7 @@ the :ref:`VIDIOC_QUERYCAP` ioctl.
 
 
 .. code-block:: c
-    :caption: Example 4: Switching to the first audio input
+    :caption: Example 1.4. Switching to the first audio input
 
     struct v4l2_audio audio;
 
index 736d7908022946cc7758da27ef7d00b2ffb53332..4f64f1db6ec8ce423d01a491ec03268775adcf8d 100644 (file)
@@ -374,7 +374,7 @@ more menu type controls.
 .. _enum_all_controls:
 
 .. code-block:: c
-    :caption: Example 8: Enumerating all user controls
+    :caption: Example 1.8. Enumerating all user controls
 
 
     struct v4l2_queryctrl queryctrl;
@@ -439,7 +439,7 @@ more menu type controls.
 
 
 .. code-block:: c
-    :caption: Example 9: Enumerating all user controls (alternative)
+    :caption: Example 1.9. Enumerating all user controls (alternative)
 
     memset(&queryctrl, 0, sizeof(queryctrl));
 
@@ -464,7 +464,7 @@ more menu type controls.
 
 
 .. code-block:: c
-    :caption: Example 10: Changing controls
+    :caption: Example 1.10. Changing controls
 
     struct v4l2_queryctrl queryctrl;
     struct v4l2_control control;
index e1214d85b9c7caa5b34643e8b6b2dd940214d460..16d0983ff9fbc07453fef77a79c51fbd9e893041 100644 (file)
@@ -148,7 +148,7 @@ ensure the parameters are suitable before starting I/O.
 change ``V4L2_BUF_TYPE_VIDEO_CAPTURE`` for other types of device.
 
 .. code-block:: c
-    :caption: Example 11: Resetting the cropping parameters
+    :caption: Example 1.11. Resetting the cropping parameters
 
     struct v4l2_cropcap cropcap;
     struct v4l2_crop crop;
@@ -174,7 +174,7 @@ change ``V4L2_BUF_TYPE_VIDEO_CAPTURE`` for other types of device.
     }
 
 .. code-block:: c
-    :caption: Example 12: Simple downscaling
+    :caption: Example 1.12. Simple downscaling
 
     struct v4l2_cropcap cropcap;
     struct v4l2_format format;
@@ -202,7 +202,7 @@ change ``V4L2_BUF_TYPE_VIDEO_CAPTURE`` for other types of device.
 **NOTE:** This example assumes an output device.
 
 .. code-block:: c
-    :caption: Example 13. Selecting an output area
+    :caption: Example 1.13. Selecting an output area
 
     struct v4l2_cropcap cropcap;
     struct v4l2_crop crop;
@@ -239,7 +239,7 @@ change ``V4L2_BUF_TYPE_VIDEO_CAPTURE`` for other types of device.
 **NOTE:** This example assumes a video capture device.
 
 .. code-block:: c
-    :caption: Example 14: Current scaling factor and pixel aspect
+    :caption: Example 1.14. Current scaling factor and pixel aspect
 
     struct v4l2_cropcap cropcap;
     struct v4l2_crop crop;
index 11d1a7183c73f887492912699e52ecb4c65e251c..4131ca8802685418848e14702d600e5b527f09ea 100644 (file)
@@ -66,7 +66,7 @@ standard ioctls can be used with the given input or output.
 
 
 .. code-block:: c
-    :caption: Example 5: Information about the current video standard
+    :caption: Example 1.5. Information about the current video standard
 
     v4l2_std_id std_id;
     struct v4l2_standard standard;
@@ -102,7 +102,7 @@ standard ioctls can be used with the given input or output.
 
 
 .. code-block:: c
-    :caption: Example 6: Listing the video standards supported by the current input
+    :caption: Example 1.6. Listing the video standards supported by the current input
 
     struct v4l2_input input;
     struct v4l2_standard standard;
@@ -141,7 +141,7 @@ standard ioctls can be used with the given input or output.
 
 
 .. code-block:: c
-    :caption: Example 7: Selecting a new video standard
+    :caption: Example 1.7. Selecting a new video standard
 
     struct v4l2_input input;
     v4l2_std_id std_id;
index 8e10ecc2712385a39a302691de3febf932288e41..b8ecc774719c707bbd47c7ba65e48091b6fbb1a3 100644 (file)
@@ -29,7 +29,7 @@ implement all the input ioctls when the device has one or more inputs,
 all the output ioctls when the device has one or more outputs.
 
 .. code-block:: c
-    :caption: Example 1: Information about the current video input
+    :caption: Example 1.1. Information about the current video input
 
     struct v4l2_input input;
     int index;
@@ -51,7 +51,7 @@ all the output ioctls when the device has one or more outputs.
 
 
 .. code-block:: c
-    :caption: Example 2: Switching to the first video input
+    :caption: Example 1.2. Switching to the first video input
 
     int index;