From: g0dil <g0dil@270642c3-0616-0410-b53a-bc976706d245>
Date: Sun, 5 Oct 2008 22:08:10 +0000 (+0000)
Subject: Scheduler: Console 'events' command documentation
X-Git-Url: http://g0dil.de/git?a=commitdiff_plain;h=766eca0ea64f3d7de6f49279cf88d5e587c5a100;p=senf.git

Scheduler: Console 'events' command documentation

git-svn-id: https://svn.berlios.de/svnroot/repos/senf/trunk@929 270642c3-0616-0410-b53a-bc976706d245
---

diff --git a/Scheduler/Console/Executor.cc b/Scheduler/Console/Executor.cc
index 80d632f..5a6337d 100644
--- a/Scheduler/Console/Executor.cc
+++ b/Scheduler/Console/Executor.cc
@@ -232,7 +232,7 @@ prefix_ void senf::console::Executor::help(std::ostream & output,
                                            ParseCommandInfo::TokensRange path)
 {
     GenericNode const & node (traverseNode(path));
-    output << prettyName(typeid(node)) << " at " << node.path() << "\n\n";
+    // output << prettyName(typeid(node)) << " at " << node.path() << "\n\n";
     node.help(output);
     output << std::flush;
 }
diff --git a/Scheduler/Console/Executor.test.cc b/Scheduler/Console/Executor.test.cc
index a2b98ab..2c33677 100644
--- a/Scheduler/Console/Executor.test.cc
+++ b/Scheduler/Console/Executor.test.cc
@@ -148,7 +148,7 @@ BOOST_AUTO_UNIT_TEST(executor)
         parser.parse("help /dir2", &setCommand);
         executor(os, commands.back());
         BOOST_CHECK_EQUAL( commands.back().builtin(), senf::console::ParseCommandInfo::BuiltinHELP );
-        BOOST_CHECK_EQUAL( os.str(), "senf::console::DirectoryNode at /dir2\n\nHelptext\n" );
+        BOOST_CHECK_EQUAL( os.str(), "Helptext\n" );
     }
 
     {
diff --git a/Scheduler/EventManager.cc b/Scheduler/EventManager.cc
index fdea03a..aaf1622 100644
--- a/Scheduler/EventManager.cc
+++ b/Scheduler/EventManager.cc
@@ -39,7 +39,17 @@
 prefix_ senf::scheduler::detail::EventManager::EventManager()
 {
 #ifndef SENF_DISABLE_CONSOLE
-    consoleDir_().add("events", senf::membind(&EventManager::consoleEvents, this));
+    consoleDir_().add("events", senf::membind(&EventManager::consoleEvents, this))
+        .doc("List all scheduler events sorted by priority\n"
+             "\n"
+             "Columns:\n"
+             "    TP      event type: fd - file descriptor, tm - timer, si - UNIX signal\n"
+             "    NAME    descriptive event name\n"
+             "    ADDRESS address of event class instance\n"
+             "    RUNCNT  number of times, the event was called\n"
+             "    S       state: R - runnable, W - Waiting, '-' - event disabled\n"
+             "    INFO    further event specific information");
+
     senf::console::sysdir().add("scheduler", consoleDir_());
 #endif
 }