[libcamera-devel] README: Add documentation package
diff mbox series

Message ID 20210928133407.526695-1-kieran.bingham@ideasonboard.com
State Accepted
Commit ccec150589a177654b9039d21163c36ccff85cff
Headers show
Series
  • [libcamera-devel] README: Add documentation package
Related show

Commit Message

Kieran Bingham Sept. 28, 2021, 1:34 p.m. UTC
When building the documentaion with Doxygen, an error will be
reported if latex can not find the extra packages provided by
texlive-latex-extra.

While this package is optional, document this requirement for
Documentation.

Signed-off-by: Kieran Bingham <kieran.bingham@ideasonboard.com>
---
 README.rst | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

Comments

Paul Elder Sept. 29, 2021, 2:12 a.m. UTC | #1
Hi Kieran,

On Tue, Sep 28, 2021 at 02:34:07PM +0100, Kieran Bingham wrote:
> When building the documentaion with Doxygen, an error will be
> reported if latex can not find the extra packages provided by
> texlive-latex-extra.
> 
> While this package is optional, document this requirement for
> Documentation.
> 
> Signed-off-by: Kieran Bingham <kieran.bingham@ideasonboard.com>

Reviewed-by: Paul Elder <paul.elder@ideasonboard.com>

> ---
>  README.rst | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
> 
> diff --git a/README.rst b/README.rst
> index a0cc45978b0b..63149fe04067 100644
> --- a/README.rst
> +++ b/README.rst
> @@ -73,7 +73,7 @@ for device hotplug enumeration: [optional]
>  	libudev-dev
>  
>  for documentation: [optional]
> -	python3-sphinx doxygen graphviz
> +	python3-sphinx doxygen graphviz texlive-latex-extra
>  
>  for gstreamer: [optional]
>  	libgstreamer1.0-dev libgstreamer-plugins-base1.0-dev
> -- 
> 2.30.2
>
Laurent Pinchart Sept. 29, 2021, 6:49 a.m. UTC | #2
Hi Kieran,

Thank you for the patch.

On Tue, Sep 28, 2021 at 02:34:07PM +0100, Kieran Bingham wrote:
> When building the documentaion with Doxygen, an error will be

s/documentaion/documentation/

> reported if latex can not find the extra packages provided by
> texlive-latex-extra.
> 
> While this package is optional, document this requirement for
> Documentation.
> 
> Signed-off-by: Kieran Bingham <kieran.bingham@ideasonboard.com>

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

> ---
>  README.rst | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
> 
> diff --git a/README.rst b/README.rst
> index a0cc45978b0b..63149fe04067 100644
> --- a/README.rst
> +++ b/README.rst
> @@ -73,7 +73,7 @@ for device hotplug enumeration: [optional]
>  	libudev-dev
>  
>  for documentation: [optional]
> -	python3-sphinx doxygen graphviz
> +	python3-sphinx doxygen graphviz texlive-latex-extra
>  
>  for gstreamer: [optional]
>  	libgstreamer1.0-dev libgstreamer-plugins-base1.0-dev

Patch
diff mbox series

diff --git a/README.rst b/README.rst
index a0cc45978b0b..63149fe04067 100644
--- a/README.rst
+++ b/README.rst
@@ -73,7 +73,7 @@  for device hotplug enumeration: [optional]
 	libudev-dev
 
 for documentation: [optional]
-	python3-sphinx doxygen graphviz
+	python3-sphinx doxygen graphviz texlive-latex-extra
 
 for gstreamer: [optional]
 	libgstreamer1.0-dev libgstreamer-plugins-base1.0-dev