doc: Add config check for doxygen 1.8.0+.

Submitted by Jon Cruz on Dec. 3, 2014, 5:48 a.m.

Details

Message ID 1417585733-13069-1-git-send-email-jonc@osg.samsung.com
State Superseded
Headers show

Not browsing as part of any series.

Commit Message

Jon Cruz Dec. 3, 2014, 5:48 a.m.
Add a config time check for a new enough (1.8.0+) version of doxygen.

Signed-off-by: Jon A. Cruz <jonc@osg.samsung.com>
---
 configure.ac | 8 ++++++++
 1 file changed, 8 insertions(+)

Patch hide | download patch | download mbox

diff --git a/configure.ac b/configure.ac
index 6f8220b..317cdae 100644
--- a/configure.ac
+++ b/configure.ac
@@ -109,6 +109,14 @@  if test "x$enable_documentation" = "xyes"; then
 		AC_MSG_ERROR([Documentation build requested but doxygen not found. Install doxygen or disable the documentation using --disable-documentation])
 	fi
 
+	AC_MSG_CHECKING([for compatible doxygen version])
+	doxygen_version=`$DOXYGEN --version`
+	AS_VERSION_COMPARE([$doxygen_version], [1.8.0],
+	                   [AC_MSG_RESULT([no])
+	                    AC_MSG_ERROR([Doxygen $doxygen_version too old. Doxygen 1.8+ required for documentation build. Install required doxygen version or disable the documentation using --disable-documentation])],
+	                   [AC_MSG_RESULT([yes])],
+	                   [AC_MSG_RESULT([yes])])
+
 	AC_PATH_PROG(XMLTO, xmlto)
 
 	if test "x$XMLTO" = "x"; then

Comments

Thanks! You know I tried searching for "version" in the autotools 
documents, but did not find this. That documentation is pretty incomplete.

Note that as far as I can tell the only feature we are using is the 
tildes for code markup, and that is being questioned right now.

On 12/02/2014 09:48 PM, Jon A. Cruz wrote:
> Add a config time check for a new enough (1.8.0+) version of doxygen.
>
> Signed-off-by: Jon A. Cruz <jonc@osg.samsung.com>
> ---
>   configure.ac | 8 ++++++++
>   1 file changed, 8 insertions(+)
>
> diff --git a/configure.ac b/configure.ac
> index 6f8220b..317cdae 100644
> --- a/configure.ac
> +++ b/configure.ac
> @@ -109,6 +109,14 @@ if test "x$enable_documentation" = "xyes"; then
>   		AC_MSG_ERROR([Documentation build requested but doxygen not found. Install doxygen or disable the documentation using --disable-documentation])
>   	fi
>
> +	AC_MSG_CHECKING([for compatible doxygen version])
> +	doxygen_version=`$DOXYGEN --version`
> +	AS_VERSION_COMPARE([$doxygen_version], [1.8.0],
> +	                   [AC_MSG_RESULT([no])
> +	                    AC_MSG_ERROR([Doxygen $doxygen_version too old. Doxygen 1.8+ required for documentation build. Install required doxygen version or disable the documentation using --disable-documentation])],
> +	                   [AC_MSG_RESULT([yes])],
> +	                   [AC_MSG_RESULT([yes])])
> +
>   	AC_PATH_PROG(XMLTO, xmlto)
>
>   	if test "x$XMLTO" = "x"; then
>
I'd be fine with this being held off on. In general the next older
version support to hold the line at would be 1.6.1 as that's what is in
RHEL/CentOS/Scientific 6.

That makes me think perhaps I should first submit this updated to start
with a check for 1.6.0 and then leave bumping up to 1.8+ as a trivial
follow-up when the time is proper.


On 12/03/2014 12:39 PM, Bill Spitzak wrote:
> Thanks! You know I tried searching for "version" in the autotools
> documents, but did not find this. That documentation is pretty incomplete.
> 
> Note that as far as I can tell the only feature we are using is the
> tildes for code markup, and that is being questioned right now.
> 
> On 12/02/2014 09:48 PM, Jon A. Cruz wrote:
>> Add a config time check for a new enough (1.8.0+) version of doxygen.
>>
>> Signed-off-by: Jon A. Cruz <jonc@osg.samsung.com>
>> ---
>>   configure.ac | 8 ++++++++
>>   1 file changed, 8 insertions(+)
>>
>> diff --git a/configure.ac b/configure.ac
>> index 6f8220b..317cdae 100644
>> --- a/configure.ac
>> +++ b/configure.ac
>> @@ -109,6 +109,14 @@ if test "x$enable_documentation" = "xyes"; then
>>           AC_MSG_ERROR([Documentation build requested but doxygen not
>> found. Install doxygen or disable the documentation using
>> --disable-documentation])
>>       fi
>>
>> +    AC_MSG_CHECKING([for compatible doxygen version])
>> +    doxygen_version=`$DOXYGEN --version`
>> +    AS_VERSION_COMPARE([$doxygen_version], [1.8.0],
>> +                       [AC_MSG_RESULT([no])
>> +                        AC_MSG_ERROR([Doxygen $doxygen_version too
>> old. Doxygen 1.8+ required for documentation build. Install required
>> doxygen version or disable the documentation using
>> --disable-documentation])],
>> +                       [AC_MSG_RESULT([yes])],
>> +                       [AC_MSG_RESULT([yes])])
>> +
>>       AC_PATH_PROG(XMLTO, xmlto)
>>
>>       if test "x$XMLTO" = "x"; then
>>
> _______________________________________________
> wayland-devel mailing list
> wayland-devel@lists.freedesktop.org
> http://lists.freedesktop.org/mailman/listinfo/wayland-devel
On 2014-12-03 21:39, Bill Spitzak wrote:
> Thanks! You know I tried searching for "version" in the autotools
> documents, but did not find this. That documentation is pretty incomplete.

Not incomplete at all. You should search harder next time. ;-)
<http://www.gnu.org/savannah-checkouts/gnu/autoconf/manual/autoconf.html#index-AS_005fVERSION_005fCOMPARE-1588>

I would advise anyone working with Autotools to read the full manual(s) 
at least once to understand the thing better. :-)

Cheers,
After some tries I found that if you put the word "compare" into the 
search you will find something other than info about how to ask which 
version of autotools you are running.

On 12/04/2014 02:39 AM, sardemff7+wayland@sardemff7.net wrote:
> On 2014-12-03 21:39, Bill Spitzak wrote:
>> Thanks! You know I tried searching for "version" in the autotools
>> documents, but did not find this. That documentation is pretty
>> incomplete.
>
> Not incomplete at all. You should search harder next time. ;-)
> <http://www.gnu.org/savannah-checkouts/gnu/autoconf/manual/autoconf.html#index-AS_005fVERSION_005fCOMPARE-1588>
>
>
> I would advise anyone working with Autotools to read the full manual(s)
> at least once to understand the thing better. :-)
>
> Cheers,
>