[libcamera-devel,4/6] docs: Markup LD_PRELOAD as code

Message ID 20200604134300.2986113-5-marvin.schmidt1987@gmail.com
State Superseded
Headers show
Series
  • Random documentation fixes
Related show

Commit Message

Marvin Schmidt June 4, 2020, 1:42 p.m. UTC
---
 Documentation/docs.rst | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

Comments

Kieran Bingham June 4, 2020, 1:51 p.m. UTC | #1
Hi Marvin,

Is this just to cause syntax highlighting on that term?

No objections though, but in this instance a 'why' might be useful in
the commit message...

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

On 04/06/2020 14:42, Marvin Schmidt wrote:
> ---
>  Documentation/docs.rst | 4 ++--
>  1 file changed, 2 insertions(+), 2 deletions(-)
> 
> diff --git a/Documentation/docs.rst b/Documentation/docs.rst
> index 873d8cd..f4c6ec5 100644
> --- a/Documentation/docs.rst
> +++ b/Documentation/docs.rst
> @@ -148,7 +148,7 @@ V4L2 Compatibility Layer
>  
>  The project shall support traditional V4L2 application through an additional
>  libcamera wrapper library. The wrapper library shall trap all accesses to
> -camera devices through LD_PRELOAD, and route them through libcamera to
> +camera devices through `LD_PRELOAD`, and route them through libcamera to
>  emulate a high-level V4L2 camera device. It shall expose camera device
>  features on a best-effort basis, and aim for the level of features
>  traditionally available from a UVC camera designed for video conferencing.
> @@ -380,7 +380,7 @@ V4L2 Compatibility Layer
>  V4L2 compatibility is achieved through a shared library that traps all
>  accesses to camera devices and routes them to libcamera to emulate high-level
>  V4L2 camera devices. It is injected in a process address space through
> -LD_PRELOAD and is completely transparent for applications.
> +`LD_PRELOAD` and is completely transparent for applications.
>  
>  The compatibility layer exposes camera device features on a best-effort basis,
>  and aims for the level of features traditionally available from a UVC camera
>

Patch

diff --git a/Documentation/docs.rst b/Documentation/docs.rst
index 873d8cd..f4c6ec5 100644
--- a/Documentation/docs.rst
+++ b/Documentation/docs.rst
@@ -148,7 +148,7 @@  V4L2 Compatibility Layer
 
 The project shall support traditional V4L2 application through an additional
 libcamera wrapper library. The wrapper library shall trap all accesses to
-camera devices through LD_PRELOAD, and route them through libcamera to
+camera devices through `LD_PRELOAD`, and route them through libcamera to
 emulate a high-level V4L2 camera device. It shall expose camera device
 features on a best-effort basis, and aim for the level of features
 traditionally available from a UVC camera designed for video conferencing.
@@ -380,7 +380,7 @@  V4L2 Compatibility Layer
 V4L2 compatibility is achieved through a shared library that traps all
 accesses to camera devices and routes them to libcamera to emulate high-level
 V4L2 camera devices. It is injected in a process address space through
-LD_PRELOAD and is completely transparent for applications.
+`LD_PRELOAD` and is completely transparent for applications.
 
 The compatibility layer exposes camera device features on a best-effort basis,
 and aims for the level of features traditionally available from a UVC camera