[libcamera-devel,7/9] README: Add missing dependency for documentation

Message ID 20200923151522.56778-8-ricardo@ribalda.com
State Accepted
Headers show
Series
  • Fix README.rst
Related show

Commit Message

Ricardo Ribalda Sept. 23, 2020, 3:15 p.m. UTC
Doxygen fails to create the documentation with this message:

[145/276] Generating doxygen with a custom command
sh: 1: dot: not found
error: Problems running dot: exit code=127, command='dot', arguments='"/home/ricardo/google/libcamera/build/Documentation/api-html/inline_dotgraph_1.dot" -Tpng -o "/home/ricardo/google/libcamera/build/Documentation/api-html/dot_inline_dotgraph_1.png"'
sh: 1: dot: not found
error: Problems running dot: exit code=127, command='dot', arguments='"/home/ricardo/google/libcamera/build/Documentation/api-html/inline_dotgraph_1.dot" -Tcmapx -o "/home/ricardo/google/libcamera/build/Documentation/api-html/dot_inline_dotgraph_1.map"'
[276/276] Linking target test/utils

Signed-off-by: Ricardo Ribalda <ricardo@ribalda.com>
---
 README.rst | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

Comments

Kieran Bingham Sept. 23, 2020, 8:13 p.m. UTC | #1
Hello again,

On 23/09/2020 16:15, Ricardo Ribalda wrote:
> Doxygen fails to create the documentation with this message:
> 
> [145/276] Generating doxygen with a custom command
> sh: 1: dot: not found
> error: Problems running dot: exit code=127, command='dot', arguments='"/home/ricardo/google/libcamera/build/Documentation/api-html/inline_dotgraph_1.dot" -Tpng -o "/home/ricardo/google/libcamera/build/Documentation/api-html/dot_inline_dotgraph_1.png"'
> sh: 1: dot: not found
> error: Problems running dot: exit code=127, command='dot', arguments='"/home/ricardo/google/libcamera/build/Documentation/api-html/inline_dotgraph_1.dot" -Tcmapx -o "/home/ricardo/google/libcamera/build/Documentation/api-html/dot_inline_dotgraph_1.map"'
> [276/276] Linking target test/utils
> 

Looks like it's needed indeed!

> Signed-off-by: Ricardo Ribalda <ricardo@ribalda.com>

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

> ---
>  README.rst | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
> 
> diff --git a/README.rst b/README.rst
> index 720f706..610dcf1 100644
> --- a/README.rst
> +++ b/README.rst
> @@ -67,7 +67,7 @@ for device hotplug enumeration: [optional]
>  	libudev-dev
>  
>  for documentation: [optional]
> -	python3-sphinx doxygen
> +	python3-sphinx doxygen graphviz
>  
>  for gstreamer: [optional]
>  	libgstreamer1.0-dev libgstreamer-plugins-base1.0-dev
>

Patch

diff --git a/README.rst b/README.rst
index 720f706..610dcf1 100644
--- a/README.rst
+++ b/README.rst
@@ -67,7 +67,7 @@  for device hotplug enumeration: [optional]
 	libudev-dev
 
 for documentation: [optional]
-	python3-sphinx doxygen
+	python3-sphinx doxygen graphviz
 
 for gstreamer: [optional]
 	libgstreamer1.0-dev libgstreamer-plugins-base1.0-dev