[Tinyos-2-commits] CVS: tinyos-2.x/doc/html tep1.html,1.9,1.10
Phil Levis
scipio at users.sourceforge.net
Wed Jul 11 09:13:11 PDT 2007
Update of /cvsroot/tinyos/tinyos-2.x/doc/html
In directory sc8-pr-cvs10.sourceforge.net:/tmp/cvs-serv1905/html
Modified Files:
tep1.html
Log Message:
HTML
Index: tep1.html
===================================================================
RCS file: /cvsroot/tinyos/tinyos-2.x/doc/html/tep1.html,v
retrieving revision 1.9
retrieving revision 1.10
diff -C2 -d -r1.9 -r1.10
*** tep1.html 21 Jun 2007 19:38:42 -0000 1.9
--- tep1.html 11 Jul 2007 16:13:08 -0000 1.10
***************
*** 4,8 ****
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
! <meta name="generator" content="Docutils 0.4: http://docutils.sourceforge.net/" />
<title>TEP Structure and Keywords</title>
<meta name="author" content="Philip Levis" />
--- 4,8 ----
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
! <meta name="generator" content="Docutils 0.3.7: http://docutils.sourceforge.net/" />
<title>TEP Structure and Keywords</title>
<meta name="author" content="Philip Levis" />
***************
*** 297,313 ****
</tr>
<tr><th class="docinfo-name">Status:</th>
! <td>Draft</td></tr>
<tr class="field"><th class="docinfo-name">TinyOS-Version:</th><td class="field-body">All</td>
</tr>
<tr><th class="docinfo-name">Author:</th>
<td>Philip Levis</td></tr>
- <tr class="field"><th class="docinfo-name">Draft-Created:</th><td class="field-body">18-Oct-2004</td>
- </tr>
- <tr class="field"><th class="docinfo-name">Draft-Version:</th><td class="field-body">1.6</td>
- </tr>
- <tr class="field"><th class="docinfo-name">Draft-Modified:</th><td class="field-body">2007-05-29</td>
- </tr>
- <tr class="field"><th class="docinfo-name">Draft-Discuss:</th><td class="field-body">TinyOS Developer List <tinyos-devel at mail.millennium.berkeley.edu></td>
- </tr>
</tbody>
</table>
--- 297,305 ----
</tr>
<tr><th class="docinfo-name">Status:</th>
! <td>Final</td></tr>
<tr class="field"><th class="docinfo-name">TinyOS-Version:</th><td class="field-body">All</td>
</tr>
<tr><th class="docinfo-name">Author:</th>
<td>Philip Levis</td></tr>
</tbody>
</table>
***************
*** 318,329 ****
improvements. Distribution of this memo is unlimited.</p>
</div>
! <div class="section">
! <h1><a id="abstract" name="abstract">Abstract</a></h1>
<p>This memo describes the structure all TinyOS Extension Proposal (TEP)
documents follow, and defines the meaning of several key words in
those documents.</p>
</div>
! <div class="section">
! <h1><a id="introduction" name="introduction">1. Introduction</a></h1>
<p>In order to simplify management, reading, and tracking development,
all TinyOS Extension Proposals (TEPs) MUST have a particular
--- 310,321 ----
improvements. Distribution of this memo is unlimited.</p>
</div>
! <div class="section" id="abstract">
! <h1><a name="abstract">Abstract</a></h1>
<p>This memo describes the structure all TinyOS Extension Proposal (TEP)
documents follow, and defines the meaning of several key words in
those documents.</p>
</div>
! <div class="section" id="introduction">
! <h1><a name="introduction">1. Introduction</a></h1>
<p>In order to simplify management, reading, and tracking development,
all TinyOS Extension Proposals (TEPs) MUST have a particular
***************
*** 333,338 ****
describes and follows both.</p>
</div>
! <div class="section">
! <h1><a id="keywords" name="keywords">2. Keywords</a></h1>
<p>The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT",
"SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this
--- 325,330 ----
describes and follows both.</p>
</div>
! <div class="section" id="keywords">
! <h1><a name="keywords">2. Keywords</a></h1>
<p>The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT",
"SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this
***************
*** 342,357 ****
special meanings only when capitalized, and documents SHOULD avoid using
these words uncapitalized in order to minimize confusion.</p>
! <div class="section">
! <h2><a id="must" name="must">2.1 MUST</a></h2>
<p>MUST: This word, or the terms "REQUIRED" or "SHALL", mean that the
definition is an absolute requirement of the specification.</p>
</div>
! <div class="section">
! <h2><a id="must-not" name="must-not">2.2 MUST NOT</a></h2>
<p>MUST NOT: This phrase, or the phrase "SHALL NOT", mean that the
definition is an absolute prohibition of the specification.</p>
</div>
! <div class="section">
! <h2><a id="should" name="should">2.3 SHOULD</a></h2>
<p>SHOULD: This word, or the adjective "RECOMMENDED", mean that there
may exist valid reasons in particular circumstances to ignore a
--- 334,349 ----
special meanings only when capitalized, and documents SHOULD avoid using
these words uncapitalized in order to minimize confusion.</p>
! <div class="section" id="must">
! <h2><a name="must">2.1 MUST</a></h2>
<p>MUST: This word, or the terms "REQUIRED" or "SHALL", mean that the
definition is an absolute requirement of the specification.</p>
</div>
! <div class="section" id="must-not">
! <h2><a name="must-not">2.2 MUST NOT</a></h2>
<p>MUST NOT: This phrase, or the phrase "SHALL NOT", mean that the
definition is an absolute prohibition of the specification.</p>
</div>
! <div class="section" id="should">
! <h2><a name="should">2.3 SHOULD</a></h2>
<p>SHOULD: This word, or the adjective "RECOMMENDED", mean that there
may exist valid reasons in particular circumstances to ignore a
***************
*** 359,364 ****
carefully weighed before choosing a different course.</p>
</div>
! <div class="section">
! <h2><a id="should-not" name="should-not">2.4 SHOULD NOT</a></h2>
<p>SHOULD NOT: This phrase, or the phrase "NOT RECOMMENDED" mean that
there may exist valid reasons in particular circumstances when the
--- 351,356 ----
carefully weighed before choosing a different course.</p>
</div>
! <div class="section" id="should-not">
! <h2><a name="should-not">2.4 SHOULD NOT</a></h2>
<p>SHOULD NOT: This phrase, or the phrase "NOT RECOMMENDED" mean that
there may exist valid reasons in particular circumstances when the
***************
*** 367,372 ****
before implementing any behavior described with this label.</p>
</div>
! <div class="section">
! <h2><a id="may" name="may">2.5 MAY</a></h2>
<p>MAY: This word, or the adjective "OPTIONAL", mean that an item is
truly optional. One implementer may choose to include the item
--- 359,364 ----
before implementing any behavior described with this label.</p>
</div>
! <div class="section" id="may">
! <h2><a name="may">2.5 MAY</a></h2>
<p>MAY: This word, or the adjective "OPTIONAL", mean that an item is
truly optional. One implementer may choose to include the item
***************
*** 381,386 ****
course, for the feature the option provides.)</p>
</div>
! <div class="section">
! <h2><a id="guidance-in-the-use-of-these-imperatives" name="guidance-in-the-use-of-these-imperatives">2.6 Guidance in the use of these Imperatives</a></h2>
<p>Imperatives of the type defined in this memo must be used with care
and sparingly. In particular, they MUST only be used where it is
--- 373,378 ----
course, for the feature the option provides.)</p>
</div>
! <div class="section" id="guidance-in-the-use-of-these-imperatives">
! <h2><a name="guidance-in-the-use-of-these-imperatives">2.6 Guidance in the use of these Imperatives</a></h2>
<p>Imperatives of the type defined in this memo must be used with care
and sparingly. In particular, they MUST only be used where it is
***************
*** 392,405 ****
</div>
</div>
! <div class="section">
! <h1><a id="tep-structure" name="tep-structure">3. TEP Structure</a></h1>
<p>TEPs have two major parts, a header and a body. The header states
! document metadata, for management and status. The body contains the
content of the proposal.</p>
<p>All TEPs MUST conform to reStructuredText standards <a class="footnote-reference" href="#id2" id="id1" name="id1">[1]</a> and follow
the docutils template, to enable translation from reStructuredText
to HTML and LaTeX.</p>
! <div class="section">
! <h2><a id="tep-header" name="tep-header">3.1 TEP Header</a></h2>
<p>The TEP header has several fields which MUST be included, as well as
others which MAY be included. The TEP header MUST NOT include headers
--- 384,397 ----
</div>
</div>
! <div class="section" id="tep-structure">
! <h1><a name="tep-structure">3. TEP Structure</a></h1>
<p>TEPs have two major parts, a header and a body. The header states
! document metadata, for management and status. The body contains the
content of the proposal.</p>
<p>All TEPs MUST conform to reStructuredText standards <a class="footnote-reference" href="#id2" id="id1" name="id1">[1]</a> and follow
the docutils template, to enable translation from reStructuredText
to HTML and LaTeX.</p>
! <div class="section" id="tep-header">
! <h2><a name="tep-header">3.1 TEP Header</a></h2>
<p>The TEP header has several fields which MUST be included, as well as
others which MAY be included. The TEP header MUST NOT include headers
***************
*** 408,412 ****
included in all TEPs, in the order stated here.</p>
<p>The first field is "TEP," and specifies the TEP number of the
! document. A TEP's number is unique.. This document is TEP 1. The
TEP type (discussed below) determines TEP number assignment. Generally,
when a document is ready to be a TEP, it is assigned the smallest
--- 400,404 ----
included in all TEPs, in the order stated here.</p>
<p>The first field is "TEP," and specifies the TEP number of the
! document. A TEP's number is unique.. This document is TEP 1. The
TEP type (discussed below) determines TEP number assignment. Generally,
when a document is ready to be a TEP, it is assigned the smallest
***************
*** 425,429 ****
<p>Documentary TEPs describe a system or protocol that exists; a
documentary TEP MUST reference an implementation that a reader can
! easily obtain. Documentary TEPs simplify interoperability when
needed, and document TinyOS service implementations.</p>
<p>Informational TEPs provide information that is of interest to the
--- 417,421 ----
<p>Documentary TEPs describe a system or protocol that exists; a
documentary TEP MUST reference an implementation that a reader can
! easily obtain. Documentary TEPs simplify interoperability when
needed, and document TinyOS service implementations.</p>
<p>Informational TEPs provide information that is of interest to the
***************
*** 434,442 ****
<p>Experimental TEPs describe a completely experimental approach to a
problem, which are outside the TinyOS core and will not necessarily
! become part of it. Unlike Documentary TEPs, Experimental TEPs may
describe systems that do not have a reference implementation.</p>
<p>The fourth field is "Status," which specifies the status of the TEP.
A TEP status can either be "Draft," which means it is a work in
! progress, "Final," which means it is complete and will not change.
Once a TEP has the status "Final," the only change allowed is the
addition of an "Obsoleted By" field.</p>
--- 426,434 ----
<p>Experimental TEPs describe a completely experimental approach to a
problem, which are outside the TinyOS core and will not necessarily
! become part of it. Unlike Documentary TEPs, Experimental TEPs may
describe systems that do not have a reference implementation.</p>
<p>The fourth field is "Status," which specifies the status of the TEP.
A TEP status can either be "Draft," which means it is a work in
! progress, "Final," which means it is complete and will not change.
Once a TEP has the status "Final," the only change allowed is the
addition of an "Obsoleted By" field.</p>
***************
*** 466,470 ****
another TEP. The purpose of this field is to denote when a TEP represents
an addition to an existing TEP. Meeting the requirements of a TEP with an
! Extends field requires also meeting the requirements of all TEPs listed
in the Extends field.</p>
<p>If a TEP is a Draft, then four additional fields MUST be included:
--- 458,462 ----
another TEP. The purpose of this field is to denote when a TEP represents
an addition to an existing TEP. Meeting the requirements of a TEP with an
! Extends field requires also meeting the requirements of all TEPs listed
in the Extends field.</p>
<p>If a TEP is a Draft, then four additional fields MUST be included:
***************
*** 477,482 ****
have these fields, which are for Drafts only.</p>
</div>
! <div class="section">
! <h2><a id="tep-body" name="tep-body">3.2 TEP Body</a></h2>
<p>The first element of the TEP body MUST be the title of the document. A
TEP SHOULD follow the title with an Abstract, which gives a brief
--- 469,474 ----
have these fields, which are for Drafts only.</p>
</div>
! <div class="section" id="tep-body">
! <h2><a name="tep-body">3.2 TEP Body</a></h2>
<p>The first element of the TEP body MUST be the title of the document. A
TEP SHOULD follow the title with an Abstract, which gives a brief
***************
*** 488,526 ****
"Implementation," which instructs the reader how to obtain the
implementation documented.</p>
! <p>If a TEP is Best Current Practic, it MUST have a section entitled
"Reference," which points the reader to one or more reference uses of
the practices.</p>
! <p>The last numbered section of a TEP (but before citations, if there are any),
! entitled "Author's Address" or "Author's Addresses" MUST contain
! detailed author contact information.</p>
! <p>A TEP MAY have appendices after its numbered sections. Unlike
! numbered sections, appendices are lettered. Please refer to Appendix
! A for details.</p>
</div>
</div>
! <div class="section">
! <h1><a id="reference" name="reference">4. Reference</a></h1>
<p>The reference use of this document is TEP 1 (itself).</p>
</div>
! <div class="section">
! <h1><a id="acknowledgments" name="acknowledgments">5. Acknowledgments</a></h1>
<p>The definitions of the compliance terms are a direct copy of
definitions taken from IETF RFC 2119.</p>
</div>
! <div class="section">
! <h1><a id="author-s-address" name="author-s-address">6. Author's Address</a></h1>
<div class="line-block">
<div class="line">Philip Levis</div>
! <div class="line">467 Soda Hall</div>
! <div class="line">UC Berkeley</div>
! <div class="line">Berkeley, CA 94720</div>
<div class="line"><br /></div>
! <div class="line">phone - +1 510 290 5283</div>
<div class="line"><br /></div>
! <div class="line">email - <a class="reference" href="mailto:pal@cs.berkeley.edu">pal@cs.berkeley.edu</a></div>
</div>
</div>
! <div class="section">
! <h1><a id="citations" name="citations">7. Citations</a></h1>
<table class="docutils footnote" frame="void" id="id2" rules="none">
<colgroup><col class="label" /><col /></colgroup>
--- 480,520 ----
"Implementation," which instructs the reader how to obtain the
implementation documented.</p>
! <p>If a TEP is Best Current Practice, it MUST have a section entitled
"Reference," which points the reader to one or more reference uses of
the practices.</p>
! <p>The last three sections of a TEP are author information, citations,
! and appendices. A TEP MUST have an author information section titled
! entitled "Author's Address" or "Authors' Addresses." A TEP MAY have
! a citation section entitled "Citations." A citations section MUST
! immediately follow the author information section. A TEP MAY have
! appendices. Appendices MUST immediately follow the citations section,
! or if there is no citations section, the author information section.
! Appendices are lettered. Please refer to Appendix A for details.</p>
</div>
</div>
! <div class="section" id="reference">
! <h1><a name="reference">4. Reference</a></h1>
<p>The reference use of this document is TEP 1 (itself).</p>
</div>
! <div class="section" id="acknowledgments">
! <h1><a name="acknowledgments">5. Acknowledgments</a></h1>
<p>The definitions of the compliance terms are a direct copy of
definitions taken from IETF RFC 2119.</p>
</div>
! <div class="section" id="author-s-address">
! <h1><a name="author-s-address">6. Author's Address</a></h1>
<div class="line-block">
<div class="line">Philip Levis</div>
! <div class="line">358 Gates Hall</div>
! <div class="line">Stanford University </div>
! <div class="line">Stanford, CA 94305</div>
<div class="line"><br /></div>
! <div class="line">phone - +1 650 725 9046</div>
<div class="line"><br /></div>
! <div class="line">email - <a class="reference" href="mailto:pal@cs.stanford.edu">pal@cs.stanford.edu</a></div>
</div>
</div>
! <div class="section" id="citations">
! <h1><a name="citations">7. Citations</a></h1>
<table class="docutils footnote" frame="void" id="id2" rules="none">
<colgroup><col class="label" /><col /></colgroup>
***************
*** 530,535 ****
</table>
</div>
! <div class="section">
! <h1><a id="appendix-a-example-appendix" name="appendix-a-example-appendix">Appendix A. Example Appendix</a></h1>
<p>This is an example appendix. Appendices begin with the letter A.</p>
</div>
--- 524,529 ----
</table>
</div>
! <div class="section" id="appendix-a-example-appendix">
! <h1><a name="appendix-a-example-appendix">Appendix A. Example Appendix</a></h1>
<p>This is an example appendix. Appendices begin with the letter A.</p>
</div>
More information about the Tinyos-2-commits
mailing list