[cmake-developers] [patch] Document -H and -B

Brad King brad.king at kitware.com
Fri Jul 1 08:58:01 EDT 2016


On 06/30/2016 05:35 PM, Dave Gittins wrote:
> I don't understand the harm of documenting the options and making
> them public.

The discussion got side-tracked on how to do it with the currently
documented interface.

> Seems to me that they are
> a) used
> b) useful
> c) safe

We can consider making them public but in addition to the documentation
we should:

* Consider providing alternative options with more intuitive names
  and making those public instead.  Currently "-H" stands for "Home"
  which is an internal name within CMake's implementation and is not
  a name whose meaning is public-facing.

* Allow the form `-H <value> -B <value>` with the new names.

* Extend the test suite (e.g. RunCMake.CommandLine) with cases
  covering the public-facing options.

-Brad


More information about the cmake-developers mailing list