[libcamera-devel,3/5] Documentation: sensor-driver: Fix links to V4L2 documentation
diff mbox series

Message ID 20210317192831.359014-4-nfraprado@collabora.com
State Accepted
Headers show
Series
  • Minor improvements to the documentation
Related show

Commit Message

Nícolas F. R. A. Prado March 17, 2021, 7:28 p.m. UTC
Fix some links to the V4L2 documentation. The first one is indeed
pointing to the wrong page. The second one has a highlight embedded, so
not necessarily wrong, but not needed, so clean it up as well.

Signed-off-by: Nícolas F. R. A. Prado <nfraprado@collabora.com>
---
 Documentation/sensor_driver_requirements.rst | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

Comments

Sebastian Fricke March 18, 2021, 5:30 a.m. UTC | #1
Hello Nícolas,

Thank you for the patch.

Reviewed-by: Sebastian Fricke <sebastian.fricke@posteo.net>

On 17.03.2021 16:28, Nícolas F. R. A. Prado wrote:
>Fix some links to the V4L2 documentation. The first one is indeed
>pointing to the wrong page. The second one has a highlight embedded, so
>not necessarily wrong, but not needed, so clean it up as well.
>
>Signed-off-by: Nícolas F. R. A. Prado <nfraprado@collabora.com>
>---
> Documentation/sensor_driver_requirements.rst | 4 ++--
> 1 file changed, 2 insertions(+), 2 deletions(-)
>
>diff --git a/Documentation/sensor_driver_requirements.rst b/Documentation/sensor_driver_requirements.rst
>index 3e800c8e9c13..b0854be3328a 100644
>--- a/Documentation/sensor_driver_requirements.rst
>+++ b/Documentation/sensor_driver_requirements.rst
>@@ -51,7 +51,7 @@ The sensor driver should support the following V4L2 controls:
> * `V4L2_CID_CAMERA_SENSOR_ROTATION`_
>
> .. _V4L2_CID_CAMERA_ORIENTATION: https://www.kernel.org/doc/html/latest/userspace-api/media/v4l/ext-ctrls-camera.html
>-.. _V4L2_CID_CAMERA_SENSOR_ROTATION: https://www.kernel.org/doc/html/latest/userspace-api/media/v4l/ext-ctrls-image-process.html
>+.. _V4L2_CID_CAMERA_SENSOR_ROTATION: https://www.kernel.org/doc/html/latest/userspace-api/media/v4l/ext-ctrls-camera.html

Sadly, the link doesn't jump immediatly to the term and you first
have to scroll all the way down :/.
But for that to change we would first have to add sub-links into the
kernel documentation.

>
> The controls are used to register the camera location and rotation.
>
>@@ -60,7 +60,7 @@ specifically it should implement support for the
> `VIDIOC_SUBDEV_G_SELECTION`_ ioctl with support for the following selection
> targets:
>
>-.. _VIDIOC_SUBDEV_G_SELECTION: https://www.kernel.org/doc/html/latest/userspace-api/media/v4l/vidioc-subdev-g-selection.html?highlight=g_selection#c.V4L.VIDIOC_SUBDEV_G_SELECTION
>+.. _VIDIOC_SUBDEV_G_SELECTION: https://www.kernel.org/doc/html/latest/userspace-api/media/v4l/vidioc-subdev-g-selection.html#c.V4L.VIDIOC_SUBDEV_G_SELECTION
>
> * `V4L2_SEL_TGT_CROP_BOUNDS`_ to report the readable pixel array area size
> * `V4L2_SEL_TGT_CROP_DEFAULT`_ to report the active pixel array area size
>-- 
>2.30.2
>
>_______________________________________________
>libcamera-devel mailing list
>libcamera-devel@lists.libcamera.org
>https://lists.libcamera.org/listinfo/libcamera-devel
Laurent Pinchart March 18, 2021, 11:57 p.m. UTC | #2
Hi Nicolas,

Thank you for the patch.

On Wed, Mar 17, 2021 at 04:28:29PM -0300, Nícolas F. R. A. Prado wrote:
> Fix some links to the V4L2 documentation. The first one is indeed
> pointing to the wrong page. The second one has a highlight embedded, so
> not necessarily wrong, but not needed, so clean it up as well.
> 
> Signed-off-by: Nícolas F. R. A. Prado <nfraprado@collabora.com>

