summaryrefslogtreecommitdiffstats
path: root/Source/cmDumpDocumentation.cxx
diff options
context:
space:
mode:
authorBrad King <brad.king@kitware.com>2009-12-08 14:38:36 (GMT)
committerBrad King <brad.king@kitware.com>2009-12-08 14:38:36 (GMT)
commit1d91bc64aa824c58ddcffeae4efb14d89a89c493 (patch)
tree773e2247ff84d25396a8b6c13a725e8d6ec890e1 /Source/cmDumpDocumentation.cxx
parentf1d4f951d625c0168c445eb6512463dcc2f4a0cf (diff)
downloadCMake-1d91bc64aa824c58ddcffeae4efb14d89a89c493.zip
CMake-1d91bc64aa824c58ddcffeae4efb14d89a89c493.tar.gz
CMake-1d91bc64aa824c58ddcffeae4efb14d89a89c493.tar.bz2
Remove unused DumpDocumentation code
The DumpDocumentation executable and some supporting code and tests were completely unused by CMake. Generation of documentation is done by the individual executables with --help* options. In this commit we simply remove the unused code, executable, and test.
Diffstat (limited to 'Source/cmDumpDocumentation.cxx')
-rw-r--r--Source/cmDumpDocumentation.cxx150
1 files changed, 0 insertions, 150 deletions
diff --git a/Source/cmDumpDocumentation.cxx b/Source/cmDumpDocumentation.cxx
deleted file mode 100644
index 877ed13..0000000
--- a/Source/cmDumpDocumentation.cxx
+++ /dev/null
@@ -1,150 +0,0 @@
-/*============================================================================
- CMake - Cross Platform Makefile Generator
- Copyright 2000-2009 Kitware, Inc., Insight Software Consortium
-
- Distributed under the OSI-approved BSD License (the "License");
- see accompanying file Copyright.txt for details.
-
- This software is distributed WITHOUT ANY WARRANTY; without even the
- implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
- See the License for more information.
-============================================================================*/
-// Program extracts documentation describing commands from
-// the CMake system.
-//
-#include "cmake.h"
-
-#include "cmDocumentation.h"
-#include "cmVersion.h"
-
-//----------------------------------------------------------------------------
-static const char *cmDocumentationName[][3] =
-{
- {0,
- " DumpDocumentation - Dump documentation for CMake.", 0},
- {0,0,0}
-};
-
-//----------------------------------------------------------------------------
-static const char *cmDocumentationUsage[][3] =
-{
- {0,
- " DumpDocumentation [filename]", 0},
- {0,0,0}
-};
-
-//----------------------------------------------------------------------------
-static const char *cmDocumentationDescription[][3] =
-{
- {0,
- "The \"DumpDocumentation\" executable is only available in the build "
- "tree. It is used for testing, coverage, and documentation.", 0},
- CMAKE_STANDARD_INTRODUCTION,
- {0,0,0}
-};
-
-//----------------------------------------------------------------------------
-static const char *cmDocumentationOptions[][3] =
-{
- {"--all-for-coverage",
- "Dump all documentation to stdout. For testing.", 0},
- {0,0,0}
-};
-
-
-int DumpHTML(const char* outname)
-{
- std::ofstream fout(outname);
- if(!fout)
- {
- std::cerr << "failed to open output file: " << outname << "\n";
- cmSystemTools::ReportLastSystemError("");
- return -1;
- }
-
- cmake cmi;
- cmDocumentation doc;
- std::vector<cmDocumentationEntry> commands;
- cmi.GetCommandDocumentation(commands);
- cmOStringStream str;
- str << "Documentation for Commands of CMake "
- << cmVersion::GetCMakeVersion();
- doc.SetSection(str.str().c_str(), commands);
- doc.Print(cmDocumentation::HTMLForm, fout);
-
- return 0;
-}
-
-int DumpForCoverageToStream(std::ostream& out)
-{
- cmake cmi;
- cmDocumentation doc;
- std::vector<cmDocumentationEntry> commands;
- std::vector<cmDocumentationEntry> generators;
- cmi.GetCommandDocumentation(commands);
- cmi.GetGeneratorDocumentation(generators);
- doc.SetSection("Name",cmDocumentationName);
- doc.SetSection("Usage",cmDocumentationUsage);
- doc.SetSection("Description",cmDocumentationDescription);
- doc.SetSection("options",cmDocumentationOptions);
- doc.SetSection("Commands",commands);
- doc.SetSection("Generators",generators);
- doc.PrintDocumentation(cmDocumentation::Usage, out);
- doc.PrintDocumentation(cmDocumentation::Full, out);
- return 0;
-}
-
-int DumpForCoverage(const char* outname)
-{
- if(outname)
- {
- std::ofstream fout(outname);
- if(!fout)
- {
- std::cerr << "failed to open output file: " << outname << "\n";
- cmSystemTools::ReportLastSystemError("");
- return -1;
- }
- return DumpForCoverageToStream(fout);
- }
- else
- {
- return DumpForCoverageToStream(std::cout);
- }
-}
-
-int main(int ac, char** av)
-{
- cmSystemTools::EnableMSVCDebugHook();
- cmSystemTools::FindExecutableDirectory(av[0]);
- const char* outname = "cmake.html";
- bool coverage = false;
- if(ac > 1)
- {
- if(strcmp(av[1], "--all-for-coverage") == 0)
- {
- coverage = true;
- if(ac > 2)
- {
- outname = av[2];
- }
- else
- {
- outname = 0;
- }
- }
- else
- {
- outname = av[1];
- }
- }
-
- if(coverage)
- {
- return DumpForCoverage(outname);
- }
- else
- {
- return DumpHTML(outname);
- }
-}