ynkmr/Sourcetrail
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

ui: Improved help texts of CLI

Browse Source
This commit is contained in:
Eberhard Graether
2017-08-22 13:46:04 +02:00
parent efe280bbc1
commit 86a26be6d6
4 changed files with 15 additions and 15 deletions
Download Patch File Download Diff File Expand all files Collapse all files
src/lib/utility/commandline/CommandLineParser.cpp
+5 -5
View File
@@ -32,7 +32,7 @@ void CommandLineParser::setup()
options.add_options()
("help,h", "Print this help message")
("version,v", "Version of Sourcetrail")
("project-file", po::value<std::string>(), "Open Sourcetrail with this project")
("project-file", po::value<std::string>(), "Open Sourcetrail with this project (.srctrlprj)")
;
m_options.add(options);
@@ -159,7 +159,7 @@ License* CommandLineParser::getLicensePtr()
void CommandLineParser::printHelp() const
{
std::cout << "Usage:\n sourcetrail [command] [option...] [positional arguments]\n\n";
std::cout << "Usage:\n Sourcetrail [command] [option...] [positional arguments]\n\n";
// Commands
std::cout << "Commands:\n";
@@ -167,7 +167,7 @@ void CommandLineParser::printHelp() const
{
std::cout << " " << Command->name() << "\n";
}
std::cout << "\n * Each Commands has his own --help\n";
std::cout << "\n * Each command has its own --help\n";
std::cout << m_options << std::endl;
@@ -230,7 +230,7 @@ void CommandLineParser::processProjectfile()
if (m_projectFile.extension() != ".srctrlprj" && m_projectFile.extension() != ".coatiproject")
{
m_errorString = errorstring + " has a wrong fileending";
m_errorString = errorstring + " has a wrong file ending";
m_projectFile = FilePath();
return;
}
@@ -238,7 +238,7 @@ void CommandLineParser::processProjectfile()
std::shared_ptr<ConfigManager> configManager = ConfigManager::createEmpty();
if (!configManager->load(TextAccess::createFromFile(m_projectFile)))
{
m_errorString = errorstring + " could not be loaded(invalid)";
m_errorString = errorstring + " could not be loaded (invalid)";
m_projectFile = FilePath();
return;
}
src/lib/utility/commandline/commands/CommandlineCommand.cpp
+1 -1
View File
@@ -22,7 +22,7 @@ const std::string Command::name()
void Command::printHelp()
{
std::cout << "Usage:\n sourcetrail "
std::cout << "Usage:\n Sourcetrail "
<< m_name << " [option...]\n\n";
std::cout << m_options << std::endl;
if (m_positional.max_total_count() > 0)
src/lib/utility/commandline/commands/CommandlineCommandConfig.cpp
+7 -7
View File
@@ -92,24 +92,24 @@ void CommandConfig::setup()
po::options_description options("Config Options");
options.add_options()
("help,h", "Print this help message")
("indexerthreads,t", po::value<int>(), "Set the number of threads used for indexing")
("indexer-threads,t", po::value<int>(), "Set the number of threads used for indexing (0 uses ideal thread count)")
("use-processes,p", po::value<bool>(), "Enable C/C++ Indexer threads to run in different processes. <true/false>")
("logging-enabled,l", po::value<bool>(), "Enable file/console logging <true/false>")
("verbose-indexer-logging-enabled,L", po::value<bool>(),
"Enable additional log of abstract syntax tree during the indexing. <true/false> WARNINIG Slows down the indexing process")
"Enable additional log of abstract syntax tree during the indexing. <true/false> WARNINIG Slows down indexing speed")
("jvm-path,j", po::value<std::string>(), "Path to the location of the jvm library")
("jvm-max-memory,M", po::value<int>(),
"Set the maximum amount of memory for the JVM indexer(-1 for using the JVM default settings)")
("maven-path,m", po::value<std::string>(), "Path to the maven binary")
("jre-system-library-paths,J", po::value<std::vector<std::string>>(),
"paths to the jars of the JRE system library. "
"These jars can be found inside your JRE install directory(once per path or comma separated)")
"These jars can be found inside your JRE install directory (once per path or comma separated)")
("license-file,z", po::value<std::string>(), "Enter license via Licensefile")
("license-string,Z", po::value<std::string>(), "Enter licenes via commandline")
("global-header-search-paths,g", po::value<std::vector<std::string>>(),
"Global include paths(once per path or comma separated)")
"Global include paths (once per path or comma separated)")
("global-framework-search-paths,F", po::value<std::vector<std::string>>(),
"Global include paths(once per path or comma separated)")
"Global include paths (once per path or comma separated)")
("show,s", "displays all settings")
;
@@ -132,7 +132,7 @@ void printVector(const std::string& title, const std::vector<FilePath>& vec)
void CommandConfig::printSettings(ApplicationSettings* settings)
{
std::cout << "Sourcetrail Settings:\n"
<< "\n indexerthread count: " << settings->getIndexerThreadCount()
<< "\n indexer-threads: " << settings->getIndexerThreadCount()
<< "\n use-processes: " << settings->getMultiProcessIndexingEnabled()
<< "\n logging-enabled: " << settings->getLoggingEnabled()
<< "\n verbose-indexer-logging-enabled: " << settings->getVerboseIndexerLoggingEnabled()
@@ -195,7 +195,7 @@ ReturnStatus CommandConfig::parse(std::vector<std::string>& args)
vm
);
parseAndSetValue(&ApplicationSettings::setIndexerThreadCount, "indexerthreads", settings, vm);
parseAndSetValue(&ApplicationSettings::setIndexerThreadCount, "indexer-threads", settings, vm);
parseAndSetValue(&ApplicationSettings::setJavaMaximumMemory, "jvm-max-memory", settings, vm);
parseAndSetValue(&ApplicationSettings::setMavenPath, "maven-path", settings, vm);
src/lib/utility/commandline/commands/CommandlineCommandIndex.cpp
+2 -2
View File
@@ -20,8 +20,8 @@ void CommandIndex::setup()
po::options_description options("Config Options");
options.add_options()
("help,h", "Print this help message")
("full", "Paths for Sourcefiles")
("project-file", po::value<std::string>(), "Project file to index")
("full,f", "Index full project (omit to only index new/changed files)")
("project-file", po::value<std::string>(), "Project file to index (.srctrlprj)")
;
m_options.add(options);