Commit f68a0208 authored by Philippe Gerum's avatar Philippe Gerum

doc: build

parent d99e3f21
......@@ -3474,7 +3474,7 @@ CC = $(shell $(CONFIG_CMD) --cc)</code></pre>
<div id="footnotes"><hr /></div>
<div id="footer">
<div id="footer-text">
Last updated 2017-02-15 15:31:41 CET
Last updated 2017-04-02 16:42:05 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 2017-02-15 15:31:41 CET
Last updated 2017-04-02 16:42:05 CEST
</div>
</div>
</body>
......
......@@ -2027,7 +2027,7 @@ Xenomai 3.x, you should have a look at
<div id="footnotes"><hr /></div>
<div id="footer">
<div id="footer-text">
Last updated 2017-02-15 15:31:41 CET
Last updated 2017-04-02 16:42:05 CEST
</div>
</div>
</body>
......
......@@ -1486,7 +1486,7 @@ allocation requests.</p></div>
<div id="footnotes"><hr /></div>
<div id="footer">
<div id="footer-text">
Last updated 2017-02-15 15:31:41 CET
Last updated 2017-04-02 16:42:05 CEST
</div>
</div>
</body>
......
......@@ -775,7 +775,7 @@ way to gain those capabilities.</p></div>
<div id="footnotes"><hr /></div>
<div id="footer">
<div id="footer-text">
Last updated 2017-02-15 15:31:41 CET
Last updated 2017-04-02 16:42:05 CEST
</div>
</div>
</body>
......
......@@ -755,7 +755,7 @@ XENO-CONFIG(1) Manual Page
<div class="paragraph"><p><strong>xeno-config</strong> <strong>--info</strong></p></div>
<div class="paragraph"><p><strong>xeno-config</strong> <strong>--core</strong></p></div>
<div class="paragraph"><p><strong>xeno-config</strong> <strong>--version</strong></p></div>
<div class="paragraph"><p><strong>xeno-config</strong> [<strong>--cc</strong>] [<strong>--ccld</strong>] [<strong>--arch</strong>] [<strong>--prefix</strong>] [<strong>--posix|alchemy|rtdm|psos|vxworks|smokey</strong>] [<strong>--compat</strong>] [<strong>--auto-init</strong>|<strong>no-auto-init</strong>] [<strong>--auto-init-solib</strong>] [<strong>--cflags</strong>] [<strong>--ldflags</strong>] [<strong>--library-dir</strong>|<strong>--libdir</strong>|<strong>--user-libdir</strong>]</p></div>
<div class="paragraph"><p><strong>xeno-config</strong> [<strong>--cc</strong>] [<strong>--ccld</strong>] [<strong>--arch</strong>] [<strong>--prefix</strong>] [<strong>--posix|alchemy|rtdm|psos|vxworks|smokey</strong>] [<strong>--compat</strong>] [<strong>--auto-init</strong>|<strong>no-auto-init</strong>] [<strong>--auto-init-solib</strong>] [<strong>--mode-check</strong>|<strong>no-mode-check</strong>] [<strong>--cflags</strong>] [<strong>--ldflags</strong>] [<strong>--library-dir</strong>|<strong>libdir</strong>|<strong>user-libdir</strong>]</p></div>
</div>
</div>
<div class="sect1">
......@@ -929,6 +929,28 @@ only. <strong>xeno-config</strong> enables the Copperplate auto-init feature by
default.</p></div>
<div class="dlist"><dl>
<dt class="hdlist1">
<strong>--mode-check</strong>
</dt>
<dt class="hdlist1">
<strong>--no-mode-check</strong>
</dt>
<dd>
<p>
Over Cobalt, a set of standard routines which may invoke regular Linux
system calls can trigger an assertion failure on entry, if the caller
must leave the real-time mode (aka "secondary mode switch") to execute
such routine.
</p>
</dd>
</dl></div>
<div class="paragraph"><p>The assertion failure is triggered if the calling thread has set the
PTHREAD_WARNSW flag by a call to <code>pthread_setmode_np()</code>.</p></div>
<div class="paragraph"><p>By default, the mode checking routines are substituted to the original
ones using the symbol wrapping mechanism also used for interposing on
POSIX services. <strong>--no-mode-check</strong> disables such substitution.</p></div>
<div class="paragraph"><p>These flags make sense when passed along with --ldflags only.</p></div>
<div class="dlist"><dl>
<dt class="hdlist1">
<strong>--auto-init-solib</strong>
</dt>
<dd>
......@@ -943,7 +965,7 @@ used for bootstrapping the initialization.
<div class="paragraph"><p>The bootstrap code runs when the shared library is attached to a
running executable, either because it appears in the static
dependencies of this executable, or when loaded dynamically via the
dlopen() interface.</p></div>
<code>dlopen()</code> interface.</p></div>
<div class="dlist"><dl>
<dt class="hdlist1">
<strong>--core</strong>
......@@ -1045,7 +1067,7 @@ Error.
<div id="footnotes"><hr /></div>
<div id="footer">
<div id="footer-text">
Last updated 2016-12-16 10:06:33 CET
Last updated 2017-04-02 10:22:34 CEST
</div>
</div>
</body>
......
......@@ -154,7 +154,7 @@ $(document).ready(function(){initNavTree('driver_8h_source.html','');});
<div class="ttc" id="group__rtdm__task_html_gae52cca97ebaf78eec2e31553a4dacd5e"><div class="ttname"><a href="group__rtdm__task.html#gae52cca97ebaf78eec2e31553a4dacd5e">rtdm_task_unblock</a></div><div class="ttdeci">int rtdm_task_unblock(rtdm_task_t *task)</div><div class="ttdoc">Activate a blocked real-time task. </div></div>
<div class="ttc" id="structrtdm__dev__context_html_a8fea6f19169a166aa183d2e9da09df51"><div class="ttname"><a href="structrtdm__dev__context.html#a8fea6f19169a166aa183d2e9da09df51">rtdm_dev_context::device</a></div><div class="ttdeci">struct rtdm_device * device</div><div class="ttdoc">Set of active device operation handlers. </div><div class="ttdef"><b>Definition:</b> driver.h:141</div></div>
<div class="ttc" id="group__rtdm__sync__event_html_ga1217402b82034b26fe25c26f1e5b32c9"><div class="ttname"><a href="group__rtdm__sync__event.html#ga1217402b82034b26fe25c26f1e5b32c9">rtdm_event_signal</a></div><div class="ttdeci">void rtdm_event_signal(rtdm_event_t *event)</div><div class="ttdoc">Signal an event occurrence. </div><div class="ttdef"><b>Definition:</b> drvlib.c:783</div></div>
<div class="ttc" id="group__cobalt__core__synch_html_ga51cec970cb57608abe882c98bee72347"><div class="ttname"><a href="group__cobalt__core__synch.html#ga51cec970cb57608abe882c98bee72347">xnsynch_sleep_on</a></div><div class="ttdeci">int xnsynch_sleep_on(struct xnsynch *synch, xnticks_t timeout, xntmode_t timeout_mode)</div><div class="ttdoc">Sleep on an ownerless synchronization object. </div><div class="ttdef"><b>Definition:</b> synch.c:162</div></div>
<div class="ttc" id="group__cobalt__core__synch_html_ga51cec970cb57608abe882c98bee72347"><div class="ttname"><a href="group__cobalt__core__synch.html#ga51cec970cb57608abe882c98bee72347">xnsynch_sleep_on</a></div><div class="ttdeci">int __must_check xnsynch_sleep_on(struct xnsynch *synch, xnticks_t timeout, xntmode_t timeout_mode)</div><div class="ttdoc">Sleep on an ownerless synchronization object. </div><div class="ttdef"><b>Definition:</b> synch.c:162</div></div>
<div class="ttc" id="group__rtdm__sync__mutex_html_ga8d58a144bf71df7b38bb887d036cbbb5"><div class="ttname"><a href="group__rtdm__sync__mutex.html#ga8d58a144bf71df7b38bb887d036cbbb5">rtdm_mutex_init</a></div><div class="ttdeci">void rtdm_mutex_init(rtdm_mutex_t *mutex)</div><div class="ttdoc">Initialise a mutex. </div><div class="ttdef"><b>Definition:</b> drvlib.c:1241</div></div>
<div class="ttc" id="group__rtdm__clock_html_ga861a79090031b981c627107248cf2d14"><div class="ttname"><a href="group__rtdm__clock.html#ga861a79090031b981c627107248cf2d14">rtdm_clock_read_monotonic</a></div><div class="ttdeci">nanosecs_abs_t rtdm_clock_read_monotonic(void)</div><div class="ttdoc">Get monotonic time. </div></div>
<div class="ttc" id="group__rtdm__util_html_gab42031be84dba5825ac90dbf28606c54"><div class="ttname"><a href="group__rtdm__util.html#gab42031be84dba5825ac90dbf28606c54">rtdm_rt_capable</a></div><div class="ttdeci">int rtdm_rt_capable(struct rtdm_fd *fd)</div><div class="ttdoc">Test if the caller is capable of running in real-time context. </div></div>
......
......@@ -92,7 +92,7 @@ Functions</h2></td></tr>
<tr class="memitem:gadd862461f55506485f04f4f98cdb6fb8"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__cobalt__core__synch.html#gadd862461f55506485f04f4f98cdb6fb8">xnsynch_destroy</a> (struct xnsynch *synch)</td></tr>
<tr class="memdesc:gadd862461f55506485f04f4f98cdb6fb8"><td class="mdescLeft">&#160;</td><td class="mdescRight">Destroy a synchronization object. <a href="#gadd862461f55506485f04f4f98cdb6fb8">More...</a><br /></td></tr>
<tr class="separator:gadd862461f55506485f04f4f98cdb6fb8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga51cec970cb57608abe882c98bee72347"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__cobalt__core__synch.html#ga51cec970cb57608abe882c98bee72347">xnsynch_sleep_on</a> (struct xnsynch *synch, xnticks_t timeout, xntmode_t timeout_mode)</td></tr>
<tr class="memitem:ga51cec970cb57608abe882c98bee72347"><td class="memItemLeft" align="right" valign="top">int __must_check&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__cobalt__core__synch.html#ga51cec970cb57608abe882c98bee72347">xnsynch_sleep_on</a> (struct xnsynch *synch, xnticks_t timeout, xntmode_t timeout_mode)</td></tr>
<tr class="memdesc:ga51cec970cb57608abe882c98bee72347"><td class="mdescLeft">&#160;</td><td class="mdescRight">Sleep on an ownerless synchronization object. <a href="#ga51cec970cb57608abe882c98bee72347">More...</a><br /></td></tr>
<tr class="separator:ga51cec970cb57608abe882c98bee72347"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga54162964059c62d7a7b45ef22911662f"><td class="memItemLeft" align="right" valign="top">struct xnthread *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__cobalt__core__synch.html#ga54162964059c62d7a7b45ef22911662f">xnsynch_wakeup_one_sleeper</a> (struct xnsynch *synch)</td></tr>
......@@ -101,10 +101,10 @@ Functions</h2></td></tr>
<tr class="memitem:ga8096364cd5d717dae816c74dcc05a8ac"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__cobalt__core__synch.html#ga8096364cd5d717dae816c74dcc05a8ac">xnsynch_wakeup_this_sleeper</a> (struct xnsynch *synch, struct xnthread *sleeper)</td></tr>
<tr class="memdesc:ga8096364cd5d717dae816c74dcc05a8ac"><td class="mdescLeft">&#160;</td><td class="mdescRight">Unblock a particular thread from wait. <a href="#ga8096364cd5d717dae816c74dcc05a8ac">More...</a><br /></td></tr>
<tr class="separator:ga8096364cd5d717dae816c74dcc05a8ac"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga43fa3ecdc81f6ae157f840175c7ea091"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__cobalt__core__synch.html#ga43fa3ecdc81f6ae157f840175c7ea091">xnsynch_acquire</a> (struct xnsynch *synch, xnticks_t timeout, xntmode_t timeout_mode)</td></tr>
<tr class="memitem:ga43fa3ecdc81f6ae157f840175c7ea091"><td class="memItemLeft" align="right" valign="top">int __must_check&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__cobalt__core__synch.html#ga43fa3ecdc81f6ae157f840175c7ea091">xnsynch_acquire</a> (struct xnsynch *synch, xnticks_t timeout, xntmode_t timeout_mode)</td></tr>
<tr class="memdesc:ga43fa3ecdc81f6ae157f840175c7ea091"><td class="mdescLeft">&#160;</td><td class="mdescRight">Acquire the ownership of a synchronization object. <a href="#ga43fa3ecdc81f6ae157f840175c7ea091">More...</a><br /></td></tr>
<tr class="separator:ga43fa3ecdc81f6ae157f840175c7ea091"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gad5cad7eeaa18834c9ba8843511a67628"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__cobalt__core__synch.html#gad5cad7eeaa18834c9ba8843511a67628">xnsynch_try_acquire</a> (struct xnsynch *synch)</td></tr>
<tr class="memitem:gad5cad7eeaa18834c9ba8843511a67628"><td class="memItemLeft" align="right" valign="top">int __must_check&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__cobalt__core__synch.html#gad5cad7eeaa18834c9ba8843511a67628">xnsynch_try_acquire</a> (struct xnsynch *synch)</td></tr>
<tr class="memdesc:gad5cad7eeaa18834c9ba8843511a67628"><td class="mdescLeft">&#160;</td><td class="mdescRight">Try acquiring the ownership of a synchronization object. <a href="#gad5cad7eeaa18834c9ba8843511a67628">More...</a><br /></td></tr>
<tr class="separator:gad5cad7eeaa18834c9ba8843511a67628"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gad38fe2be85e02bf1298418674ab6386f"><td class="memItemLeft" align="right" valign="top">struct xnthread *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__cobalt__core__synch.html#gad38fe2be85e02bf1298418674ab6386f">xnsynch_release</a> (struct xnsynch *synch, struct xnthread *thread)</td></tr>
......
......@@ -2,12 +2,12 @@
.\" Title: dohell
.\" Author: [FIXME: author] [see http://docbook.sf.net/el/author]
.\" Generator: DocBook XSL Stylesheets v1.79.1 <http://docbook.sf.net/>
.\" Date: 02/15/2017
.\" Date: 04/02/2017
.\" Manual: Xenomai Manual
.\" Source: Xenomai 3.0.4
.\" Language: English
.\"
.TH "DOHELL" "1" "02/15/2017" "Xenomai 3\&.0\&.4" "Xenomai Manual"
.TH "DOHELL" "1" "04/02/2017" "Xenomai 3\&.0\&.4" "Xenomai Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
......
......@@ -43,7 +43,7 @@ xeno-config \- Retrieve Xenomai build flags and configuration
.sp
\fBxeno\-config\fR \fB\-\-version\fR
.sp
\fBxeno\-config\fR [\fB\-\-cc\fR] [\fB\-\-ccld\fR] [\fB\-\-arch\fR] [\fB\-\-prefix\fR] [\fB\-\-posix|alchemy|rtdm|psos|vxworks|smokey\fR] [\fB\-\-compat\fR] [\fB\-\-auto\-init\fR|\fBno\-auto\-init\fR] [\fB\-\-auto\-init\-solib\fR] [\fB\-\-cflags\fR] [\fB\-\-ldflags\fR] [\fB\-\-library\-dir\fR|\fB\-\-libdir\fR|\fB\-\-user\-libdir\fR]
\fBxeno\-config\fR [\fB\-\-cc\fR] [\fB\-\-ccld\fR] [\fB\-\-arch\fR] [\fB\-\-prefix\fR] [\fB\-\-posix|alchemy|rtdm|psos|vxworks|smokey\fR] [\fB\-\-compat\fR] [\fB\-\-auto\-init\fR|\fBno\-auto\-init\fR] [\fB\-\-auto\-init\-solib\fR] [\fB\-\-mode\-check\fR|\fBno\-mode\-check\fR] [\fB\-\-cflags\fR] [\fB\-\-ldflags\fR] [\fB\-\-library\-dir\fR|\fBlibdir\fR|\fBuser\-libdir\fR]
.SH "DESCRIPTION"
.sp
\fBxeno\-config\fR is a shell script which is aimed at retrieving the Xenomai build configuration data, such as the compiler and linker flags required for building applications\&. For this reason, \fBxeno\-config\fR is typically used in Makefiles\&.
......@@ -162,6 +162,17 @@ any real\-time service is invoked\&.
.sp
This flag makes sense when passed along with \-\-ldflags only\&. \fBxeno\-config\fR enables the Copperplate auto\-init feature by default\&.
.PP
\fB\-\-mode\-check\fR, \fB\-\-no\-mode\-check\fR
.RS 4
Over Cobalt, a set of standard routines which may invoke regular Linux system calls can trigger an assertion failure on entry, if the caller must leave the real\-time mode (aka "secondary mode switch") to execute such routine\&.
.RE
.sp
The assertion failure is triggered if the calling thread has set the PTHREAD_WARNSW flag by a call to pthread_setmode_np()\&.
.sp
By default, the mode checking routines are substituted to the original ones using the symbol wrapping mechanism also used for interposing on POSIX services\&. \fB\-\-no\-mode\-check\fR disables such substitution\&.
.sp
These flags make sense when passed along with \-\-ldflags only\&.
.PP
\fB\-\-auto\-init\-solib\fR
.RS 4
This switch enables the auto\-initialization feature described above for a shared library target instead of a pure executable\&. The main difference resides in a position\-independent (PIC) glue code being used for bootstrapping the initialization\&.
......
......@@ -2,12 +2,12 @@
.\" Title: xeno-test
.\" Author: [FIXME: author] [see http://docbook.sf.net/el/author]
.\" Generator: DocBook XSL Stylesheets v1.79.1 <http://docbook.sf.net/>
.\" Date: 02/15/2017
.\" Date: 04/02/2017
.\" Manual: Xenomai Manual
.\" Source: Xenomai 3.0.4
.\" Language: English
.\"
.TH "XENO\-TEST" "1" "02/15/2017" "Xenomai 3\&.0\&.4" "Xenomai Manual"
.TH "XENO\-TEST" "1" "04/02/2017" "Xenomai 3\&.0\&.4" "Xenomai Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment