Document additional environmental variables
diff mbox series

Message ID 20240605104217.59803-1-pablo.pita@gmail.com
State New
Headers show
Series
  • Document additional environmental variables
Related show

Commit Message

Pablo Pita June 5, 2024, 10:42 a.m. UTC 
---
 Documentation/environment_variables.rst | 10 ++++++++++
 1 file changed, 10 insertions(+)

Comments

Jacopo Mondi July 25, 2024, 8:46 a.m. UTC | #1 
Hi Pablo
  thanks for the patch and sorry for the delay. Don't be shy in
pinging us if delays like this happens again in future ;)

On Wed, Jun 05, 2024 at 12:42:17PM GMT, Pablo Pita wrote:

We usually require a commit message, even if the change is simple.
As a reference https://cbea.ms/git-commit/

Also you need to sign-off your change. Documentation/contributing.rst
provides more details

> ---
>  Documentation/environment_variables.rst | 10 ++++++++++
>  1 file changed, 10 insertions(+)
>
> diff --git a/Documentation/environment_variables.rst b/Documentation/environment_variables.rst
> index 4e9fbb27..7cc13e9f 100644
> --- a/Documentation/environment_variables.rst
> +++ b/Documentation/environment_variables.rst
> @@ -37,6 +37,11 @@ LIBCAMERA_IPA_MODULE_PATH
>
>     Example value: ``${HOME}/.libcamera/lib:/opt/libcamera/vendor/lib``
>
> +LIBCAMERA_IPA_PROXY_PATH
> +   Define custom full path for a proxy worker for a given executable name.
> +
> +   Example value: ``${HOME}/.libcamera/proxy/worker:/opt/libcamera/vendor/proxy/worker``
> +
>  LIBCAMERA_PIPELINES_MATCH_LIST
>     Define an ordered list of pipeline names to be used to match the media
>     devices in the system. The pipeline handler names used to populate the
> @@ -50,6 +55,11 @@ LIBCAMERA_RPI_CONFIG_FILE
>
>     Example value: ``/usr/local/share/libcamera/pipeline/rpi/vc4/minimal_mem.yaml``
>
> +LIBCAMERA_RPI_TUNING_FILE
> +   Define a custom JSON tuning file to use in the Raspberry Pi.
> +
> +   Example value: ``/usr/local/share/libcamera/ipa/rpi/vc4/custom_sensor.json``
> +

The path looks good to me
Reviewed-by: Jacopo Mondi <jacopo.mondi@ideasonboard.com>

>  Further details
>  ---------------
>
> --
> 2.43.0
>
Kieran Bingham July 25, 2024, 11:07 a.m. UTC | #2 
Quoting Jacopo Mondi (2024-07-25 09:46:54)
> Hi Pablo
>   thanks for the patch and sorry for the delay. Don't be shy in
> pinging us if delays like this happens again in future ;)
> 
> On Wed, Jun 05, 2024 at 12:42:17PM GMT, Pablo Pita wrote:
> 
> We usually require a commit message, even if the change is simple.
> As a reference https://cbea.ms/git-commit/
> 
> Also you need to sign-off your change. Documentation/contributing.rst
> provides more details

I'd recommend something simple like:

"""
Documentation: Document additional environment variables

The LIBCAMERA_IPA_PROXY_PATH and LIBCAMERA_RPI_TUNING_FILE environment
variables have been added without providing documentation.

Add a description of each and a corresponding example.
"""

If you can reply with your Signed-off-by: Your Name <your.email@address.com>
then we can update while applying.


> 
> > ---
> >  Documentation/environment_variables.rst | 10 ++++++++++
> >  1 file changed, 10 insertions(+)
> >
> > diff --git a/Documentation/environment_variables.rst b/Documentation/environment_variables.rst
> > index 4e9fbb27..7cc13e9f 100644
> > --- a/Documentation/environment_variables.rst
> > +++ b/Documentation/environment_variables.rst
> > @@ -37,6 +37,11 @@ LIBCAMERA_IPA_MODULE_PATH
> >
> >     Example value: ``${HOME}/.libcamera/lib:/opt/libcamera/vendor/lib``
> >
> > +LIBCAMERA_IPA_PROXY_PATH
> > +   Define custom full path for a proxy worker for a given executable name.
> > +
> > +   Example value: ``${HOME}/.libcamera/proxy/worker:/opt/libcamera/vendor/proxy/worker``
> > +
> >  LIBCAMERA_PIPELINES_MATCH_LIST
> >     Define an ordered list of pipeline names to be used to match the media
> >     devices in the system. The pipeline handler names used to populate the
> > @@ -50,6 +55,11 @@ LIBCAMERA_RPI_CONFIG_FILE
> >
> >     Example value: ``/usr/local/share/libcamera/pipeline/rpi/vc4/minimal_mem.yaml``
> >
> > +LIBCAMERA_RPI_TUNING_FILE
> > +   Define a custom JSON tuning file to use in the Raspberry Pi.
> > +
> > +   Example value: ``/usr/local/share/libcamera/ipa/rpi/vc4/custom_sensor.json``
> > +
> 
> The path looks good to me
> Reviewed-by: Jacopo Mondi <jacopo.mondi@ideasonboard.com>

Agreed, the patch should be fine, but we need that signoff to be able to
merge it.


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

> 
> >  Further details
> >  ---------------
> >
> > --
> > 2.43.0
> >

Patch
diff mbox series 

diff --git a/Documentation/environment_variables.rst b/Documentation/environment_variables.rst
index 4e9fbb27..7cc13e9f 100644
--- a/Documentation/environment_variables.rst
+++ b/Documentation/environment_variables.rst
@@ -37,6 +37,11 @@  LIBCAMERA_IPA_MODULE_PATH
 
    Example value: ``${HOME}/.libcamera/lib:/opt/libcamera/vendor/lib``
 
+LIBCAMERA_IPA_PROXY_PATH
+   Define custom full path for a proxy worker for a given executable name.
+   
+   Example value: ``${HOME}/.libcamera/proxy/worker:/opt/libcamera/vendor/proxy/worker``
+   
 LIBCAMERA_PIPELINES_MATCH_LIST
    Define an ordered list of pipeline names to be used to match the media
    devices in the system. The pipeline handler names used to populate the
@@ -50,6 +55,11 @@  LIBCAMERA_RPI_CONFIG_FILE
 
    Example value: ``/usr/local/share/libcamera/pipeline/rpi/vc4/minimal_mem.yaml``
 
+LIBCAMERA_RPI_TUNING_FILE
+   Define a custom JSON tuning file to use in the Raspberry Pi.
+
+   Example value: ``/usr/local/share/libcamera/ipa/rpi/vc4/custom_sensor.json``
+
 Further details
 ---------------