Module: xenomai-2.6
Branch: master
Commit: e335dbf32feaf29e2732b7f649824854637337cb
URL:    
http://git.xenomai.org/?p=xenomai-2.6.git;a=commit;h=e335dbf32feaf29e2732b7f649824854637337cb

Author: Gilles Chanteperdrix <gilles.chanteperd...@xenomai.org>
Date:   Mon Aug 26 21:23:40 2013 +0200

doc: add xeno-test and dohell manual pages

---

 doc/man/Makefile.am    |   12 +++++++--
 doc/man/Makefile.in    |   16 +++++++++----
 doc/man/dohell.adoc    |   55 ++++++++++++++++++++++++++++++++++++++++++++++++
 doc/man/xeno-test.adoc |   47 +++++++++++++++++++++++++++++++++++++++++
 4 files changed, 122 insertions(+), 8 deletions(-)

diff --git a/doc/man/Makefile.am b/doc/man/Makefile.am
index 80666a6..ac1b60c 100644
--- a/doc/man/Makefile.am
+++ b/doc/man/Makefile.am
@@ -11,7 +11,9 @@ HTML_DOCS = \
        switchbench \
        switchtest \
        xeno \
-       xeno-config
+       xeno-config \
+       xeno-test \
+       dohell
 
 EXTRA_DIST = \
        clocktest.adoc \
@@ -26,7 +28,9 @@ EXTRA_DIST = \
        switchbench.adoc \
        switchtest.adoc \
        xeno.adoc \
-       xeno-config.adoc
+       xeno-config.adoc \
+       xeno-test.adoc \
+       dohell
 
 man1_MANS = \
        clocktest.1 \
@@ -41,7 +45,9 @@ man1_MANS = \
        switchbench.1 \
        switchtest.1 \
        xeno.1 \
-       xeno-config.1
+       xeno-config.1 \
+       xeno-test.1 \
+       dohell.1
 
 if !CONFIG_XENO_ASCIIDOC
 HTML_DOCSDIR = $(srcdir)/../generated/html/
diff --git a/doc/man/Makefile.in b/doc/man/Makefile.in
index 5b4645f..9584e40 100644
--- a/doc/man/Makefile.in
+++ b/doc/man/Makefile.in
@@ -297,7 +297,9 @@ HTML_DOCS = \
        switchbench \
        switchtest \
        xeno \
-       xeno-config
+       xeno-config \
+       xeno-test \
+       dohell
 
 EXTRA_DIST = \
        clocktest.adoc \
@@ -312,7 +314,9 @@ EXTRA_DIST = \
        switchbench.adoc \
        switchtest.adoc \
        xeno.adoc \
-       xeno-config.adoc
+       xeno-config.adoc \
+       xeno-test.adoc \
+       dohell
 
 man1_MANS = \
        clocktest.1 \
@@ -327,7 +331,9 @@ man1_MANS = \
        switchbench.1 \
        switchtest.1 \
        xeno.1 \
-       xeno-config.1
+       xeno-config.1 \
+       xeno-test.1 \
+       dohell.1
 
 @CONFIG_XENO_ASCIIDOC_FALSE@HTML_DOCSDIR = $(srcdir)/../generated/html/
 @CONFIG_XENO_ASCIIDOC_TRUE@HTML_DOCSDIR = ./
@@ -621,9 +627,9 @@ uninstall-man: uninstall-man1
 @CONFIG_XENO_ASCIIDOC_TRUE@$(tmpdir)/%.txt: %.adoc Makefile 
$(top_srcdir)/doc/asciidoc/plaintext.conf 
$(top_srcdir)/doc/asciidoc/plaintext.xsl
 @CONFIG_XENO_ASCIIDOC_TRUE@    @$(mkdir_p) $(tmpdir)
 @CONFIG_XENO_ASCIIDOC_TRUE@    $(ASCIIDOC) --backend docbook -f 
$(top_srcdir)/doc/asciidoc/plaintext.conf \
-@CONFIG_XENO_ASCIIDOC_TRUE@            --doctype article $(ASCIIDOC_TXT_OPTS) \
+@CONFIG_XENO_ASCIIDOC_TRUE@            --doctype book $(ASCIIDOC_TXT_OPTS) \
 @CONFIG_XENO_ASCIIDOC_TRUE@            --out-file $(tmpdir)/$*.xml $<
