Commit 41c02ebc authored by Philippe Gerum's avatar Philippe Gerum

doc: prebuild

parent 75a32904

Too many changes to show.

To preserve performance only 1000 of 1000+ files are displayed.

......@@ -276,22 +276,11 @@ variables may be accessed from any code module.
=== Main thread shadowing ===
By default, any application linking against +libcobalt+ has its main
thread attached to the real-time system automatically, this process is
called _auto-shadowing_.
This behavior may be disabled at runtime, by setting the XENO_NOSHADOW
variable in the application process environment, before the
+libcobalt+ library constructors are executed.
This replaces the former static mechanism available with Xenomai 2.x,
based on turning on +--enable-dlopen-skins+ when configuring. Starting
with Xenomai 3.x, applications should set the XENO_NOSHADOW variable
using putenv(3), before loading +libcolbalt+ using dlopen(3).
When auto-shadowing is enabled, global memory locking is also
performed, and remains in effect afterwards
(i.e. mlockall(MCL_CURRENT|MCL_FUTURE)).
Any application linked against +libcobalt+ has its main thread
attached to the real-time system automatically, this operation is
called _auto-shadowing_. As a side-effect, the entire process's memory
is locked, for current and future mappings
(i.e. +mlockall(MCL_CURRENT|MCL_FUTURE)+).
=== Shadow signal handler ===
......
......@@ -577,11 +577,6 @@ does exist on the target kernel.
To support dynamic loading when `--enable-tls` is turned on,
the _global-dynamic_ TLS model is automatically selected.
[normal]
Applications loading `libcobalt.so` dynamically may want to
create the XENO_NOSHADOW environment variable prior to calling
`dlopen()`, to prevent auto-shadowing of the calling context.
[normal]
Dynamic loading of Xenomai-based libraries is disabled by
default.
......
......@@ -180,6 +180,10 @@ link:running-a-Xenomai-application-as-a-regular-user[this page].
=== incompatible ABI revision level
Same as below:
=== ABI mismatch
Each major Xenomai release (e.g. 2.1.x, 2.2.x ... 2.6.x, 3.0.x ...)
defines a kernel/user ABI, which remains stable across minor update
releases (e.g. 2.6.0 -> 2.6.1). This guarantee makes partial updates
......
......@@ -1006,10 +1006,10 @@ of all timers from the registered Xenomai clocks.
</dd>
</dl></div>
<div class="paragraph"><p>There is no kernel-based time base management anymore with Xenomai
3.0-rc5. Functionally speaking, only the former <em>master</em> time base
3.0-rc6. Functionally speaking, only the former <em>master</em> time base
remains, periodic timing is now controlled locally from the Xenomai
libraries in user-space.</p></div>
<div class="paragraph"><p>Xenomai 3.0-rc5 defines a built-in clock named <em>coreclk</em>, which has
<div class="paragraph"><p>Xenomai 3.0-rc6 defines a built-in clock named <em>coreclk</em>, which has
the same properties than the former <em>master</em> time base available with
Xenomai 2.x (i.e. tickless with nanosecond resolution).</p></div>
<div class="paragraph"><p>The settings of existing clocks can be read from entries under the new
......@@ -1153,19 +1153,11 @@ variables may be accessed from any code module.</p></div>
<div class="sectionbody">
<div class="sect2">
<h3 id="_main_thread_shadowing">4.1. Main thread shadowing</h3>
<div class="paragraph"><p>By default, any application linking against <code>libcobalt</code> has its main
thread attached to the real-time system automatically, this process is
called <em>auto-shadowing</em>.</p></div>
<div class="paragraph"><p>This behavior may be disabled at runtime, by setting the XENO_NOSHADOW
variable in the application process environment, before the
<code>libcobalt</code> library constructors are executed.</p></div>
<div class="paragraph"><p>This replaces the former static mechanism available with Xenomai 2.x,
based on turning on <code>--enable-dlopen-skins</code> when configuring. Starting
with Xenomai 3.x, applications should set the XENO_NOSHADOW variable
using putenv(3), before loading <code>libcolbalt</code> using dlopen(3).</p></div>
<div class="paragraph"><p>When auto-shadowing is enabled, global memory locking is also
performed, and remains in effect afterwards
(i.e. mlockall(MCL_CURRENT|MCL_FUTURE)).</p></div>
<div class="paragraph"><p>Any application linked against <code>libcobalt</code> has its main thread
attached to the real-time system automatically, this operation is
called <em>auto-shadowing</em>. As a side-effect, the entire process&#8217;s memory
is locked, for current and future mappings
(i.e. <code>mlockall(MCL_CURRENT|MCL_FUTURE)</code>).</p></div>
</div>
<div class="sect2">
<h3 id="_shadow_signal_handler">4.2. Shadow signal handler</h3>
......@@ -3461,7 +3453,7 @@ CC = $(shell $(CONFIG_CMD) --cc)</code></pre>
<div id="footnotes"><hr /></div>
<div id="footer">
<div id="footer-text">
Last updated 2015-06-23 15:36:01 CEST
Last updated 2015-07-26 18:21:49 CEST
</div>
</div>
</body>
......
......@@ -850,7 +850,7 @@ package is called <em>valgrind-devel</em> on Fedora.</td>
<div id="footnotes"><hr /></div>
<div id="footer">
<div id="footer-text">
Last updated 2015-06-23 15:36:01 CEST
Last updated 2015-07-26 18:21:49 CEST
</div>
</div>
</body>
......
......@@ -1460,9 +1460,6 @@ services are used internally (i.e. pthread_set/getspecific()).</p></div>
</p>
<div class="paragraph"><p>To support dynamic loading when <code>--enable-tls</code> is turned on,
the <em>global-dynamic</em> TLS model is automatically selected.</p></div>
<div class="paragraph"><p>Applications loading <code>libcobalt.so</code> dynamically may want to
create the XENO_NOSHADOW environment variable prior to calling
<code>dlopen()</code>, to prevent auto-shadowing of the calling context.</p></div>
<div class="paragraph"><p>Dynamic loading of Xenomai-based libraries is disabled by
default.</p></div>
</dd>
......@@ -2026,7 +2023,7 @@ Xenomai 3.x, you should have a look at
<div id="footnotes"><hr /></div>
<div id="footer">
<div id="footer-text">
Last updated 2015-06-23 15:36:01 CEST
Last updated 2015-07-26 18:21:49 CEST
</div>
</div>
</body>
......
......@@ -978,6 +978,10 @@ users to access Xenomai services, by following the instructions on
</div>
<div class="sect2">
<h3 id="_incompatible_abi_revision_level">2.4. incompatible ABI revision level</h3>
<div class="paragraph"><p>Same as below:</p></div>
</div>
<div class="sect2">
<h3 id="_abi_mismatch">2.5. ABI mismatch</h3>
<div class="paragraph"><p>Each major Xenomai release (e.g. 2.1.x, 2.2.x &#8230; 2.6.x, 3.0.x &#8230;)
defines a kernel/user ABI, which remains stable across minor update
releases (e.g. 2.6.0 &#8594; 2.6.1). This guarantee makes partial updates
......@@ -1003,7 +1007,7 @@ mismatch.</td>
</div>
</div>
<div class="sect2">
<h3 id="_lt_program_gt_not_found">2.5. &lt;program&gt;: not found</h3>
<h3 id="_lt_program_gt_not_found">2.6. &lt;program&gt;: not found</h3>
<div class="paragraph"><p>Although the program in question may be present, this message may
happen on ARM platforms when a mismatch exists between the kernel and
user library configurations with respect to EABI support. Typically,
......@@ -1014,7 +1018,7 @@ with an EABI toolchain won&#8217;t run on a kernel not enabling the
<code>CONFIG_AEABI</code> option.</p></div>
</div>
<div class="sect2">
<h3 id="_incompatible_feature_set">2.6. incompatible feature set</h3>
<h3 id="_incompatible_feature_set">2.7. incompatible feature set</h3>
<div class="paragraph"><p>When a Xenomai application starts, the set of core features it
requires is compared to the feature set the kernel provides. This
message denotes a mismatch between both sets, which can be solved by
......@@ -1022,7 +1026,7 @@ fixing the kernel and/or user build configuration. Further details
are available from <a href="installing-xenomai-3-x">this page</a> for Xenomai
3, and <a href="installing-xenomai-2-x">this page</a> for Xenomai 2.</p></div>
<div class="sect3">
<h4 id="_feature_mismatch_missing_smp_nosmp">2.6.1. feature mismatch: missing="smp/nosmp"</h4>
<h4 id="_feature_mismatch_missing_smp_nosmp">2.7.1. feature mismatch: missing="smp/nosmp"</h4>
<div class="paragraph"><p>On SMP-capable architectures, both kernel and user-space components
(i.e. Xenomai libraries) must be compiled with the same setting with
respect to SMP support.</p></div>
......@@ -1043,10 +1047,10 @@ support enabled over a single-processor kernel is fine.</td>
</div>
</div>
<div class="sect2">