[cmake-developers] [PATCH] split the cmake man page into four man pages

[Alexander Neundorf]

On Wednesday 24 January 2007 23:20, Brad King wrote:
> Alexander Neundorf wrote:
> > On Wednesday 24 January 2007 20:52, you wrote:
> >> Alexander Neundorf wrote:
> >>> That's why here comes a patch which splits the man page into four man
> >>> pages: cmake - command line options and commands (as in the good old
> >>> times ;-) cmakecompat - compatibility (discouraged) commands only
> >>> cmakeprops - the properties
> >>> cmakemodules - the modules
> >>
> >> I've applied the patch and built locally.  There seems to be a
> >> formatting error in the man pages.  I get this error when trying to view
> >> the manpage:
> >>
> >>  Manual page cmakemodules.1 line 1cmakemodules.1:313: warning [p 6,
> >> 4.5i]: cannot adjust line
> >> cmakemodules.1:314: warning [p 6, 4.8i]: cannot adjust line
> >>
> >> -Brad
> >
> > Hmm, I don't get any errors here.
> > The file is attached. Do you get errors for this file too ?
>
>  Manual page cmakemodules.1 line 1cmakemodules.1:2186: warning [p 37,
> 7.7i]: cannot adjust line
> cmakemodules.1:2187: warning [p 37, 8.0i]: cannot adjust line

To make things easier I split the patch in two parts.
Attached is the first part, it only refactors cmDocumentation a bit. The 
output is (almost) unchanged.
The only differences to before are missing "<h2></h2>" in html mode and 
missing "---------" in text mode above the description of the command.

The patch also introduces a new internal class cmDocumentation::cmSection, 
which represent one section in the documentation and handles e.g. the 
different section names depending on the output form. This simplifies the 
code in some places. 
cmDocumentation::CurrentForm is now used much more.
This together makes it easier to split the docs in multiple files later (with 
the 2nd patch coming once this first one is applied).

Ok for applying ?

Bye
Alex
-- 
Work: alexander.neundorf AT jenoptik.com - http://www.jenoptik-los.de
Home: neundorf AT kde.org                - http://www.kde.org
      alex AT neundorf.net               - http://www.neundorf.net
-------------- next part --------------
A non-text attachment was scrubbed...
Name: docs-part1.patch
Type: text/x-diff
Size: 25267 bytes
Desc: not available
URL: <http://public.kitware.com/pipermail/cmake-developers/attachments/20070131/e9b1d6ad/attachment.patch>