[libcamera-devel] Documentation: Use absolute paths for Doxygen EXCLUDE files

Message ID 20190608111400.8480-1-laurent.pinchart@ideasonboard.com
State Accepted
Commit 255e58385784c7190194d4b8ba0523ad1e038ac4
Headers show
Series
  • [libcamera-devel] Documentation: Use absolute paths for Doxygen EXCLUDE files
Related show

Commit Message

Laurent Pinchart June 8, 2019, 11:14 a.m. UTC
To avoid hardcoding a dependency between the source and build
directories, use absolute paths for the Doxygen EXCLUDE files. The build
directory can now be placed in any location, not just a direct
subdirectory of the source directory.

Signed-off-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com>
---
 Documentation/Doxyfile.in | 10 +++++-----
 1 file changed, 5 insertions(+), 5 deletions(-)

Comments

Kieran Bingham June 8, 2019, 11:46 p.m. UTC | #1
Hi Laurent,

On 08/06/2019 12:14, Laurent Pinchart wrote:
> To avoid hardcoding a dependency between the source and build
> directories, use absolute paths for the Doxygen EXCLUDE files. The build
> directory can now be placed in any location, not just a direct
> subdirectory of the source directory.

This sounds like a good fix !

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

And it looks accurate to me.

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

> ---
>  Documentation/Doxyfile.in | 10 +++++-----
>  1 file changed, 5 insertions(+), 5 deletions(-)
> 
> diff --git a/Documentation/Doxyfile.in b/Documentation/Doxyfile.in
> index ac70efbff9fd..c58631200dd5 100644
> --- a/Documentation/Doxyfile.in
> +++ b/Documentation/Doxyfile.in
> @@ -833,11 +833,11 @@ RECURSIVE              = YES
>  # Note that relative paths are relative to the directory from which doxygen is
>  # run.
>  
> -EXCLUDE                = ../src/libcamera/device_enumerator_sysfs.cpp \
> -			 ../src/libcamera/device_enumerator_udev.cpp \
> -			 ../src/libcamera/include/device_enumerator_sysfs.h \
> -			 ../src/libcamera/include/device_enumerator_udev.h \
> -			 ../src/libcamera/pipeline/
> +EXCLUDE                = @TOP_SRCDIR@/src/libcamera/device_enumerator_sysfs.cpp \
> +			 @TOP_SRCDIR@/src/libcamera/device_enumerator_udev.cpp \
> +			 @TOP_SRCDIR@/src/libcamera/include/device_enumerator_sysfs.h \
> +			 @TOP_SRCDIR@/src/libcamera/include/device_enumerator_udev.h \
> +			 @TOP_SRCDIR@/src/libcamera/pipeline/
>  
>  # The EXCLUDE_SYMLINKS tag can be used to select whether or not files or
>  # directories that are symbolic links (a Unix file system feature) are excluded
>

Patch

diff --git a/Documentation/Doxyfile.in b/Documentation/Doxyfile.in
index ac70efbff9fd..c58631200dd5 100644
--- a/Documentation/Doxyfile.in
+++ b/Documentation/Doxyfile.in
@@ -833,11 +833,11 @@  RECURSIVE              = YES
 # Note that relative paths are relative to the directory from which doxygen is
 # run.
 
-EXCLUDE                = ../src/libcamera/device_enumerator_sysfs.cpp \
-			 ../src/libcamera/device_enumerator_udev.cpp \
-			 ../src/libcamera/include/device_enumerator_sysfs.h \
-			 ../src/libcamera/include/device_enumerator_udev.h \
-			 ../src/libcamera/pipeline/
+EXCLUDE                = @TOP_SRCDIR@/src/libcamera/device_enumerator_sysfs.cpp \
+			 @TOP_SRCDIR@/src/libcamera/device_enumerator_udev.cpp \
+			 @TOP_SRCDIR@/src/libcamera/include/device_enumerator_sysfs.h \
+			 @TOP_SRCDIR@/src/libcamera/include/device_enumerator_udev.h \
+			 @TOP_SRCDIR@/src/libcamera/pipeline/
 
 # The EXCLUDE_SYMLINKS tag can be used to select whether or not files or
 # directories that are symbolic links (a Unix file system feature) are excluded