x-coding3.html

vxworks相关论文

<pre class="CodeLeft"><b><a name="85014">/************************************************* 
* 
* xxxFunc - do such and such</a></b></pre>

</td>

</tr>
<tr valign="top">
<td colspan=1 rowspan=1>
<p class="BodyLeft"><a name="85024"> </a>INCORRECT:</p>

</td>
<td colspan=1 rowspan=1>
<pre class="CodeLeft"><b><a name="85026">/************************************************* 
* 
* xxxFunc() - do such and such</a></b></pre>

</td>

</tr>

<tr>
<td colspan="20">
<hr class="tablerule">
</td>
</tr>
<tr valign="middle">
<td colspan="20">

</td>
</tr>
</table>
</p>
</div>
<br>
<dd><div class="Indent"><a name="84665"> </a>Avoid using a library, driver, or routine name as the first word in a sentence, but if you must, do not capitalize it.</div>
<br>
</dl>

<p class="listspace">
<ul class="Bullet" type="disc"><li><a name="84666"> </a><b>Terminal Keys:</b>&nbsp;&nbsp;Enter the names of terminal keys in all uppercase, as in <kbd>TAB</kbd> or <kbd>ESC</kbd>. Prefix the names of control characters with <kbd>CTRL+</kbd>; for example, <kbd>CTRL+C</kbd>. </li></ul>
</p>
<p class="listspace">
<ul class="Bullet" type="disc"><li><a name="84667"> </a><font face="Helvetica, sans-serif" size="-1" class="sans"><b class="hb">References to Publications:</b></font>&nbsp;&nbsp;References to chapters of publications should take the form <i class="textVariable">Title</i>: <i class="textVariable">Chapter</i>. For example, you might say:</li></ul>
</p>
<dl class="margin">

<dl class="margin">

<dd><div class="Indent2"><a name="84668"> </a>For more information, see the <i class="title">VxWorks Programmer's Guide: I/O System</i>. </div>
<br>
</dl>

</dl>

<dl class="margin">

<dd><div class="Indent"><a name="84669"> </a>References to documentation volumes should be set off in italics.&nbsp;For general cases, use the <b class="symbol_UC">.I</b> macro.&nbsp;However, in SEE ALSO sections, use the <b class="symbol_UC">.pG</b> and <b class="symbol_UC">.tG</b> macros for the <i class="textVariable">VxWorks Programmer's Guide</i> and <i class="textVariable">Tornado User's Guide</i>, respectively. </div>
<br>
</dl>

<p class="listspace">
<ul class="Bullet" type="disc"><li><a name="84670"> </a><b>Section-Number Cross-References:</b>&nbsp;&nbsp;Do not use the UNIX parentheses-plus-number scheme to cross-reference the documentation sections for libraries and routines:<p class="table">

<table border="0" cellpadding="0" cellspacing="0">
<tr>
<td colspan="20">
<hr class="tablerule">
</td>
</tr>
<tr valign="top">
<td colspan=1 rowspan=1>
<p class="BodyLeft"><a name="84979"> </a>CORRECT: </p>

</td>
<td colspan=1 rowspan=1>
<pre class="CodeLeft"><b><a name="84981">sysLib, vxTas()</a></b></pre>

</td>

</tr>
<tr valign="top">
<td colspan=1 rowspan=1>
<p class="BodyLeft"><a name="84983"> </a>INCORRECT: </p>

</td>
<td colspan=1 rowspan=1>
<pre class="CodeLeft"><b><a name="84985">sysLib(1), vxTas(2)</a></b></pre>

</td>

</tr>

<tr>
<td colspan="20">
<hr class="tablerule">
</td>
</tr>
<tr valign="middle">
<td colspan="20">

</td>
</tr>
</table>
</p>
</li></ul>
</p>
</dl>

</dl>

<div class="Anchor"><a name="84972"> </a><p class="table">
<h4 class="EntityTitle"><a name="84676"><font face="Helvetica, sans-serif" size="-1" class="sans">Table I-1:&nbsp;&nbsp;Format of Special Elements</font></a></h4>

<table border="0" cellpadding="0" cellspacing="0">
<tr>
<td colspan="20">
<hr class="tablerule">
</td>
</tr>
<tr valign="middle">
<th rowspan="1" colspan="1">
<div class="CellHeading"><b><a name="84682"> </a><font face="Helvetica, sans-serif" size="-1" class="sans">Component</font></b></div>
</th>

<th rowspan="1" colspan="1">
<div class="CellHeading"><b><a name="84684"> </a><font face="Helvetica, sans-serif" size="-1" class="sans">Input</font></b></div>
</th>

<th rowspan="1" colspan="1">
<div class="CellHeading"><b><a name="84686"> </a><font face="Helvetica, sans-serif" size="-1" class="sans">Output (mangen + troff)</font></b></div>
</th>


</tr>
<tr>
<td colspan="20">
<hr class="tablerule2">
</td>
</tr>
<tr valign="top">
<td colspan=1 rowspan=1>
<div class="CellBody"><a name="84688"> </a>library in title&nbsp;</div>
</td>
<td colspan=1 rowspan=1>
<pre class="CodeLeft"><b><a name="84690">sysLib.c </a></b></pre>
</td>
<td colspan=1 rowspan=1>
<div class="CellBody"><a name="84692"> </a>sysLib&nbsp;</div>
</td>

</tr>
<tr valign="top">
<td colspan=1 rowspan=1>
<div class="CellBody"><a name="84694"> </a>library in text&nbsp;</div>
</td>
<td colspan=1 rowspan=1>
<pre class="CodeLeft"><b><a name="84696">sysLib </a></b></pre>
</td>
<td colspan=1 rowspan=1>
<div class="CellBody"><a name="84698"> </a>(same)&nbsp;</div>
</td>

</tr>
<tr valign="top">
<td colspan=1 rowspan=1>
<div class="CellBody"><a name="84700"> </a>subroutine in title&nbsp;</div>
</td>
<td colspan=1 rowspan=1>
<pre class="CodeLeft"><b><a name="84702">sysMemTop </a></b></pre>
</td>
<td colspan=1 rowspan=1>
<div class="CellBody"><a name="84704"> </a>sysMemTop()&nbsp;</div>
</td>

</tr>
<tr valign="top">
<td colspan=1 rowspan=1>
<div class="CellBody"><a name="84706"> </a>subroutine in text&nbsp;</div>
</td>
<td colspan=1 rowspan=1>
<pre class="CodeLeft"><b><a name="84708">sysMemTop() </a></b></pre>
</td>
<td colspan=1 rowspan=1>
<div class="CellBody"><a name="84710"> </a>(same)&nbsp;</div>
</td>

</tr>
<tr valign="top">
<td colspan=1 rowspan=1>
<div class="CellBody"><a name="84712"> </a>subroutine parameter&nbsp;</div>
</td>
<td colspan=1 rowspan=1>
<pre class="CodeLeft"><b><a name="84714">&lt;ptid&gt; </a></b></pre>
</td>
<td colspan=1 rowspan=1>
<div class="CellBody"><a name="84716"> </a>(same)&nbsp;</div>
</td>

</tr>
<tr valign="top">
<td colspan=1 rowspan=1>
<div class="CellBody"><a name="84718"> </a>terminal key&nbsp;</div>
</td>
<td colspan=1 rowspan=1>
<pre class="CodeLeft"><b><a name="84720">TAB, ESC, CTRL+C</a></b></pre>
</td>
<td colspan=1 rowspan=1>
<div class="CellBody"><a name="84722"> </a>(same)&nbsp;</div>
</td>

</tr>
<tr valign="top">
<td colspan=1 rowspan=1>
<div class="CellBody"><a name="84724"> </a>publication&nbsp;</div>
</td>
<td colspan=1 rowspan=1>
<pre class="CodeLeft"><b><a name="84726">.I "Tornado User's Guide"</a></b></pre>
</td>
<td colspan=1 rowspan=1>
<div class="CellBody"><a name="84728"> </a><i class="title">Tornado User's Guide </i>&nbsp;</div>
</td>

</tr>
<tr valign="top">
<td colspan=1 rowspan=1>
<div class="CellBody"><a name="84730"> </a><i class="title"><a href="./index.html">VxWorks Programmer's Guide</a></i> in <b class="symbol_UC">SEE ALSO</b>&nbsp;</div>
</td>
<td colspan=1 rowspan=1>
<pre class="CodeLeft"><b><a name="84732">.pG "Configuration"</a></b></pre>
</td>
<td colspan=1 rowspan=1>
<div class="CellBody"><a name="84734"> </a><i class="title">VxWorks Programmer's Guide: Configuration</i> &nbsp;</div>
</td>

</tr>
<tr valign="top">
<td colspan=1 rowspan=1>
<div class="CellBody"><a name="84736"> </a><i class="title">Tornado User's Guide</i> in <b class="symbol_UC">SEE ALSO</b>&nbsp;</div>
</td>
<td colspan=1 rowspan=1>
<pre class="CodeLeft"><b><a name="84738">.tG "Cross-Development"</a></b></pre>
</td>
<td colspan=1 rowspan=1>
<div class="CellBody"><a name="84740"> </a><i class="title">Tornado User's Guide: Shell</i> &nbsp;</div>
</td>

</tr>
<tr valign="top">
<td colspan=1 rowspan=1>
<div class="CellBody"><a name="84742"> </a>emphasis&nbsp;</div>
</td>
<td colspan=1 rowspan=1>
<pre class="CodeLeft"><b><a name="84744">\f2must\fP </a></b></pre>
</td>
<td colspan=1 rowspan=1>
<div class="CellBody"><a name="84746"> </a><i class="emphasis">must </i>&nbsp;</div>
</td>

</tr>

<tr>
<td colspan="20">
<hr class="tablerule">
</td>
</tr>
<tr valign="middle">
<td colspan="20">

</td>
</tr>
</table>
</p>
</div>
<font face="Helvetica, sans-serif" class="sans">
<h4 class="H4"><i><a name="84748">Formatting Displays</a></i></h4>
</font>
<dl class="margin">

<dl class="margin">

<p class="listspace">
<ul class="Bullet" type="disc"><li><a name="84750"> </a><font face="Helvetica, sans-serif" size="-1" class="sans"><b class="hb">Code:</b></font>&nbsp;&nbsp;Use the <b class="symbol_UC">.CS</b> and <b class="symbol_UC">.CE</b> macros for displays of code or terminal input/output. Introduce the display with the <b class="symbol_UC">.CS</b> macro; end the display with <b class="symbol_UC">.CE</b>. Indent such displays by four spaces from the left margin. For example:</li></ul>
</p>
<dl class="margin">

<dd><pre class="Code2"><b><a name="84751">* .CS 
* &nbsp;&nbsp;&nbsp;&nbsp;struct stat statStruct; 
* &nbsp;&nbsp;&nbsp;&nbsp;fd = open ("file", READ); 
* &nbsp;&nbsp;&nbsp;&nbsp;status = ioctl (fd, FIOFSTATGET, &amp;statStruct); 
* .CE</a></b></pre>
</dl>

<p class="listspace">
<ul class="Bullet" type="disc"><li><a name="84752"> </a><font face="Helvetica, sans-serif" size="-1" class="sans"><b class="hb">Board Diagrams:</b></font>&nbsp;&nbsp;Use the <b class="symbol_UC">.bS</b> and <b class="symbol_UC">.bE</b> macros to display board diagrams under the BOARD LAYOUT heading in the <b class="file">target.nr</b> module for a BSP. Introduce the display with the <b class="symbol_lc">.</b><b class="symbol_UC">bS</b> macro; end the display with <b class="symbol_lc">.</b><b class="symbol_UC">bE</b>. </li></ul>
</p>
<p class="listspace">
<ul class="Bullet" type="disc"><li><a name="84753"> </a><font face="Helvetica, sans-serif" size="-1" class="sans"><b class="hb">Tables:</b></font>&nbsp;&nbsp;Tables built with <b class="command">tbl</b> are easy as long as you stick to basics, which suffice in almost all cases. Tables always start with the <b class="symbol_UC">.TS</b> macro and end with a <b class="symbol_UC">.TE</b>. The <b class="symbol_UC">.TS</b> should be followed immediately by a line of options terminated by a semicolon (&nbsp;<b>;</b>&nbsp;); then by one or more lines of column specification commands followed by a dot (&nbsp;<b>.</b>&nbsp;). For more details on table commands, refer to any UNIX documentation on <b class="command">tbl</b>. The following is a basic example:</li></ul>
</p>
<dl class="margin">

<dd><pre class="Code2"><b><a name="84754">.TS 
center; tab(|); 
lf3 lf3 
l l. 
Command         | Op Code 
_ 
INQUIRY         | (0x12) 
REQUEST SENSE   | (0x03) 
TEST UNIT READY | (0x00) 
.TE</a></b></pre>
</dl>

<dl class="margin">

<dd><div class="Indent"><a name="84755"> </a>General stylistic considerations are as follows:</div>
<br>
</dl>

<dl class="margin">

<ul class="DashSingle2" type="circle"><li><a name="84756"> </a>Redefine the tab character using the <b class="symbol_lc">tab</b> option; keyboard tabs cannot be used by <b class="command">tbl</b> tables. Typically the pipe character ( <b>|</b> ) is used.</li></ul>
<ul class="DashSingle2" type="circle"><li><a name="84757"> </a>Center small tables on the page.</li></ul>
<ul class="DashSingle2" type="circle"><li><a name="84758"> </a>Expand wide tables to the current line length.</li></ul>
<ul class="DashSingle2" type="circle"><li><a name="84759"> <