Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

"configure --help" output doesn't match actual behaviour #4613

Open
ellert opened this issue Oct 31, 2023 · 0 comments
Open

"configure --help" output doesn't match actual behaviour #4613

ellert opened this issue Oct 31, 2023 · 0 comments

Comments

@ellert
Copy link

ellert commented Oct 31, 2023

What is the intended behaviour here?

  • The documented behaviour from "configure --help", i.e. drafts enabled by default, or
  • The implemented behaviour, i.e. drafts disabled by default (unless building from a git checkout).

libzmq/configure.ac

Lines 1029 to 1042 in f0c471a

if test "x$cross_compiling" = "xyes"; then
# Enable draft by default when cross-compiling
defaultval=yes
else
# enable draft API by default if we're in a git repository
# else disable it by default; then allow --enable-drafts=yes/no override
AC_CHECK_FILE($srcdir/.git, [defaultval=yes], [defaultval=no])
fi
AC_ARG_ENABLE([drafts],
AS_HELP_STRING([--enable-drafts],
[Build and install draft classes and methods [default=yes]]),
[enable_drafts=$enableval],
[enable_drafts=$defaultval])

I would prefer to change the implemented behaviour to match the documented behaviour, i.e.

AC_ARG_ENABLE([drafts], 
    AS_HELP_STRING([--enable-drafts], 
        [Build and install draft classes and methods [default=yes]]), 
    [enable_drafts=$enableval], 
    [enable_drafts=yes]) 

(and remove the definition of the now unused defaultval).

But if this is not acceptible, change the documentation to match the implementation:

AC_ARG_ENABLE([drafts], 
    AS_HELP_STRING([--enable-drafts], 
        [Build and install draft classes and methods [default=$defaultval]]), 
    [enable_drafts=$enableval], 
    [enable_drafts=$defaultval]) 

As it is now, users reading the output of "configure --help" think they have drafts enabled when they actually have not.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant