[cmake-developers] cmake --help output indentation (was: RST and documentation)

Stephen Kelly steveire at gmail.com
Wed Nov 20 19:20:20 EST 2013


Brad King wrote:
> IMO the --help-* command-line options are
> still present only for basic compatibility with pre-3.0 help and
> should not be a focus of workflow enhancements.

I don't consider --help-command an 'only compatibility' feature. It's the 
primary way I read cmake documentation.

> The output of the
> individual domain objects is still pretty easy to use.

By 'domain object', do you mean the individual .rst files? How would you 
read them without --help-command and without find+cat? How find+cat easier 
than --help-command?

> All the
> other output is just whole man pages which are better viewed with
> real man page or html viewers.

The --help-command option is much more convenient than

 man cmake-commands
 /find_package
 n # enough times to get to the find_package docs, not references to it.

It is also a disadvantage that the man context is not the command line 
context. Think of when you use cat or head instead of vi/less.

Are you referring to something more convenient? I'm not a man page expert. 
There may be another way to get to the find_package docs than the above?

Thanks,

Steve.





More information about the cmake-developers mailing list