configure: use single word for PROJECT-NAME argument of DX_INIT_DOXYGEN
authorSimon Marchi <simon.marchi@efficios.com>
Wed, 3 Jan 2024 03:37:57 +0000 (22:37 -0500)
committerPhilippe Proulx <eeppeliteloop@gmail.com>
Tue, 23 Jan 2024 15:12:59 +0000 (10:12 -0500)
Running configure with --enable-api-doc shows this warning:

    /home/simark/src/babeltrace/configure: line 25508: 2: command not found

The line 25508 in question is:

  DX_PROJECT=Babeltrace 2

In shell script, this tries to execute the command `2`, with the
`DX_PROJECT` environment variable set to `Babeltrace`.  This is
obviously not what we want.

The documentation for the DX_INIT_DOXYGEN macro says:

   ... call DX_INIT_DOXYGEN with the following parameters: a one-word
   name for the project for use as a filename base etc.

So, we shouldn't pass something with a space as the project name to
DX_INIT_DOXYGEN.  Change it to `babeltrace2`.  I don't think that this
gets used anywhere though, as I didn't see a difference in my build
directory before and after the change (except in the Makefiles, which
don't use the value themselves).

Reported-by: Brice Videau <bvideau@anl.gov>
Change-Id: I5c6a86f3c93ea21d239bd3146eb8359a6c74eaa2
Signed-off-by: Simon Marchi <simon.marchi@efficios.com>
Reviewed-on: https://review.lttng.org/c/babeltrace/+/11623
Reviewed-by: Brice Videau <bvideau@anl.gov>
Reviewed-by: Philippe Proulx <eeppeliteloop@gmail.com>
configure.ac

index 59d98e9cbf38a16a4a7975e41f1c8eea2d2c7c25..21c829214deb33f4d8276aaa9a0ef2cad4b5cf3c 100644 (file)
@@ -606,7 +606,7 @@ AE_IF_FEATURE_ENABLED([api-doc],
     DX_XML_FEATURE(OFF)
     DX_PDF_FEATURE(OFF)
     DX_PS_FEATURE(OFF)
-    DX_INIT_DOXYGEN([Babeltrace 2], [$(builddir)/Doxyfile], [output])
+    DX_INIT_DOXYGEN([babeltrace2], [$(builddir)/Doxyfile], [output])
     AS_IF([test -z "$DX_DOXYGEN"],
       [AC_MSG_ERROR([You need doxygen to enable the API documentation])]
     )
This page took 0.026528 seconds and 4 git commands to generate.