Re: [cmake-developers] Some documentation patches

2011-10-26 Thread Nicolas Desprès
2011/10/24 Brad King brad.k...@kitware.com:
 On 10/24/2011 4:53 AM, Nicolas Desprès wrote:

 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

 I committed this separately, thanks.

 Now the branch no longer touch this file.

 I merged the branch to 'next' for testing.

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

 Good idea.  We already have some local hooks:

  http://www.cmake.org/Wiki/Git/Hooks

 They use a common hooks branch shared in many Kitware projects.
 The common hooks support chaining to per-project hooks in the source
 tree.  I added a 'local-hooks' topic to chain hooks for CMake and
 then added a check for this:

  http://cmake.org/gitweb?p=cmake.git;a=commitdiff;h=b2d6adf1

 Once merged to master then new work based on that version or later
 will get this check if the local hooks are installed.

Works perfectly! Thanks!

git config hooks.chain-pre-commit Utilities/Git/pre-commit

-- 
Nicolas Desprès
--

Powered by www.kitware.com

Visit other Kitware open-source projects at 
http://www.kitware.com/opensource/opensource.html

Please keep messages on-topic and check the CMake FAQ at: 
http://www.cmake.org/Wiki/CMake_FAQ

Follow this link to subscribe/unsubscribe:
http://public.kitware.com/cgi-bin/mailman/listinfo/cmake-developers


Re: [cmake-developers] Some documentation patches

2011-10-24 Thread Nicolas Desprès
2011/10/17 Brad King brad.k...@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
--

Powered by www.kitware.com

Visit other Kitware open-source projects at 
http://www.kitware.com/opensource/opensource.html

Please keep messages on-topic and check the CMake FAQ at: 
http://www.cmake.org/Wiki/CMake_FAQ

Follow this link to subscribe/unsubscribe:
http://public.kitware.com/cgi-bin/mailman/listinfo/cmake-developers


Re: [cmake-developers] Some documentation patches

2011-10-24 Thread Brad King

On 10/24/2011 4:53 AM, Nicolas Desprès wrote:

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


I committed this separately, thanks.


Now the branch no longer touch this file.


I merged the branch to 'next' for testing.


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


Good idea.  We already have some local hooks:

  http://www.cmake.org/Wiki/Git/Hooks

They use a common hooks branch shared in many Kitware projects.
The common hooks support chaining to per-project hooks in the source
tree.  I added a 'local-hooks' topic to chain hooks for CMake and
then added a check for this:

  http://cmake.org/gitweb?p=cmake.git;a=commitdiff;h=b2d6adf1

Once merged to master then new work based on that version or later
will get this check if the local hooks are installed.

-Brad
--

Powered by www.kitware.com

Visit other Kitware open-source projects at 
http://www.kitware.com/opensource/opensource.html

Please keep messages on-topic and check the CMake FAQ at: 
http://www.cmake.org/Wiki/CMake_FAQ

Follow this link to subscribe/unsubscribe:
http://public.kitware.com/cgi-bin/mailman/listinfo/cmake-developers


Re: [cmake-developers] Some documentation patches

2011-10-17 Thread Brad King

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.

Thanks,
-Brad
--

Powered by www.kitware.com

Visit other Kitware open-source projects at 
http://www.kitware.com/opensource/opensource.html

Please keep messages on-topic and check the CMake FAQ at: 
http://www.cmake.org/Wiki/CMake_FAQ

Follow this link to subscribe/unsubscribe:
http://public.kitware.com/cgi-bin/mailman/listinfo/cmake-developers


Re: [cmake-developers] Some documentation patches

2011-10-13 Thread Rolf Eike Beer
Brad King wrote:

 - Some of the patches remove trailing whitespace from lines unrelated to
the real change.  Please identify the set of files from which you've
blanket-removed whitespace, create a commit that does just that, and
then rebase the rest of the patches on it.  That will make the changes
easier to see/review/blame.

sed 's,[ \t]*$,,' -i $(find . -type f)

HTH,

Eike

signature.asc
Description: This is a digitally signed message part.
--

Powered by www.kitware.com

Visit other Kitware open-source projects at 
http://www.kitware.com/opensource/opensource.html

Please keep messages on-topic and check the CMake FAQ at: 
http://www.cmake.org/Wiki/CMake_FAQ

Follow this link to subscribe/unsubscribe:
http://public.kitware.com/cgi-bin/mailman/listinfo/cmake-developers

Re: [cmake-developers] Some documentation patches

2011-10-13 Thread Nicolas Desprès
On Thu, Oct 13, 2011 at 8:30 AM, Rolf Eike Beer e...@sf-mail.de wrote:
 Brad King wrote:

 - Some of the patches remove trailing whitespace from lines unrelated to
    the real change.  Please identify the set of files from which you've
    blanket-removed whitespace, create a commit that does just that, and
    then rebase the rest of the patches on it.  That will make the changes
    easier to see/review/blame.

 sed 's,[ \t]*$,,' -i $(find . -type f)

 HTH,

Thanks but this one is dangerous because it also modify your .git and
just break your repository if started from the root of the project :-)

-- 
Nicolas Desprès
--

Powered by www.kitware.com

Visit other Kitware open-source projects at 
http://www.kitware.com/opensource/opensource.html

Please keep messages on-topic and check the CMake FAQ at: 
http://www.cmake.org/Wiki/CMake_FAQ

Follow this link to subscribe/unsubscribe:
http://public.kitware.com/cgi-bin/mailman/listinfo/cmake-developers


Re: [cmake-developers] Some documentation patches

2011-10-13 Thread Nicolas Desprès
2011/10/13 Brad King brad.k...@kitware.com:
 On 10/12/2011 11:10 AM, Nicolas Desprès wrote:

 I have extracted some documentation patches I have made while I was
 working on the ninja-generator and some enhancement for ccmake.  I
 would like to submit them now. They are addressing:
 - usage messages
 - doxygen documentation
 - online help in ccmake

 Fantastic.  This is a lot of tedious cleanup work.  Thanks for doing it!
 Here are a few comments from review:

 - The Factor toggle key help instructions commit adds lines longer than
  79 characters.  Please reformat them to use shorter lines.

 - Some of the patches remove trailing whitespace from lines unrelated to
  the real change.  Please identify the set of files from which you've
  blanket-removed whitespace, create a commit that does just that, and
  then rebase the rest of the patches on it.  That will make the changes
  easier to see/review/blame.

 - Please prefix each commit message with the section affected, when
  applicable.  For example, ccmake:  or doxygen: .

Thanks for the review. I have fix all the remarks. Shall I send the
patch again via the mailing list or shall I push them on github and
you will fetch them. Sending many patches to the mailing list make the
post moderated. Tell me what is the easiest for you.

Cheers,

-- 
Nicolas Desprès
--

Powered by www.kitware.com

Visit other Kitware open-source projects at 
http://www.kitware.com/opensource/opensource.html

Please keep messages on-topic and check the CMake FAQ at: 
http://www.cmake.org/Wiki/CMake_FAQ

Follow this link to subscribe/unsubscribe:
http://public.kitware.com/cgi-bin/mailman/listinfo/cmake-developers


Re: [cmake-developers] Some documentation patches

2011-10-13 Thread Nicolas Desprès
2011/10/13 Nicolas Desprès nicolas.desp...@gmail.com:
 2011/10/13 Brad King brad.k...@kitware.com:
 On 10/12/2011 11:10 AM, Nicolas Desprès wrote:

 I have extracted some documentation patches I have made while I was
 working on the ninja-generator and some enhancement for ccmake.  I
 would like to submit them now. They are addressing:
 - usage messages
 - doxygen documentation
 - online help in ccmake

 Fantastic.  This is a lot of tedious cleanup work.  Thanks for doing it!
 Here are a few comments from review:

 - The Factor toggle key help instructions commit adds lines longer than
  79 characters.  Please reformat them to use shorter lines.

 - Some of the patches remove trailing whitespace from lines unrelated to
  the real change.  Please identify the set of files from which you've
  blanket-removed whitespace, create a commit that does just that, and
  then rebase the rest of the patches on it.  That will make the changes
  easier to see/review/blame.

 - Please prefix each commit message with the section affected, when
  applicable.  For example, ccmake:  or doxygen: .

 Thanks for the review. I have fix all the remarks. Shall I send the
 patch again via the mailing list or shall I push them on github and
 you will fetch them. Sending many patches to the mailing list make the
 post moderated. Tell me what is the easiest for you.


Pushed on my github:
https://github.com/polrop/CMake/commits/some-documentation-fixes

-- 
Nicolas Desprès
--

Powered by www.kitware.com

Visit other Kitware open-source projects at 
http://www.kitware.com/opensource/opensource.html

Please keep messages on-topic and check the CMake FAQ at: 
http://www.cmake.org/Wiki/CMake_FAQ

Follow this link to subscribe/unsubscribe:
http://public.kitware.com/cgi-bin/mailman/listinfo/cmake-developers


Re: [cmake-developers] Some documentation patches

2011-10-13 Thread Brad King

On 10/13/2011 2:14 PM, Nicolas Desprès wrote:

2011/10/13 Nicolas Desprèsnicolas.desp...@gmail.com:

Thanks for the review. I have fix all the remarks.


Pushed on my github:
https://github.com/polrop/CMake/commits/some-documentation-fixes


Thanks.  I will fetch it from there when I get a chance to look at it again.

-Brad
--

Powered by www.kitware.com

Visit other Kitware open-source projects at 
http://www.kitware.com/opensource/opensource.html

Please keep messages on-topic and check the CMake FAQ at: 
http://www.cmake.org/Wiki/CMake_FAQ

Follow this link to subscribe/unsubscribe:
http://public.kitware.com/cgi-bin/mailman/listinfo/cmake-developers


Re: [cmake-developers] Some documentation patches

2011-10-13 Thread Brad King

On 10/13/2011 2:14 PM, Nicolas Desprès wrote:

2011/10/13 Nicolas Desprèsnicolas.desp...@gmail.com:

Thanks for the review. I have fix all the remarks.


Pushed on my github:
https://github.com/polrop/CMake/commits/some-documentation-fixes


That looks pretty good.  I have two more comments:

- The following commits add lines over 79 characters that weren't already:

 ccmake: Align 'g' and 'q' key instructions.
 Usage: Document all options printing the version number.

- The commit Doxygen: Fix warnings. modifies some *Lexer.cxx files
which are actually flex-generated sources created from the *.in.l
versions.  The modifications to the comments should be made in both
files so that the next time we regenerate the lexers the comments
are preserved.

Thanks,
-Brad
--

Powered by www.kitware.com

Visit other Kitware open-source projects at 
http://www.kitware.com/opensource/opensource.html

Please keep messages on-topic and check the CMake FAQ at: 
http://www.cmake.org/Wiki/CMake_FAQ

Follow this link to subscribe/unsubscribe:
http://public.kitware.com/cgi-bin/mailman/listinfo/cmake-developers


Re: [cmake-developers] Some documentation patches

2011-10-12 Thread Brad King

On 10/12/2011 11:10 AM, Nicolas Desprès wrote:

I have extracted some documentation patches I have made while I was
working on the ninja-generator and some enhancement for ccmake.  I
would like to submit them now. They are addressing:
- usage messages
- doxygen documentation
- online help in ccmake


Fantastic.  This is a lot of tedious cleanup work.  Thanks for doing it!
Here are a few comments from review:

- The Factor toggle key help instructions commit adds lines longer than
  79 characters.  Please reformat them to use shorter lines.

- Some of the patches remove trailing whitespace from lines unrelated to
  the real change.  Please identify the set of files from which you've
  blanket-removed whitespace, create a commit that does just that, and
  then rebase the rest of the patches on it.  That will make the changes
  easier to see/review/blame.

- Please prefix each commit message with the section affected, when
  applicable.  For example, ccmake:  or doxygen: .

Thanks,
-Brad
--

Powered by www.kitware.com

Visit other Kitware open-source projects at 
http://www.kitware.com/opensource/opensource.html

Please keep messages on-topic and check the CMake FAQ at: 
http://www.cmake.org/Wiki/CMake_FAQ

Follow this link to subscribe/unsubscribe:
http://public.kitware.com/cgi-bin/mailman/listinfo/cmake-developers