-@CONFIG_XENO_ASCIIDOC_TRUE@    xsltproc --stringparam toc.section.depth 3 
--nonet \
+@CONFIG_XENO_ASCIIDOC_TRUE@    xsltproc --stringparam toc.section.depth 4 
--nonet \
 @CONFIG_XENO_ASCIIDOC_TRUE@            --output $(tmpdir)/$*.html 
$(top_srcdir)/doc/asciidoc/plaintext.xsl \
 @CONFIG_XENO_ASCIIDOC_TRUE@            $(tmpdir)/$*.xml
 @CONFIG_XENO_ASCIIDOC_TRUE@    w3m -cols 80 -dump -T text/html -no-graph 
$(tmpdir)/$*.html > $@
diff --git a/doc/man/dohell.adoc b/doc/man/dohell.adoc
new file mode 100644
index 0000000..945cfaa
--- /dev/null
+++ b/doc/man/dohell.adoc
@@ -0,0 +1,55 @@
+DOHELL(1)
+=========
+:doctype: manpage
+:revdata: 2013/08/25
+:man source: Xenomai
+:man version: {xenover}
+:man manual: Xenomai Manual
+
+NAME
+-----
+dohell - Generate load, in parallel of the latency test
+
+SYNOPSIS
+---------
+*dohell* [ -b <path> ] [ -s <server> ] [ -p <port> ] [ -m <path> ] [ -l <path> 
| <duration> ]
+
+DESCRIPTION
+------------
+
+*dohell* generates some load, using commonly available commands, in parallel 
+of the link:../latency/index.html[latency(1)] test or as part of 
+link:../xeno-test/index.html[xeno-test(1)]. 
+
+OPTIONS
+--------
+
+*dohell* accepts the following options: 
+
+*-b*:: runs the hackbench test repetitively during the run-time of the
+*dohell* script;
+
+*-s*:: run nc to continuously send data to a server through network;
+
+*-p*:: if *-s* is used, specificy the port to which to send data, if
+  not specified, port 9 (aka discard) is used;
+
+*-m <path>*:: run dd to write data to the *<path>* directory;
+
+*-l <path>*:: mutually exclusive with *<duration>*; the dohell script runs 
+during two runs of the LTP script *runalltests.sh* found in the *<path>* 
+directory;
+
+*<duration>*:: mutually exclusive with *-l*; run dohell for the given duration 
+in seconds.
+
+SEE ALSO
+--------
+
+link:../xeno-test/index.html[xeno-test(1)], 
link:../latency/index.html[latency(1)].
+
+EXAMPLE
+--------
+--------------------------------------------------------------------------------
+dohell -s 192.168.0.5 -m /mnt -l /ltp
+--------------------------------------------------------------------------------
diff --git a/doc/man/xeno-test.adoc b/doc/man/xeno-test.adoc
new file mode 100644
index 0000000..f20bb87
--- /dev/null
+++ b/doc/man/xeno-test.adoc
@@ -0,0 +1,47 @@
+XENO-TEST(1)
+============
+:doctype: manpage
+:revdata: 2013/08/25
+:man source: Xenomai
+:man version: {xenover}
+:man manual: Xenomai Manual
+
+NAME
+-----
+xeno-test - Run latency test under load
+
+SYNOPSIS
+---------
+*xeno-test* [ -l loadscript ] [ latency options ]
+
+DESCRIPTION
+------------
+
+*xeno-test* runs a series of test finishing with the latency test run
+with a user script to generate load, in order to measure the best case
+and worst case latencies. The default command used to generate load is
+"dohell 900".
+
+OPTIONS
+--------
+*xeno-test* accepts the following options:
+
+*-l <loadscript>*::
+run <loadscript> while running latency, in order to measure latency
+under load, the link:../dohell/index.html[dohell(1)] script is provided for
+this purpose, see its link:../dohell/index.html[manual page] for more details.
+
+*other options*::
+are passed to the latency test, see link:../latency/index.html[latency(1)] 
+for the list of supported options.
+
+SEE ALSO
+--------
+
+link:../dohell/index.html[dohell(1)], link:../latency/index.html[latency(1)].
+
+EXAMPLE
+--------
+--------------------------------------------------------------------------------
+xeno-test -l "dohell -s 192.168.0.5 -m /mnt -l /ltp" -p 100 -g histo
+--------------------------------------------------------------------------------


_______________________________________________
Xenomai-git mailing list
Xenomai-git@xenomai.org
http://www.xenomai.org/mailman/listinfo/xenomai-git

Reply via email to