[libcamera-devel,1/2] README.rst: Use code directive for all code examples
diff mbox series

Message ID 20231128115258.13777-1-laurent.pinchart@ideasonboard.com
State Accepted
Commit 74c5db6fd412a414ea3c38bbb5436849d4bd8d34
Headers show
Series
  • [libcamera-devel,1/2] README.rst: Use code directive for all code examples
Related show

Commit Message

Laurent Pinchart Nov. 28, 2023, 11:52 a.m. UTC
Most of the code examples in README.rst use the code directive, but some
use literal blocks or just quoted paragraphs. Use the code directive for
all code for consistency.

Signed-off-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com>
---
 README.rst | 4 +++-
 1 file changed, 3 insertions(+), 1 deletion(-)


base-commit: e25003e78b13b7db5d24a1082294d9596c735fd6

Comments

Kieran Bingham Nov. 28, 2023, 11:59 a.m. UTC | #1
Quoting Laurent Pinchart via libcamera-devel (2023-11-28 11:52:57)
> Most of the code examples in README.rst use the code directive, but some
> use literal blocks or just quoted paragraphs. Use the code directive for
> all code for consistency.
> 
> Signed-off-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com>


Reviewed-by: Kieran Bingham <kieran.bingham@ideasonboard.com>

> ---
>  README.rst | 4 +++-
>  1 file changed, 3 insertions(+), 1 deletion(-)
> 
> diff --git a/README.rst b/README.rst
> index 6eed72389a86..4a6eb2525f6b 100644
> --- a/README.rst
> +++ b/README.rst
> @@ -30,7 +30,7 @@ Getting Started
>  
>  To fetch the sources, build and install:
>  
> -::
> +.. code::
>  
>    git clone https://git.libcamera.org/libcamera/libcamera.git
>    cd libcamera
> @@ -120,6 +120,8 @@ Using GStreamer plugin
>  To use GStreamer plugin from source tree, set the following environment so that
>  GStreamer can find it. This isn't necessary when libcamera is installed.
>  
> +.. code::
> +
>    export GST_PLUGIN_PATH=$(pwd)/build/src/gstreamer
>  
>  The debugging tool ``gst-launch-1.0`` can be used to construct a pipeline and
> 
> base-commit: e25003e78b13b7db5d24a1082294d9596c735fd6
> -- 
> Regards,
> 
> Laurent Pinchart
>

Patch
diff mbox series

diff --git a/README.rst b/README.rst
index 6eed72389a86..4a6eb2525f6b 100644
--- a/README.rst
+++ b/README.rst
@@ -30,7 +30,7 @@  Getting Started
 
 To fetch the sources, build and install:
 
-::
+.. code::
 
   git clone https://git.libcamera.org/libcamera/libcamera.git
   cd libcamera
@@ -120,6 +120,8 @@  Using GStreamer plugin
 To use GStreamer plugin from source tree, set the following environment so that
 GStreamer can find it. This isn't necessary when libcamera is installed.
 
+.. code::
+
   export GST_PLUGIN_PATH=$(pwd)/build/src/gstreamer
 
 The debugging tool ``gst-launch-1.0`` can be used to construct a pipeline and