[libcamera-devel] README: Document GST_DEBUG values to debug libcamerasrc

14073 diff mbox series

Problems with libcamerasrc are reported quite frequently. To help users
diagnosing them, document how to obtain libcamerasrc debug messages
through GST_DEBUG.

Signed-off-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com>
---
GStreamer-related documentation should eventually be moved to
Documentation/.
---
 README.rst | 5 +++++
 1 file changed, 5 insertions(+)


base-commit: 962df634bd0afe12e6f38464f5e602cf1460c430
prerequisite-patch-id: 6ad689b8c9be17165b330a16c7cef62dbdfb5d8f

Hi Laurent

On Sun, Oct 10, 2021 at 06:31:57PM +0300, Laurent Pinchart wrote:
> Problems with libcamerasrc are reported quite frequently. To help users
> diagnosing them, document how to obtain libcamerasrc debug messages
> through GST_DEBUG.
>
> Signed-off-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com>
> ---
> GStreamer-related documentation should eventually be moved to
> Documentation/.

Feels a bit out of place here, but that's where gst documentation is
already.

Reviewed-by: Jacopo Mondi <jacopo@jmondi.org>

Thanks
  j

> ---
>  README.rst | 5 +++++
>  1 file changed, 5 insertions(+)
>
> diff --git a/README.rst b/README.rst
> index 341ecd926da4..ddee5538d7b9 100644
> --- a/README.rst
> +++ b/README.rst
> @@ -124,6 +124,11 @@ if desired with a pipeline such as:
>    gst-launch-1.0 libcamerasrc ! 'video/x-raw,width=1280,height=720' ! \
>          glimagesink
>
> +The libcamerasrc element has two log categories, named libcamera-provider (for
> +the video device provider) and libcamerasrc (for the operation of the camera).
> +All corresponding debug messages can be enabled by setting the ``GST_DEBUG``
> +environment variable to ``libcamera*:7``.
> +
>  .. section-end-getting-started
>
>  Troubleshooting
>
> base-commit: 962df634bd0afe12e6f38464f5e602cf1460c430
> prerequisite-patch-id: 6ad689b8c9be17165b330a16c7cef62dbdfb5d8f
> --
> Regards,
>
> Laurent Pinchart
>

Quoting Jacopo Mondi (2021-10-11 12:57:29)
> Hi Laurent
> 
> On Sun, Oct 10, 2021 at 06:31:57PM +0300, Laurent Pinchart wrote:
> > Problems with libcamerasrc are reported quite frequently. To help users
> > diagnosing them, document how to obtain libcamerasrc debug messages
> > through GST_DEBUG.
> >
> > Signed-off-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com>
> > ---
> > GStreamer-related documentation should eventually be moved to
> > Documentation/.
> 
> Feels a bit out of place here, but that's where gst documentation is
> already.

Agreed I think, but here is fine for now I think. We don't have anywhere
else particularly more appropriate right now.

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

> 
> Reviewed-by: Jacopo Mondi <jacopo@jmondi.org>
> 
> Thanks
>   j
> 
> > ---
> >  README.rst | 5 +++++
> >  1 file changed, 5 insertions(+)
> >
> > diff --git a/README.rst b/README.rst
> > index 341ecd926da4..ddee5538d7b9 100644
> > --- a/README.rst
> > +++ b/README.rst
> > @@ -124,6 +124,11 @@ if desired with a pipeline such as:
> >    gst-launch-1.0 libcamerasrc ! 'video/x-raw,width=1280,height=720' ! \
> >          glimagesink
> >
> > +The libcamerasrc element has two log categories, named libcamera-provider (for
> > +the video device provider) and libcamerasrc (for the operation of the camera).
> > +All corresponding debug messages can be enabled by setting the ``GST_DEBUG``
> > +environment variable to ``libcamera*:7``.
> > +
> >  .. section-end-getting-started
> >
> >  Troubleshooting
> >
> > base-commit: 962df634bd0afe12e6f38464f5e602cf1460c430
> > prerequisite-patch-id: 6ad689b8c9be17165b330a16c7cef62dbdfb5d8f
> > --
> > Regards,
> >
> > Laurent Pinchart
> >