Trivial: start the help texts with lowercase #6739

pull paveljanik wants to merge 1 commits into bitcoin:master from paveljanik:patch-9 changing 1 files +1 −1

paveljanik commented at 6:42 AM on September 30, 2015: contributor

All configure --help texts should start with a lowercase letter.
[Trivial] start the help texts with lowercase 96106f0f30
jonasschnelli commented at 6:55 AM on September 30, 2015: 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 commented at 7:00 AM on September 30, 2015: contributor

~~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 commented at 12:35 PM on September 30, 2015: contributor

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 commented at 12:59 PM on September 30, 2015: member
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 commented at 1:09 PM on September 30, 2015: contributor

Boost one is an upstream issue in http://www.gnu.org/software/autoconf-archive/ax_boost_base.html - I do not want to divert.
laanwj added the label Docs and Output on Sep 30, 2015

paveljanik commented at 1:24 PM on September 30, 2015: contributor

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 commented at 4:15 PM on September 30, 2015: member

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 commented at 9:40 AM on October 1, 2015: contributor

Nod - a pull request to change them all at once
laanwj merged this on Oct 1, 2015
laanwj closed this on Oct 1, 2015
laanwj referenced this in commit 19c7186425 on Oct 1, 2015
zkbot referenced this in commit 36df5a92f8 on Feb 9, 2017
zkbot referenced this in commit dd8b38316f on Feb 9, 2017
zkbot referenced this in commit 253c610783 on Feb 9, 2017
MarcoFalke locked this on Sep 8, 2021

Contributors

Labels