Module: xenomai-3
Branch: next
Commit: b044b5f86fef13135f4da0f82f897fd573fca741
URL:
http://git.xenomai.org/?p=xenomai-3.git;a=commit;h=b044b5f86fef13135f4da0f82f897fd573fca741
Author: Philippe Gerum <r...@xenomai.org>
Date: Tue Mar 24 10:55:24 2015 +0100
doc/asciidoc: update guides
---
doc/asciidoc/MIGRATION.adoc | 7 +++---
doc/asciidoc/README.APPLICATIONS.adoc | 9 ++++---
doc/asciidoc/README.INSTALL.adoc | 44 ++++++++++++++++++++-------------
3 files changed, 35 insertions(+), 25 deletions(-)
diff --git a/doc/asciidoc/MIGRATION.adoc b/doc/asciidoc/MIGRATION.adoc
index ecb6b48..9f1e0ab 100644
--- a/doc/asciidoc/MIGRATION.adoc
+++ b/doc/asciidoc/MIGRATION.adoc
@@ -105,8 +105,8 @@ follows:
----------------------------------------------------------------------------
/mount-point /* registry fs root, defaults to /var/run/xenomai */
- [/user] /* user name, missing if "anon" session */
- /session /* shared session name or "anon" */
+ /user /* user name */
+ /session /* shared session name or anon@<pid> */
/pid /* application (main) pid */
/skin /* API name: alchemy/vxworks/psos/... */
/family /* object class (task, semaphore, ...) */
@@ -117,8 +117,7 @@ follows:
Each leaf entry under a session hierarchy is normally viewable, for
retrieving the information attached to the corresponding object, such
as its state, and/or value. There can be multiple sessions hosted
-under a single registry mount point. Session-less application
-processes are grouped under the special "anon" hierarchy.
+under a single registry mount point.
The /system hierarchy provides information about the current state of
the Xenomai core, aggregating data from all processes which belong to
diff --git a/doc/asciidoc/README.APPLICATIONS.adoc
b/doc/asciidoc/README.APPLICATIONS.adoc
index 5bdffea..bd236a5 100644
--- a/doc/asciidoc/README.APPLICATIONS.adoc
+++ b/doc/asciidoc/README.APPLICATIONS.adoc
@@ -85,8 +85,8 @@ link:installing-xenomai-3-x[configuration switch]).
*--no-registry*::
This switch disables registry support at runtime. No real-time
- objects will be exported to +/var/run/xenomai/[<user>/]<session>/<pid>+,
- despite the registry code was compiled in.
+ objects will be exported to +/var/run/xenomai+, despite the
+ registry code was compiled in.
*--no-sanity*::
*--sanity*::
@@ -118,11 +118,12 @@ link:installing-xenomai-3-x[configuration switch]).
[normal]
This label is also used to form the registry mount point for
- each process, e.g. +/var/run/xenomai/[<user>/]<session>/<pid>+.
+ each process, e.g. +/var/run/xenomai/<user>/<session>/<pid>+.
See +--enable-registry+ from the build options.
[normal]
- By default, _anon_ is used as the session label.
+ By default, `anon@<pid>` is used as the session label, with <pid>
+ equal to the system identifier of the process.
*--reset*::
diff --git a/doc/asciidoc/README.INSTALL.adoc b/doc/asciidoc/README.INSTALL.adoc
index f2e2d08..efec3aa 100644
--- a/doc/asciidoc/README.INSTALL.adoc
+++ b/doc/asciidoc/README.INSTALL.adoc
@@ -350,6 +350,9 @@ although this is not mandatory if building with
`--disable-tls`.
the target kernel running the real-time applications. In addition,
the FUSE development libraries must be available from the toolchain.
+- The autoconf (>= 2.62), automake and libtool packages must be
+ available on your build system.
+
_Cobalt_-specific requirements
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
@@ -374,10 +377,18 @@ _Mercury_-specific requirement
Configuring
~~~~~~~~~~~
-A common autoconf script prepares for building the libraries and
-programs, for both the _Cobalt_ and _Mercury_ cores. The core-specific
-code which may be needed internally is automatically and transparently
-selected at compilation-time by the build process.
+First, the `configure` script and Makefiles must be generated in the
+Xenomai source tree. The recommended way is to run the automatic
+reconfiguration script shipped, from the top of the source tree:
+
+---------------------
+$ ./scripts/bootstrap
+---------------------
+
+When run, the generated `configure` script prepares for building the
+libraries and programs, for both the _Cobalt_ and _Mercury_ cores. The
+core-specific code which may be needed internally is automatically and
+transparently selected at compilation-time by the build process.
The options listed below can be passed to this script.
@@ -466,21 +477,20 @@ Generic configuration options (both cores)
CONFIG_FUSE_FS must be enabled in the target kernel.
[normal]
- When this option is enabled, the system creates a file
- hierachy under `/var/run/xenomai/[<user>/]<session>/<pid>`
- (by default), where you can access the internal state of the
- active real-time objects. The session label is obtained from
- the --session runtime switch. If left out, it is "anon" and
- the user name is not inserted as well. E.g. looking at the
- properties of a VxWorks task could be done as follows:
+When this option is enabled, the system creates a file hierachy under
+`/var/run/xenomai/<user>/<session>/<pid>`, where you can access the
+internal state of the active real-time objects. The session label is
+obtained from the --session runtime switch. If no session name is
+specified, `anon@<pid>` will be used. E.g. looking at the properties
+of a VxWorks task could be done as follows:
--------------------------------------------------------------------
- $ cat /var/run/xenomai/anon.12656/vxworks/tasks/windTask
- name = windTask
- errno = 0
- status = ready
- priority = 70
- lock_depth = 0
+$ cat /var/run/xenomai/root/anon@12656/12656/vxworks/tasks/windTask
+name = windTask
+errno = 0
+status = ready
+priority = 70
+lock_depth = 0
--------------------------------------------------------------------
[normal]
_______________________________________________
Xenomai-git mailing list
Xenomai-git@xenomai.org
http://www.xenomai.org/mailman/listinfo/xenomai-git
