Skip to content

GitLab

Commit 0c39a757 authored by Brad King's avatar Brad King
Browse files

Drop the 'Full' field from cmDocumentationEntry 

We need only 'Brief' for usage documentation.  We no longer have builtin
'Full' documentation, which is now in Help/*/*.rst files.
parent e33d8d2d
Hide whitespace changes
Inline Side-by-side
Showing with 187 additions and 663 deletions
Source/CPack/cpack.cxx
View file @ 0c39a757
......@@ -27,92 +27,42 @@
#include <cmsys/SystemTools.hxx>
//----------------------------------------------------------------------------
static const char * cmDocumentationName[][3] =
static const char * cmDocumentationName[][2] =
{
{0,
" cpack - Packaging driver provided by CMake.", 0},
{0,0,0}
" cpack - Packaging driver provided by CMake."},
{0,0}
};
//----------------------------------------------------------------------------
static const char * cmDocumentationUsage[][3] =
static const char * cmDocumentationUsage[][2] =
{
{0,
" cpack -G <generator> [options]",
0},
{0,0,0}
" cpack -G <generator> [options]"},
{0,0}
};
//----------------------------------------------------------------------------
static const char * cmDocumentationOptions[][3] =
static const char * cmDocumentationOptions[][2] =
{
{"-G <generator>", "Use the specified generator to generate package.",
"CPack may support multiple native packaging systems on certain "
"platforms. A generator is responsible for generating input files for "
"particular system and invoking that systems. Possible generator names "
"are specified in the Generators section." },
{"-C <Configuration>", "Specify the project configuration",
"This option specifies the configuration that the project was build "
"with, for example 'Debug', 'Release'." },
{"-D <var>=<value>", "Set a CPack variable.", \
"Set a variable that can be used by the generator."}, \
{"--config <config file>", "Specify the config file.",
"Specify the config file to use to create the package. By default "
"CPackConfig.cmake in the current directory will be used." },
{"--verbose,-V","enable verbose output","Run cpack with verbose output."},
{"--debug","enable debug output (for CPack developers)",
"Run cpack with debug output (for CPack developers)."},
{"-P <package name>","override/define CPACK_PACKAGE_NAME",
"If the package name is not specified on cpack commmand line then"
"CPack.cmake defines it as CMAKE_PROJECT_NAME"},
{"-R <package version>","override/define CPACK_PACKAGE_VERSION",
"If version is not specified on cpack command line then"
"CPack.cmake defines it from CPACK_PACKAGE_VERSION_[MAJOR|MINOR|PATCH]"
"look into CPack.cmake for detail"},
{"-B <package directory>","override/define CPACK_PACKAGE_DIRECTORY",
"The directory where CPack will be doing its packaging work."
"The resulting package will be found there. Inside this directory"
"CPack creates '_CPack_Packages' sub-directory which is the"
"CPack temporary directory."},
{"--vendor <vendor name>","override/define CPACK_PACKAGE_VENDOR",
"If vendor is not specified on cpack command line "
"(or inside CMakeLists.txt) then"
"CPack.cmake defines it with a default value"},
{"--help-command cmd [file]", "Print help for a single command and exit.",
"Full documentation specific to the given command is displayed. "
"If a file is specified, the documentation is written into and the output "
"format is determined depending on the filename suffix. Supported are man "
"page, HTML, DocBook and plain text."},
{"--help-command-list [file]", "List available commands and exit.",
"The list contains all commands for which help may be obtained by using "
"the --help-command argument followed by a command name. "
"If a file is specified, the documentation is written into and the output "
"format is determined depending on the filename suffix. Supported are man "
"page, HTML, DocBook and plain text."},
{"--help-commands [file]", "Print help for all commands and exit.",
"Full documentation specific for all current command is displayed."
"If a file is specified, the documentation is written into and the output "
"format is determined depending on the filename suffix. Supported are man "
"page, HTML, DocBook and plain text."},
{"-G <generator>", "Use the specified generator to generate package."},
{"-C <Configuration>", "Specify the project configuration"},
{"-D <var>=<value>", "Set a CPack variable."},
{"--config <config file>", "Specify the config file."},
{"--verbose,-V","enable verbose output"},
{"--debug","enable debug output (for CPack developers)"},
{"-P <package name>","override/define CPACK_PACKAGE_NAME"},
{"-R <package version>","override/define CPACK_PACKAGE_VERSION"},
{"-B <package directory>","override/define CPACK_PACKAGE_DIRECTORY"},
{"--vendor <vendor name>","override/define CPACK_PACKAGE_VENDOR"},
{"--help-command cmd [file]", "Print help for a single command and exit."},
{"--help-command-list [file]", "List available commands and exit."},
{"--help-commands [file]", "Print help for all commands and exit."},
{"--help-variable var [file]",
"Print help for a single variable and exit.",
"Full documentation specific to the given variable is displayed."
"If a file is specified, the documentation is written into and the output "
"format is determined depending on the filename suffix. Supported are man "
"page, HTML, DocBook and plain text."},
{"--help-variable-list [file]", "List documented variables and exit.",
"The list contains all variables for which help may be obtained by using "
"the --help-variable argument followed by a variable name. If a file is "
"specified, the help is written into it."
"If a file is specified, the documentation is written into and the output "
"format is determined depending on the filename suffix. Supported are man "
"page, HTML, DocBook and plain text."},
{"--help-variables [file]", "Print help for all variables and exit.",
"Full documentation for all variables is displayed."
"If a file is specified, the documentation is written into and the output "
"format is determined depending on the filename suffix. Supported are man "
"page, HTML, DocBook and plain text."},
{0,0,0}
"Print help for a single variable and exit."},
{"--help-variable-list [file]", "List documented variables and exit."},
{"--help-variables [file]", "Print help for all variables and exit."},
{0,0}
};
//----------------------------------------------------------------------------
......@@ -522,7 +472,6 @@ int main (int argc, char *argv[])
cmDocumentationEntry e;
e.Name = generatorIt->first.c_str();
e.Brief = generatorIt->second.c_str();
e.Full = "";
v.push_back(e);
}
doc.SetSection("Generators",v);
......
Source/CursesDialog/ccmake.cxx
View file @ 0c39a757
......@@ -23,27 +23,27 @@
#include <form.h>
//----------------------------------------------------------------------------
static const char * cmDocumentationName[][3] =
static const char * cmDocumentationName[][2] =
{
{0,
" ccmake - Curses Interface for CMake.", 0},
{0,0,0}
" ccmake - Curses Interface for CMake."},
{0,0}
};
//----------------------------------------------------------------------------
static const char * cmDocumentationUsage[][3] =
static const char * cmDocumentationUsage[][2] =
{
{0,
" ccmake <path-to-source>\n"
" ccmake <path-to-existing-build>", 0},
{0,0,0}
" ccmake <path-to-existing-build>"},
{0,0}
};
//----------------------------------------------------------------------------
static const char * cmDocumentationOptions[][3] =
static const char * cmDocumentationOptions[][2] =
{
CMAKE_STANDARD_OPTIONS_TABLE,
{0,0,0}
{0,0}
};
cmCursesForm* cmCursesForm::CurrentForm=0;
......
Source/QtDialog/CMakeSetup.cxx
View file @ 0c39a757
......@@ -23,27 +23,27 @@
#include <cmsys/SystemTools.hxx>
//----------------------------------------------------------------------------
static const char * cmDocumentationName[][3] =
static const char * cmDocumentationName[][2] =
{
{0,
" cmake-gui - CMake GUI.", 0},
{0,0,0}
" cmake-gui - CMake GUI."},
{0,0}
};
//----------------------------------------------------------------------------
static const char * cmDocumentationUsage[][3] =
static const char * cmDocumentationUsage[][2] =
{
{0,
" cmake-gui [options]\n"
" cmake-gui [options] <path-to-source>\n"
" cmake-gui [options] <path-to-existing-build>", 0},
{0,0,0}
" cmake-gui [options] <path-to-existing-build>"},
{0,0}
};
//----------------------------------------------------------------------------
static const char * cmDocumentationOptions[][3] =
static const char * cmDocumentationOptions[][2] =
{
{0,0,0}
{0,0}
};
int main(int argc, char** argv)
......
Source/cmDocumentation.cxx
View file @ 0c39a757
......@@ -23,35 +23,23 @@
#include <algorithm>
//----------------------------------------------------------------------------
static const char *cmDocumentationStandardOptions[][3] =
{
{"--copyright [file]", "Print the CMake copyright and exit.",
"If a file is specified, the copyright is written into it."},
{"--help,-help,-usage,-h,-H,/?", "Print usage information and exit.",
"Usage describes the basic command line interface and its options."},
{"--help-full [file]", "Print full help and exit.",
"Full help displays most of the documentation provided by the UNIX "
"man page. It is provided for use on non-UNIX platforms, but is "
"also convenient if the man page is not installed. If a file is "
"specified, the help is written into it."},
{"--help-html [file]", "Print full help in HTML format.",
"This option is used by CMake authors to help produce web pages. "
"If a file is specified, the help is written into it."},
{"--help-man [file]", "Print full help as a UNIX man page and exit.",
"This option is used by the cmake build to generate the UNIX man page. "
"If a file is specified, the help is written into it."},
{"--version,-version,/V [file]",
"Show program name/version banner and exit.",
"If a file is specified, the version is written into it."},
{0,0,0}
static const char *cmDocumentationStandardOptions[][2] =
{
{"--copyright [file]", "Print the CMake copyright and exit."},
{"--help,-help,-usage,-h,-H,/?", "Print usage information and exit."},
{"--help-full [file]", "Print full help and exit."},
{"--help-html [file]", "Print full help in HTML format."},
{"--help-man [file]", "Print full help as a UNIX man page and exit."},
{"--version,-version,/V [file]"},
{0,0}
};
//----------------------------------------------------------------------------
static const char *cmDocumentationGeneratorsHeader[][3] =
static const char *cmDocumentationGeneratorsHeader[][2] =
{
{0,
"The following generators are available on this platform:", 0},
{0,0,0}
"The following generators are available on this platform:"},
{0,0}
};
//----------------------------------------------------------------------------
......@@ -468,7 +456,7 @@ void cmDocumentation::SetSection(const char *name,
//----------------------------------------------------------------------------
void cmDocumentation::SetSection(const char *name,
const char *docs[][3])
const char *docs[][2])
{
cmDocumentationSection *sec =
new cmDocumentationSection(name,
......@@ -490,7 +478,7 @@ void cmDocumentation
//----------------------------------------------------------------------------
void cmDocumentation::PrependSection(const char *name,
const char *docs[][3])
const char *docs[][2])
{
cmDocumentationSection *sec = 0;
if (this->AllSections.find(name) == this->AllSections.end())
......@@ -526,7 +514,7 @@ void cmDocumentation::PrependSection(const char *name,
//----------------------------------------------------------------------------
void cmDocumentation::AppendSection(const char *name,
const char *docs[][3])
const char *docs[][2])
{
cmDocumentationSection *sec = 0;
if (this->AllSections.find(name) == this->AllSections.end())
......
Source/cmDocumentation.h
View file @ 0c39a757
......@@ -65,19 +65,19 @@ public:
void SetSection(const char *sectionName,
std::vector<cmDocumentationEntry> &docs);
void SetSection(const char *sectionName,
const char *docs[][3]);
const char *docs[][2]);
void SetSections(std::map<std::string,cmDocumentationSection *>
&sections);
/** Add the documentation to the beginning/end of the section */
void PrependSection(const char *sectionName,
const char *docs[][3]);
const char *docs[][2]);
void PrependSection(const char *sectionName,
std::vector<cmDocumentationEntry> &docs);
void PrependSection(const char *sectionName,
cmDocumentationEntry &docs);
void AppendSection(const char *sectionName,
const char *docs[][3]);
const char *docs[][2]);
void AppendSection(const char *sectionName,
std::vector<cmDocumentationEntry> &docs);
void AppendSection(const char *sectionName,
......
Source/cmDocumentationSection.cxx
View file @ 0c39a757
......@@ -13,69 +13,33 @@
//----------------------------------------------------------------------------
void cmDocumentationSection::Append(const char *data[][3])
void cmDocumentationSection::Append(const char *data[][2])
{
int i = 0;
while(data[i][1])
{
this->Entries.push_back(cmDocumentationEntry(data[i][0],
data[i][1],
data[i][2]));
data[i][1]));
data += 1;
}
}
//----------------------------------------------------------------------------
void cmDocumentationSection::Prepend(const char *data[][3])
void cmDocumentationSection::Prepend(const char *data[][2])
{
std::vector<cmDocumentationEntry> tmp;
int i = 0;
while(data[i][1])
{
tmp.push_back(cmDocumentationEntry(data[i][0],
data[i][1],
data[i][2]));
data[i][1]));
data += 1;
}
this->Entries.insert(this->Entries.begin(),tmp.begin(),tmp.end());
}
//----------------------------------------------------------------------------
void cmDocumentationSection::Append(const char *n, const char *b,
const char *f)
void cmDocumentationSection::Append(const char *n, const char *b)
{
this->Entries.push_back(cmDocumentationEntry(n,b,f));
this->Entries.push_back(cmDocumentationEntry(n,b));
}
#if 0
//----------------------------------------------------------------------------
void cmDocumentationSection::Set(const cmDocumentationEntry* header,
const cmDocumentationEntry* section,
const cmDocumentationEntry* footer)
{
this->Entries.erase(this->Entries.begin(), this->Entries.end());
if(header)
{
for(const cmDocumentationEntry* op = header; op->brief; ++op)
{
this->Entries.push_back(*op);
}
}
if(section)
{
for(const cmDocumentationEntry* op = section; op->brief; ++op)
{
this->Entries.push_back(*op);
}
}
if(footer)
{
for(const cmDocumentationEntry* op = footer; op->brief; ++op)
{
this->Entries.push_back(*op);
}
}
cmDocumentationEntry empty = {0,0,0};
this->Entries.push_back(empty);
}
#endif
Source/cmDocumentationSection.h
View file @ 0c39a757
......@@ -48,11 +48,11 @@ public:
{ this->Entries.insert(this->Entries.end(),entries.begin(),entries.end()); }
/** Append an entry to this section using NULL terminated chars */
void Append(const char *[][3]);
void Append(const char *n, const char *b, const char *f);
void Append(const char *[][2]);
void Append(const char *n, const char *b);
/** prepend some documentation to this section */
void Prepend(const char *[][3]);
void Prepend(const char *[][2]);
void Prepend(const std::vector<cmDocumentationEntry> &entries)
{ this->Entries.insert(this->Entries.begin(),
entries.begin(),entries.end()); }
......
Source/cmExtraCodeBlocksGenerator.cxx
View file @ 0c39a757
......@@ -42,13 +42,6 @@ void cmExtraCodeBlocksGenerator
{
entry.Name = this->GetName();
entry.Brief = "Generates CodeBlocks project files.";
entry.Full =
"Project files for CodeBlocks will be created in the top directory "
"and in every subdirectory which features a CMakeLists.txt file "
"containing a PROJECT() call. "
"Additionally a hierarchy of makefiles is generated into the "
"build tree. The appropriate make program can build the project through "
"the default make target. A \"make install\" target is also provided.";
}
cmExtraCodeBlocksGenerator::cmExtraCodeBlocksGenerator()
......
Source/cmExtraEclipseCDT4Generator.cxx
View file @ 0c39a757
......@@ -48,13 +48,6 @@ void cmExtraEclipseCDT4Generator
{
entry.Name = this->GetName();
entry.Brief = "Generates Eclipse CDT 4.0 project files.";
entry.Full =
"Project files for Eclipse will be created in the top directory. "
"In out of source builds, a linked resource to the top level source "
"directory will be created. "
"Additionally a hierarchy of makefiles is generated into the "
"build tree. The appropriate make program can build the project through "
"the default make target. A \"make install\" target is also provided.";
}
//----------------------------------------------------------------------------
......
Source/cmExtraSublimeTextGenerator.cxx
View file @ 0c39a757
......@@ -45,13 +45,6 @@ void cmExtraSublimeTextGenerator
{
entry.Name = this->GetName();
entry.Brief = "Generates Sublime Text 2 project files.";
entry.Full =
"Project files for Sublime Text 2 will be created in the top directory "
"and in every subdirectory which features a CMakeLists.txt file "
"containing a PROJECT() call. "
"Additionally Makefiles (or build.ninja files) are generated into the "
"build tree. The appropriate make program can build the project through "
"the default make target. A \"make install\" target is also provided.";
}
cmExtraSublimeTextGenerator::cmExtraSublimeTextGenerator()
......
Source/cmGlobalBorlandMakefileGenerator.cxx
View file @ 0c39a757
......@@ -59,5 +59,4 @@ void cmGlobalBorlandMakefileGenerator
{
entry.Name = cmGlobalBorlandMakefileGenerator::GetActualName();
entry.Brief = "Generates Borland makefiles.";
entry.Full = "";
}
Source/cmGlobalJOMMakefileGenerator.cxx
View file @ 0c39a757
......@@ -65,5 +65,4 @@ void cmGlobalJOMMakefileGenerator
{
entry.Name = cmGlobalJOMMakefileGenerator::GetActualName();
entry.Brief = "Generates JOM makefiles.";
entry.Full = "";
}
Source/cmGlobalKdevelopGenerator.cxx
View file @ 0c39a757
......@@ -28,16 +28,6 @@ void cmGlobalKdevelopGenerator
{
entry.Name = this->GetName();
entry.Brief = "Generates KDevelop 3 project files.";
entry.Full =
"Project files for KDevelop 3 will be created in the top directory "
"and in every subdirectory which features a CMakeLists.txt file "
"containing a PROJECT() call. "
"If you change the settings using KDevelop cmake will try its best "
"to keep your changes when regenerating the project files. "
"Additionally a hierarchy of UNIX makefiles is generated into the "
"build tree. Any "
"standard UNIX-style make program can build the project through the "
"default make target. A \"make install\" target is also provided.";
}
cmGlobalKdevelopGenerator::cmGlobalKdevelopGenerator()
......
Source/cmGlobalMSYSMakefileGenerator.cxx
View file @ 0c39a757
......@@ -110,6 +110,4 @@ void cmGlobalMSYSMakefileGenerator
{
entry.Name = cmGlobalMSYSMakefileGenerator::GetActualName();
entry.Brief = "Generates MSYS makefiles.";
entry.Full = "The makefiles use /bin/sh as the shell. "
"They require msys to be installed on the machine.";
}
Source/cmGlobalMinGWMakefileGenerator.cxx
View file @ 0c39a757
......@@ -49,6 +49,4 @@ void cmGlobalMinGWMakefileGenerator
{
entry.Name = cmGlobalMinGWMakefileGenerator::GetActualName();
entry.Brief = "Generates a make file for use with mingw32-make.";
entry.Full = "The makefiles generated use cmd.exe as the shell. "
"They do not require msys or a unix shell.";
}
Source/cmGlobalNMakeMakefileGenerator.cxx
View file @ 0c39a757
......@@ -65,5 +65,4 @@ void cmGlobalNMakeMakefileGenerator
{
entry.Name = cmGlobalNMakeMakefileGenerator::GetActualName();
entry.Brief = "Generates NMake makefiles.";
entry.Full = "";
}
Source/cmGlobalNinjaGenerator.cxx
View file @ 0c39a757
......@@ -470,10 +470,6 @@ void cmGlobalNinjaGenerator
{
entry.Name = cmGlobalNinjaGenerator::GetActualName();
entry.Brief = "Generates build.ninja files (experimental).";
entry.Full =
"A build.ninja file is generated into the build tree. Recent "
"versions of the ninja program can build the project through the "
"\"all\" target. An \"install\" target is also provided.";
}
// Implemented in all cmGlobaleGenerator sub-classes.
......
Source/cmGlobalUnixMakefileGenerator3.cxx
View file @ 0c39a757
......@@ -65,10 +65,6 @@ void cmGlobalUnixMakefileGenerator3
{
entry.Name = cmGlobalUnixMakefileGenerator3::GetActualName();
entry.Brief = "Generates standard UNIX makefiles.";
entry.Full =
"A hierarchy of UNIX makefiles is generated into the build tree. Any "
"standard UNIX-style make program can build the project through the "
"default make target. A \"make install\" target is also provided.";
}
//----------------------------------------------------------------------------
......
Source/cmGlobalVisualStudio10Generator.cxx
View file @ 0c39a757
......@@ -48,11 +48,6 @@ public:
virtual void GetDocumentation(cmDocumentationEntry& entry) const {
entry.Name = "Visual Studio 10";
entry.Brief = "Generates Visual Studio 10 (2010) project files.";
entry.Full =
"It is possible to append a space followed by the platform name "
"to create project files for a specific target platform. E.g. "
"\"Visual Studio 10 Win64\" will create project files for "
"the x64 processor; \"Visual Studio 10 IA64\" for Itanium.";
}
virtual void GetGenerators(std::vector<std::string>& names) const {
......
Source/cmGlobalVisualStudio11Generator.cxx
View file @ 0c39a757
......@@ -68,11 +68,6 @@ public:
virtual void GetDocumentation(cmDocumentationEntry& entry) const {
entry.Name = "Visual Studio 11";
entry.Brief = "Generates Visual Studio 11 (2012) project files.";
entry.Full =
"It is possible to append a space followed by the platform name "
"to create project files for a specific target platform. E.g. "
"\"Visual Studio 11 Win64\" will create project files for "
"the x64 processor; \"Visual Studio 11 ARM\" for ARM.";
}
virtual void GetGenerators(std::vector<std::string>& names) const {
......
Source/cmGlobalVisualStudio12Generator.cxx
View file @ 0c39a757
......@@ -43,11 +43,6 @@ public:
virtual void GetDocumentation(cmDocumentationEntry& entry) const {
entry.Name = "Visual Studio 12";
entry.Brief = "Generates Visual Studio 12 (2013) project files.";
entry.Full =
"It is possible to append a space followed by the platform name "
"to create project files for a specific target platform. E.g. "
"\"Visual Studio 12 Win64\" will create project files for "
"the x64 processor; \"Visual Studio 12 ARM\" for ARM.";
}
virtual void GetGenerators(std::vector<std::string>& names) const {
......
Source/cmGlobalVisualStudio6Generator.cxx
View file @ 0c39a757
......@@ -405,7 +405,6 @@ void cmGlobalVisualStudio6Generator
{
entry.Name = cmGlobalVisualStudio6Generator::GetActualName();
entry.Brief = "Generates Visual Studio 6 project files.";
entry.Full = "";
}
//----------------------------------------------------------------------------
......
Source/cmGlobalVisualStudio71Generator.cxx
View file @ 0c39a757
......@@ -313,5 +313,4 @@ void cmGlobalVisualStudio71Generator
{
entry.Name = cmGlobalVisualStudio71Generator::GetActualName();
entry.Brief = "Generates Visual Studio .NET 2003 project files.";
entry.Full = "";
}
Source/cmGlobalVisualStudio7Generator.cxx
View file @ 0c39a757
......@@ -841,7 +841,6 @@ void cmGlobalVisualStudio7Generator
{
entry.Name = cmGlobalVisualStudio7Generator::GetActualName();
entry.Brief = "Generates Visual Studio .NET 2002 project files.";
entry.Full = "";
}
//----------------------------------------------------------------------------
......
Source/cmGlobalVisualStudio8Generator.cxx
View file @ 0c39a757
......@@ -65,11 +65,6 @@ public:
virtual void GetDocumentation(cmDocumentationEntry& entry) const {
entry.Name = vs8generatorName;
entry.Brief = "Generates Visual Studio 8 2005 project files.";
entry.Full =
"It is possible to append a space followed by the platform name "
"to create project files for a specific target platform. E.g. "
"\"Visual Studio 8 2005 Win64\" will create project files for "
"the x64 processor.";
}
virtual void GetGenerators(std::vector<std::string>& names) const {
......@@ -147,7 +142,6 @@ void cmGlobalVisualStudio8Generator
{
entry.Name = cmGlobalVisualStudio8Generator::GetActualName();
entry.Brief = "Generates Visual Studio 8 2005 project files.";
entry.Full = "";
}
//----------------------------------------------------------------------------
......
Source/cmGlobalVisualStudio9Generator.cxx
View file @ 0c39a757
......@@ -70,11 +70,6 @@ public:
virtual void GetDocumentation(cmDocumentationEntry& entry) const {
entry.Name = vs9generatorName;
entry.Brief = "Generates Visual Studio 9 2008 project files.";
entry.Full =