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

Brad King brad.king at kitware.com
Mon Nov 18 15:34:15 EST 2013


On 11/18/2013 02:56 PM, Stephen Kelly wrote:
> We've had a while now to get used to the new docs system. Mostly I like it, 
> though I haven't really looked much into what rst offers.

This is really the start of several threads so I will branch out now.

> 1) Indentation
> Something that I liked about the previous system was that the output from 
> cmake --help-* was indented. Can we indent the rst output too?

I see no value in simply adding leading whitespace on every line.
It would have to be block-aware indentation and that would be very
difficult to implement.  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.  The output of the
individual domain objects is still pretty easy to use.  All the
other output is just whole man pages which are better viewed with
real man page or html viewers.

-Brad



More information about the cmake-developers mailing list