Author: aconway
Date: Tue Oct 16 06:01:33 2007
New Revision: 585137
URL: http://svn.apache.org/viewvc?rev=585137&view=rev
Log:
Edits to --help message and man page to improve readabiliity.
Modified:
incubator/qpid/trunk/qpid/cpp/src/qpid/Options.cpp
incubator/qpid/trunk/qpid/cpp/src/qpid/Options.h
incubator/qpid/trunk/qpid/cpp/src/qpid/broker/Broker.cpp
incubator/qpid/trunk/qpid/cpp/src/qpid/cluster/ClusterPlugin.cpp
incubator/qpid/trunk/qpid/cpp/src/qpid/log/Options.cpp
incubator/qpid/trunk/qpid/cpp/src/qpidd.cpp
Modified: incubator/qpid/trunk/qpid/cpp/src/qpid/Options.cpp
URL:
http://svn.apache.org/viewvc/incubator/qpid/trunk/qpid/cpp/src/qpid/Options.cpp?rev=585137&r1=585136&r2=585137&view=diff
==============================================================================
--- incubator/qpid/trunk/qpid/cpp/src/qpid/Options.cpp (original)
+++ incubator/qpid/trunk/qpid/cpp/src/qpid/Options.cpp Tue Oct 16 06:01:33 2007
@@ -59,7 +59,7 @@
}
std::string prettyArg(const std::string& name, const std::string& value) {
- return value.empty() ? name+" " : name+" (="+value+") ";
+ return value.empty() ? name+" " : name+" ("+value+") ";
}
Options::Options(const string& name) : po::options_description(name) {}
@@ -104,9 +104,9 @@
: Options(name), config(configfile)
{
addOptions()
- ("help,h", optValue(help), "Print help message.")
- ("version,v", optValue(version), "Print version information.")
- ("config", optValue(config, "FILE"), "Configuration file.");
+ ("help,h", optValue(help), "Displays the help message")
+ ("version,v", optValue(version), "Displays version information")
+ ("config", optValue(config, "FILE"), "Reads configuration from FILE");
}
} // namespace qpid
Modified: incubator/qpid/trunk/qpid/cpp/src/qpid/Options.h
URL:
http://svn.apache.org/viewvc/incubator/qpid/trunk/qpid/cpp/src/qpid/Options.h?rev=585137&r1=585136&r2=585137&view=diff
==============================================================================
--- incubator/qpid/trunk/qpid/cpp/src/qpid/Options.h (original)
+++ incubator/qpid/trunk/qpid/cpp/src/qpid/Options.h Tue Oct 16 06:01:33 2007
@@ -98,7 +98,7 @@
MyOptions() : Options("My Options") {
addOptions()
("z", boolSwitch(z), "Option Z")
- ("foo", optValue(foo), "Multiple option foo.");
+ ("foo", optValue(foo), "Multiple option foo");
add(subOptions);
}
Modified: incubator/qpid/trunk/qpid/cpp/src/qpid/broker/Broker.cpp
URL:
http://svn.apache.org/viewvc/incubator/qpid/trunk/qpid/cpp/src/qpid/broker/Broker.cpp?rev=585137&r1=585136&r2=585137&view=diff
==============================================================================
--- incubator/qpid/trunk/qpid/cpp/src/qpid/broker/Broker.cpp (original)
+++ incubator/qpid/trunk/qpid/cpp/src/qpid/broker/Broker.cpp Tue Oct 16
06:01:33 2007
@@ -62,17 +62,18 @@
stagingThreshold(5000000)
{
addOptions()
- ("port,p", optValue(port,"PORT"), "Use PORT for AMQP connections.")
+ ("port,p", optValue(port,"PORT"),
+ "Tells the broker to listen on PORT")
("worker-threads", optValue(workerThreads, "N"),
- "Broker thread pool size")
+ "Sets the broker thread pool size")
("max-connections", optValue(maxConnections, "N"),
- "Maximum allowed connections")
+ "Sets the maximum allowed connections")
("connection-backlog", optValue(connectionBacklog, "N"),
- "Connection backlog limit for server socket.")
+ "Sets the connection backlog limit for the server socket")
("staging-threshold", optValue(stagingThreshold, "N"),
- "Messages over N bytes are staged to disk.")
+ "Stages messages over N bytes to disk")
("store,s", optValue(store,"LIBNAME"),
- "Name of message store shared library.");
+ "Tells the broker to use the message store shared library LIBNAME for
persistence");
}
const std::string empty;
Modified: incubator/qpid/trunk/qpid/cpp/src/qpid/cluster/ClusterPlugin.cpp
URL:
http://svn.apache.org/viewvc/incubator/qpid/trunk/qpid/cpp/src/qpid/cluster/ClusterPlugin.cpp?rev=585137&r1=585136&r2=585137&view=diff
==============================================================================
--- incubator/qpid/trunk/qpid/cpp/src/qpid/cluster/ClusterPlugin.cpp (original)
+++ incubator/qpid/trunk/qpid/cpp/src/qpid/cluster/ClusterPlugin.cpp Tue Oct 16
06:01:33 2007
@@ -37,7 +37,7 @@
ClusterOptions() : Options("Cluster Options") {
addOptions()
("cluster", optValue(clusterName, "NAME"),
- "Join the cluster named NAME");
+ "Joins the cluster named NAME");
}
};
Modified: incubator/qpid/trunk/qpid/cpp/src/qpid/log/Options.cpp
URL:
http://svn.apache.org/viewvc/incubator/qpid/trunk/qpid/cpp/src/qpid/log/Options.cpp?rev=585137&r1=585136&r2=585137&view=diff
==============================================================================
--- incubator/qpid/trunk/qpid/cpp/src/qpid/log/Options.cpp (original)
+++ incubator/qpid/trunk/qpid/cpp/src/qpid/log/Options.cpp Tue Oct 16 06:01:33
2007
@@ -36,19 +36,21 @@
for (int i = 1; i < LevelTraits::COUNT; ++i)
levels << " " << LevelTraits::name(Level(i));
addOptions()
- ("trace,t", optValue(trace), "Enable full debug tracing." )
+ ("log.output", optValue(outputs, "FILE"),
+ "Send log output to FILE. "
+ "FILE can be a file name or one of the special values:\n"
+ "stderr, stdout, syslog")
+ ("trace,t", optValue(trace), "Enables all logging" )
("log.enable", optValue(selectors, "RULE"),
- ("You can specify this option mutliple times.\n"
- "RULE is of the form 'LEVEL[+][:COMPONENT]'"
- "Levels are: "+levels.str()+"\n"
+ ("Enables logging for selected levels and components. "
+ "RULE is in the form 'LEVEL[+][:COMPONENT]' "
+ "Levels are one of: \n\t "+levels.str()+"\n"
"For example:\n"
"\t'--log.enable warning+' "
- "enables all warning, error and critical messages.\n"
+ "logs all warning, error and critical messages.\n"
"\t'--log.enable debug:framing' "
- "enables debug messages from the framing component.").c_str())
- ("log.output", optValue(outputs, "FILE"),
- "File to receive log output, or one of these special values: "
- "'stderr', 'stdout', 'syslog'.")
+ "logs debug messages from the framing component. "
+ "This option can be used multiple times").c_str())
("log.time", optValue(time, "yes|no"),
"Include time in log messages")
("log.level", optValue(level,"yes|no"),
Modified: incubator/qpid/trunk/qpid/cpp/src/qpidd.cpp
URL:
http://svn.apache.org/viewvc/incubator/qpid/trunk/qpid/cpp/src/qpidd.cpp?rev=585137&r1=585136&r2=585137&view=diff
==============================================================================
--- incubator/qpid/trunk/qpid/cpp/src/qpidd.cpp (original)
+++ incubator/qpid/trunk/qpid/cpp/src/qpidd.cpp Tue Oct 16 06:01:33 2007
@@ -47,10 +47,10 @@
DaemonOptions() : qpid::Options("Daemon options"), daemon(false),
quit(false), check(false), wait(10)
{
addOptions()
- ("daemon,d", optValue(daemon), "Run as a daemon. With --port 0
print actual listening port.")
- ("wait,w", optValue(wait, "SECONDS"), "Maximum wait for daemon
response.")
- ("check,c", optValue(check), "If a daemon is running print its pid
to stdout and return 0.")
- ("quit,q", optValue(quit), "Stop the running daemon politely.");
+ ("daemon,d", optValue(daemon), "Run as a daemon.")
+ ("wait,w", optValue(wait, "SECONDS"), "Sets the maximum wait time
to initialize the daemon. If the daemon fails to initialize, prints an error
and returns 1")
+ ("check,c", optValue(check), "Prints the daemon's process ID to
stdout and returns 0 if the daemon is running, otherwise returns 1")
+ ("quit,q", optValue(quit), "Tells the daemon to shut down");
}
};
