[cmake-developers] Please restore --help-full cmake option for version 3
Alan W. Irwin
irwin at beluga.phys.uvic.ca
Thu Apr 24 07:38:28 EDT 2014
The --help-full CMake option (to dump essentially all classes of
documentation available to stdout) is extremely useful at least on
Unix where it can be pipelined to less and comprehensively searched
with that application for whatever is relevant on a given topic using
a simple phrase or more sophisticated regex expression.
I just discovered that extremely useful --help-full functionality is
missing for CMake 3 when trying to look up _all_ the relevant
documentation on --find-package for CMake 3 to see whether that had
changed from CMake 2. Here is the result with cmake-3.0.0-rc3.
software at raven> ~/cmake/install-3.0.0-rc3/bin/cmake --help-full
Warning: --help-full no longer supported
That --find-package information is split into
two parts so is in completely different kinds of documentation
classes. Fortunately, --help-full gave me access to all documentation
classes at once in a seachable way for CMake 2, but I had to try a lot
of different versions of help commands to get access to both parts of
the --find-package documentation for CMake 3.
So the currently implemented large number of different ways to output
different documentation classes for CMake 3 is useful for
knowledgeable CMake users who are just double-checking something they
already know pretty well. But for those who for whatever reason are
not actually sure what documentation class they need or (as in the
--find-package case) where the documentation is spread over two or
more documentation classes, --help-full is really convenient for those
familiar with the regex searching power of the less application.
So in sum, please restore the --help-full CMake 2 functionality (or an
approximation to it where you simply dump out all documentation
classes to stdout) for CMake-3.
Alan W. Irwin
Astronomical research affiliation with Department of Physics and Astronomy,
University of Victoria (astrowww.phys.uvic.ca).
Programming affiliations with the FreeEOS equation-of-state
implementation for stellar interiors (freeeos.sf.net); the Time
Ephemerides project (timeephem.sf.net); PLplot scientific plotting
software package (plplot.sf.net); the libLASi project
(unifont.org/lasi); the Loads of Linux Links project (loll.sf.net);
and the Linux Brochure Project (lbproject.sf.net).
More information about the cmake-developers