[cmake-developers] Some documentation patches

[Nicolas Desprès]

2011/10/17 Brad King <brad.king at kitware.com>:
> On 10/16/2011 12:56 PM, Nicolas Desprès wrote:
>>
>> I pushed the new version.
>
> That looks good.  There is one more detail though.  The KWSys source
> tree is read-only in our Git repository.  A robot replays changes
> out of a separate CVS repository for that project.  Please rewrite
> the branch to leave out the changes to
>
>  Source/kwsys/SystemTools.hxx.in
>
> After the rest of the changes are in I can commit this source
> separately.
>

Ok. Here the real change applied on this file (except the remove of
the trailing white-space). It fixes some doxygen warnings:

diff --git a/Source/kwsys/SystemTools.hxx.in b/Source/kwsys/SystemTools.hxx.in
index fd2ed19..04f1978 100644
--- a/Source/kwsys/SystemTools.hxx.in
+++ b/Source/kwsys/SystemTools.hxx.in
@@ -612,7 +612,7 @@ public:
    * Up to 'length' bytes are read from the file, if more than 'percent_bin' %
    * of the bytes are non-textual elements, the file is considered binary,
    * otherwise textual. Textual elements are bytes in the ASCII [0x20, 0x7E]
-   * range, but also \n, \r, \t.
+   * range, but also \\n, \\r, \\t.
    * The algorithm is simplistic, and should probably check for usual file
    * extensions, 'magic' signature, unicode, etc.
    */
@@ -812,7 +812,7 @@ public:
    * Convert windows-style arguments given as a command-line string
    * into more traditional argc/argv arguments.
    * Note that argv[0] will be assigned the executable name using
-   * the ::GetModuleFileName function.
+   * the GetModuleFileName() function.
    */
   static void ConvertWindowsCommandLineToUnixArguments(
     const char *cmd_line, int *argc, char ***argv);

Now the branch no longer touch this file.

I am thinking that maybe it would be nice to have a pre-commit hook
that warn the developper not to modify some part of the tree.

Cheers,

-- 
Nicolas Desprès