Reviewed-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com>

> ---
>  Documentation/sensor_driver_requirements.rst | 4 ++--
>  1 file changed, 2 insertions(+), 2 deletions(-)
> 
> diff --git a/Documentation/sensor_driver_requirements.rst b/Documentation/sensor_driver_requirements.rst
> index 3e800c8e9c13..b0854be3328a 100644
> --- a/Documentation/sensor_driver_requirements.rst
> +++ b/Documentation/sensor_driver_requirements.rst
> @@ -51,7 +51,7 @@ The sensor driver should support the following V4L2 controls:
>  * `V4L2_CID_CAMERA_SENSOR_ROTATION`_
>  
>  .. _V4L2_CID_CAMERA_ORIENTATION: https://www.kernel.org/doc/html/latest/userspace-api/media/v4l/ext-ctrls-camera.html
> -.. _V4L2_CID_CAMERA_SENSOR_ROTATION: https://www.kernel.org/doc/html/latest/userspace-api/media/v4l/ext-ctrls-image-process.html
> +.. _V4L2_CID_CAMERA_SENSOR_ROTATION: https://www.kernel.org/doc/html/latest/userspace-api/media/v4l/ext-ctrls-camera.html
>  
>  The controls are used to register the camera location and rotation.
>  
> @@ -60,7 +60,7 @@ specifically it should implement support for the
>  `VIDIOC_SUBDEV_G_SELECTION`_ ioctl with support for the following selection
>  targets:
>  
> -.. _VIDIOC_SUBDEV_G_SELECTION: https://www.kernel.org/doc/html/latest/userspace-api/media/v4l/vidioc-subdev-g-selection.html?highlight=g_selection#c.V4L.VIDIOC_SUBDEV_G_SELECTION
> +.. _VIDIOC_SUBDEV_G_SELECTION: https://www.kernel.org/doc/html/latest/userspace-api/media/v4l/vidioc-subdev-g-selection.html#c.V4L.VIDIOC_SUBDEV_G_SELECTION
>  
>  * `V4L2_SEL_TGT_CROP_BOUNDS`_ to report the readable pixel array area size
>  * `V4L2_SEL_TGT_CROP_DEFAULT`_ to report the active pixel array area size

Patch
diff mbox series

diff --git a/Documentation/sensor_driver_requirements.rst b/Documentation/sensor_driver_requirements.rst
index 3e800c8e9c13..b0854be3328a 100644
--- a/Documentation/sensor_driver_requirements.rst
+++ b/Documentation/sensor_driver_requirements.rst
@@ -51,7 +51,7 @@  The sensor driver should support the following V4L2 controls:
 * `V4L2_CID_CAMERA_SENSOR_ROTATION`_
 
 .. _V4L2_CID_CAMERA_ORIENTATION: https://www.kernel.org/doc/html/latest/userspace-api/media/v4l/ext-ctrls-camera.html
-.. _V4L2_CID_CAMERA_SENSOR_ROTATION: https://www.kernel.org/doc/html/latest/userspace-api/media/v4l/ext-ctrls-image-process.html
+.. _V4L2_CID_CAMERA_SENSOR_ROTATION: https://www.kernel.org/doc/html/latest/userspace-api/media/v4l/ext-ctrls-camera.html
 
 The controls are used to register the camera location and rotation.
 
@@ -60,7 +60,7 @@  specifically it should implement support for the
 `VIDIOC_SUBDEV_G_SELECTION`_ ioctl with support for the following selection
 targets:
 
-.. _VIDIOC_SUBDEV_G_SELECTION: https://www.kernel.org/doc/html/latest/userspace-api/media/v4l/vidioc-subdev-g-selection.html?highlight=g_selection#c.V4L.VIDIOC_SUBDEV_G_SELECTION
+.. _VIDIOC_SUBDEV_G_SELECTION: https://www.kernel.org/doc/html/latest/userspace-api/media/v4l/vidioc-subdev-g-selection.html#c.V4L.VIDIOC_SUBDEV_G_SELECTION
 
 * `V4L2_SEL_TGT_CROP_BOUNDS`_ to report the readable pixel array area size
 * `V4L2_SEL_TGT_CROP_DEFAULT`_ to report the active pixel array area size