Module: xenomai-forge
Branch: master
Commit: f4384791be568a91c4f7fe9c426aee4bcb6bd1eb

Author: Philippe Gerum <>
Date:   Fri Sep 26 11:43:49 2014 +0200

doc/autotune: clarify some points


 doc/asciidoc/MIGRATION.adoc     |    3 +++
 doc/asciidoc/man1/autotune.adoc |    7 ++++---
 utils/autotune/autotune.c       |    2 +-
 3 files changed, 8 insertions(+), 4 deletions(-)

diff --git a/doc/asciidoc/MIGRATION.adoc b/doc/asciidoc/MIGRATION.adoc
index 0790e9f..ce1c416 100644
--- a/doc/asciidoc/MIGRATION.adoc
+++ b/doc/asciidoc/MIGRATION.adoc
@@ -1390,6 +1390,9 @@ receipts, as explained <<userirqtip,here>>.
 === Timing services ===
+- +rt_timer_inquire()+ has a void return type, instead of always
+  returning zero as previously.
 - +rt_timer_set_mode()+ is obsolete. The clock resolution has become a
 per-process setting, which should be set using the
 +--alchemy-clock-resolution+ switch on the command line.
diff --git a/doc/asciidoc/man1/autotune.adoc b/doc/asciidoc/man1/autotune.adoc
index c099130..efea67e 100644
--- a/doc/asciidoc/man1/autotune.adoc
+++ b/doc/asciidoc/man1/autotune.adoc
@@ -82,13 +82,13 @@ platform needs to deliver an IRQ to a user-space 
task/thread running
 in a Xenomai application process. This delay includes the context
 switching time.
-**--period <ns>*::
+*--period <ns>*::
 Set the sampling period to the given count of nanoseconds. The
 estimation is performed by measuring the jitter between the ideal time
 at which a timer tick should be received, and the actual time it is
 eventually received, for a series of ticks. This value expresses the
 delay between two of these ticks. If too short, a lockup might
-occur. A commonly observed result is: the larger the delay, the higher
+occur. A commonly observed result is that the larger the delay, the higher
 the latency, due to CPU cache effects (i.e. the real-time code/data is
 more likely to get evicted from the cachelines as the non real-time
 activity can slip in, treading over a larger address space).
@@ -125,7 +125,8 @@ running for 30 seconds is common.
 Once the gravity values are known for a particular hardware, one may
 write them to +/proc/xenomai/clock/coreclck+ from some system init
-script to set up the Xenomai core clock accordingly, e.g:
+script to set up the Xenomai core clock accordingly, instead of
+running the auto-tuner after each boot e.g:
     /* change the user gravity to 1728 ns (default) */
diff --git a/utils/autotune/autotune.c b/utils/autotune/autotune.c
index b9bccd9..1c13084 100644
--- a/utils/autotune/autotune.c
+++ b/utils/autotune/autotune.c
@@ -283,7 +283,7 @@ int main(int argc, char *const argv[])
                if (!nohog)
                if (!quiet)
-                       printf("Auto-tuning started, period=%dns (may take a 
+                       printf("Auto-tuning started, period=%d ns (may take a 
        } else
                nohog = 1;

Xenomai-git mailing list

Reply via email to