[v2] doc: Add config check for doxygen 1.6.0+.

Submitted by Jon Cruz on Dec. 4, 2014, 2:26 a.m.

Details

Message ID 1417659986-26582-1-git-send-email-jonc@osg.samsung.com
State Accepted
Commit 480b437cd87b6c268b083c970dfbfbd8ff1a0dae
Headers show

Not browsing as part of any series.

Commit Message

Jon Cruz Dec. 4, 2014, 2:26 a.m.
Add a config time check for a new enough (1.6.0+) version of doxygen.

v2. require 1.6.0+ instead of 1.8.0+

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..12dd94c 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.6.0],
+	                   [AC_MSG_RESULT([no])
+	                    AC_MSG_ERROR([Doxygen $doxygen_version too old. Doxygen 1.6+ 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

On Wed,  3 Dec 2014 18:26:26 -0800
"Jon A. Cruz" <jonc@osg.samsung.com> wrote:

> Add a config time check for a new enough (1.6.0+) version of doxygen.
> 
> v2. require 1.6.0+ instead of 1.8.0+
> 
> 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..12dd94c 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.6.0],
> +	                   [AC_MSG_RESULT([no])
> +	                    AC_MSG_ERROR([Doxygen $doxygen_version too old. Doxygen 1.6+ 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

Hi,

looking at doc/doxygen/wayland.doxygen.in it says
# Doxyfile 1.7.6.1

Do we know this works with Doxygen 1.6 or should we require 1.7?

Not that it matters too much, since right now we don't have any checks,
but I'd prefer some consistency.


Thanks,
pq
On 12/05/2014 07:09 AM, Pekka Paalanen wrote:
> 
> Hi,
> 
> looking at doc/doxygen/wayland.doxygen.in it says
> # Doxyfile 1.7.6.1
> 
> Do we know this works with Doxygen 1.6 or should we require 1.7?
> 
> Not that it matters too much, since right now we don't have any checks,
> but I'd prefer some consistency.
> 

Yes. In general you'd not see anything unless the body of the doxyfile
used some attribute that was added in 1.7.

1.6.1 is the version that currently is latest for RHEL 6 (and this
CentOS 6, Scientific Linux 6). At my last day-job I had to deal with
this exact compatibility issue.

*If* we do happen to have items that cause warnings when run on 1.6, the
common fix would be to conditionally pipe the doxyfile through
processing as it gets invoked.


That comment also just flags which version of Doxyfile was used to
generate the file. I can follow-up as a different item with checks to
see if we do use any 1.7 specifics. If not I'll submit a cleanup so that
things are consistent.
On Fri, 05 Dec 2014 07:39:04 -0800
"Jon A. Cruz" <jonc@osg.samsung.com> wrote:

> 
> 
> On 12/05/2014 07:09 AM, Pekka Paalanen wrote:
> > 
> > Hi,
> > 
> > looking at doc/doxygen/wayland.doxygen.in it says
> > # Doxyfile 1.7.6.1
> > 
> > Do we know this works with Doxygen 1.6 or should we require 1.7?
> > 
> > Not that it matters too much, since right now we don't have any checks,
> > but I'd prefer some consistency.
> > 
> 
> Yes. In general you'd not see anything unless the body of the doxyfile
> used some attribute that was added in 1.7.
> 
> 1.6.1 is the version that currently is latest for RHEL 6 (and this
> CentOS 6, Scientific Linux 6). At my last day-job I had to deal with
> this exact compatibility issue.
> 
> *If* we do happen to have items that cause warnings when run on 1.6, the
> common fix would be to conditionally pipe the doxyfile through
> processing as it gets invoked.
> 
> 
> That comment also just flags which version of Doxyfile was used to
> generate the file. I can follow-up as a different item with checks to
> see if we do use any 1.7 specifics. If not I'll submit a cleanup so that
> things are consistent.

Sounds good, pushed!

Thanks,
pq