Skip to content

Conversation

@paveljanik
Copy link
Contributor

All configure --help texts should start with a lowercase letter.

@jonasschnelli
Copy link
Contributor

I think it would make sense to also change from --disable-zmq to --enable-zmq (to fit the current style --enable-wallet etc.)

@paveljanik
Copy link
Contributor Author

I had the same feeling when I tested --enable-bench... But: --enable-tests is also enabled by default and the option is described as --enable... so I left it as it is now.

Looks like I misread what you wrote.

I personally prefer --disable-feature documented, when it is enabled by default. So I won't change anything here...

@jgarzik
Copy link
Contributor

jgarzik commented Sep 30, 2015

If it's enabled by default, the feature logically requires a --disable-foo. And the opposite, for anything disabled by default. (and as seen in #6733 and elsewhere, features should be built, even if runtime-disabled)

@laanwj
Copy link
Member

laanwj commented Sep 30, 2015

Right - the reasoning would be thus: you never have to pass --enable-zmq, because if the relevant library and version is installed, it picks it up automatically.
So documenting --disable-zmq makes sense.

BTW: if we want to be consistent, we should be consistent, looking at configure output, there are more options that start with uppercase, probably should adapt them as well:

  --with-boost-libdir=LIB_DIR
                          Force given directory for boost libraries. Note that
  --with-libressl         Build with system LibreSSL (default is no;
                          DANGEROUS; NOT SUPPORTED)

But re: libressl see also #6732

@paveljanik
Copy link
Contributor Author

@laanwj laanwj added the Docs label Sep 30, 2015
@paveljanik
Copy link
Contributor Author

Ad enable/disable rewrites:

  --enable-shared[=PKGS]  build shared libraries [default=yes]
  --enable-static[=PKGS]  build static libraries [default=yes]
  --enable-fast-install[=PKGS]
                          optimize for fast installation [default=yes]
  --enable-wallet         enable wallet (default is yes)
  --enable-tests          compile tests (default is yes)
  --enable-hardening      attempt to harden the resulting executables (default
                          is yes)
  --enable-ccache         use ccache for building (default is yes if ccache is
                          found)

This is a quick scan of the current configure here.

@laanwj
Copy link
Member

laanwj commented Sep 30, 2015

OK, fair enough, thanks for checking. Just want to avoid zillions of pulls that change the case of a single character, so if we could have done multiple at once it would be nice. But yes the boost one has to be changed upstream...

@jgarzik
Copy link
Contributor

jgarzik commented Oct 1, 2015

Nod - a pull request to change them all at once

@laanwj laanwj merged commit 96106f0 into bitcoin:master Oct 1, 2015
laanwj added a commit that referenced this pull request Oct 1, 2015
96106f0 [Trivial] start the help texts with lowercase (paveljanik)
zkbot added a commit to zcash/zcash that referenced this pull request Feb 9, 2017
zkbot added a commit to zcash/zcash that referenced this pull request Feb 9, 2017
@bitcoin bitcoin locked as resolved and limited conversation to collaborators Sep 8, 2021
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants