[Cmake-commits] CMake branch, next, updated. v3.0.0-rc4-2548-g0827bda

Brad King brad.king at kitware.com
Thu Apr 24 15:16:05 EDT 2014


This is an automated email from the git hooks/post-receive script. It was
generated because a ref change was pushed to the repository containing
the project "CMake".

The branch, next has been updated
       via  0827bda6bf320de54aa9482b6c609d0944b93a6f (commit)
       via  64f05923bf4703c76efd820735868735232fcb23 (commit)
      from  08cc4703c84864e8954aa0c3ea732b557528844c (commit)

Those revisions listed above that are new to this repository have
not appeared on any other notification email; so we list those
revisions in full, below.

- Log -----------------------------------------------------------------
http://cmake.org/gitweb?p=cmake.git;a=commitdiff;h=0827bda6bf320de54aa9482b6c609d0944b93a6f
commit 0827bda6bf320de54aa9482b6c609d0944b93a6f
Merge: 08cc470 64f0592
Author:     Brad King <brad.king at kitware.com>
AuthorDate: Thu Apr 24 15:16:04 2014 -0400
Commit:     CMake Topic Stage <kwrobot at kitware.com>
CommitDate: Thu Apr 24 15:16:04 2014 -0400

    Merge topic 'doc-full-help' into next
    
    64f05923 Restore --help-full option to output all help manuals


http://cmake.org/gitweb?p=cmake.git;a=commitdiff;h=64f05923bf4703c76efd820735868735232fcb23
commit 64f05923bf4703c76efd820735868735232fcb23
Author:     Brad King <brad.king at kitware.com>
AuthorDate: Thu Apr 24 15:05:38 2014 -0400
Commit:     Brad King <brad.king at kitware.com>
CommitDate: Thu Apr 24 15:05:38 2014 -0400

    Restore --help-full option to output all help manuals
    
    This option was removed during conversion to the reStructuredText
    documentation.  Restore it.  Process documentation starting at
    Help/index.rst so that all manuals are included in the output.

diff --git a/Help/manual/OPTIONS_HELP.txt b/Help/manual/OPTIONS_HELP.txt
index 631dfef..feeca7d 100644
--- a/Help/manual/OPTIONS_HELP.txt
+++ b/Help/manual/OPTIONS_HELP.txt
@@ -11,6 +11,12 @@
  If a file is specified, the version is written into it.
  |file|
 
+``--help-full [<f>]``
+ Print all help manuals and exit.
+
+ All manuals are printed in a human-readable text format.
+ |file|
+
 ``--help-manual <man> [<f>]``
  Print one help manual and exit.
 
diff --git a/Source/cmDocumentation.cxx b/Source/cmDocumentation.cxx
index 9c27fc1..02967c0 100644
--- a/Source/cmDocumentation.cxx
+++ b/Source/cmDocumentation.cxx
@@ -112,6 +112,8 @@ bool cmDocumentation::PrintDocumentation(Type ht, std::ostream& os)
     {
     case cmDocumentation::Usage:
       return this->PrintDocumentationUsage(os);
+    case cmDocumentation::Full:
+      return this->PrintHelpFull(os);
     case cmDocumentation::OneManual:
       return this->PrintHelpOneManual(os);
     case cmDocumentation::OneCommand:
@@ -364,9 +366,9 @@ bool cmDocumentation::CheckOptions(int argc, const char* const* argv,
       }
     else if(strcmp(argv[i], "--help-full") == 0)
       {
+      help.HelpType = cmDocumentation::Full;
       GET_OPT_ARGUMENT(help.Filename);
-      cmSystemTools::Message("Warning: --help-full no longer supported");
-      return true;
+      this->WarnFormFromFilename(help, result);
       }
     else if(strcmp(argv[i], "--help-html") == 0)
       {
@@ -678,6 +680,12 @@ bool cmDocumentation::PrintFiles(std::ostream& os,
 }
 
 //----------------------------------------------------------------------------
+bool cmDocumentation::PrintHelpFull(std::ostream& os)
+{
+  return this->PrintFiles(os, "index");
+}
+
+//----------------------------------------------------------------------------
 bool cmDocumentation::PrintHelpOneManual(std::ostream& os)
 {
   std::string mname = this->CurrentArgument;
diff --git a/Source/cmDocumentation.h b/Source/cmDocumentation.h
index d5a7dd5..cc16eb7 100644
--- a/Source/cmDocumentation.h
+++ b/Source/cmDocumentation.h
@@ -102,6 +102,7 @@ private:
   bool PrintFiles(std::ostream& os, std::string const& pattern);
 
   bool PrintVersion(std::ostream& os);
+  bool PrintHelpFull(std::ostream& os);
   bool PrintHelpOneManual(std::ostream& os);
   bool PrintHelpOneCommand(std::ostream& os);
   bool PrintHelpOneModule(std::ostream& os);
diff --git a/Source/cmDocumentationFormatter.h b/Source/cmDocumentationFormatter.h
index 118f03d..61766b9 100644
--- a/Source/cmDocumentationFormatter.h
+++ b/Source/cmDocumentationFormatter.h
@@ -26,7 +26,7 @@ public:
   /** Types of help provided.  */
   enum Type
   {
-    None, Version, Usage, ListManuals,
+    None, Version, Usage, Full, ListManuals,
     ListCommands, ListModules, ListProperties, ListVariables, ListPolicies,
     OneManual, OneCommand, OneModule, OneProperty, OneVariable, OnePolicy,
     OldCustomModules

-----------------------------------------------------------------------

Summary of changes:
 Help/manual/OPTIONS_HELP.txt      |    6 ++++++
 Source/cmDocumentation.cxx        |   12 ++++++++++--
 Source/cmDocumentation.h          |    1 +
 Source/cmDocumentationFormatter.h |    2 +-
 4 files changed, 18 insertions(+), 3 deletions(-)


hooks/post-receive
-- 
CMake


More information about the Cmake-commits mailing list