[cmake-developers] Improving CPack Documentation (and may be others as well)

Eric Noulard eric.noulard at gmail.com
Sun Jan 22 07:58:55 EST 2012


2012/1/3 Eric Noulard <eric.noulard at gmail.com>:


> back to cleaner way of work.

I did update and clean-up my previous attempt to ease documentation
for CPack.
http://public.kitware.com/Bug/view.php?id=10067

the new up-to-date branch is "stage/ImproveCPackDoc-reloaded"

I'd rather wait for feedback before merging this to next.
Fast try is:

  cpack --help-variable-list
  cpack --help-command-list

then chose whatever var / command you like.
The documentation is extracted from files
(CPack.cmake, CPackComponent.cmake, CPackRPM.cmake, CPackDeb.cmake)
using new markup.

Currently the list of files used are builtin the cpack.cxx source code
but we can imagine
a more dynamic way to do that.

On the contrary if it is too dynamic we could do the extraction as
part of the build process
and embed the result in C++ code.

The proposed markup tries its best to be backward compatible, meaning that
a module "Blah.cmake" which contains the new markup is transparently parsed
by
cmake --help-module Blah

as if it does not contain the new markup.

We could do far better if we will be wanting to drop this but do we?
Give me feedbacks guys.


-- 
Erk
Membre de l'April - « promouvoir et défendre le logiciel libre » -
http://www.april.org



More information about the cmake-developers mailing list