[Tinyos-2-commits] CVS: tinyos-2.x/doc/txt tep1.txt,1.5,1.6

[Phil Levis]

Update of /cvsroot/tinyos/tinyos-2.x/doc/txt
In directory sc8-pr-cvs10.sourceforge.net:/tmp/cvs-serv2590/txt

Modified Files:
	tep1.txt 
Log Message:
Recommended changes to TEP 1.


Index: tep1.txt
===================================================================
RCS file: /cvsroot/tinyos/tinyos-2.x/doc/txt/tep1.txt,v
retrieving revision 1.5
retrieving revision 1.6
diff -C2 -d -r1.5 -r1.6
*** tep1.txt	12 Dec 2006 18:22:53 -0000	1.5
--- tep1.txt	29 May 2007 22:23:55 -0000	1.6
***************
*** 46,50 ****
  
  Note that the force of these words is modified by the requirement
! level of the document in which they are used.
  
  2.1 MUST
--- 46,53 ----
  
  Note that the force of these words is modified by the requirement
! level of the document in which they are used. These words hold their
! special meanings only when capitalized, and documents SHOULD avoid using
! these words uncapitalized in order to minimize confusion.
! 
  
  2.1 MUST
***************
*** 111,117 ****
  content of the proposal.
  
! All TEPs MUST follow the TEP docutils template, and conform to 
! reStructuredText standards [1]_, to enable translation from 
! reStructuredText to HTML and Latex.
  
  3.1 TEP Header
--- 114,120 ----
  content of the proposal.
  
! All TEPs MUST conform to reStructuredText standards [1]_ and follow
! the docutils template, to enable translation from  reStructuredText
! to HTML and LaTeX.
  
  3.1 TEP Header
***************
*** 119,132 ****
  
  The TEP header has several fields which MUST be included, as well as
! others which MAY be included. The first six header fields MUST be
  included in all TEPs, in the order stated here.
  
  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 how a number is assigned to it. Generally, when a document
! is ready to be a TEP, it is assigned the smallest available number.
! BCP TEPs start at 1 and all other TEPs (Documentary, Experimental,
! and Informational) start at 101.
  
  The second field states the name of the working group that produced
--- 122,136 ----
  
  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
! which are not specified in TEP 1 or supplementary Best Current
! Practice TEPs. The first six header fields MUST be
  included in all TEPs, in the order stated here.
  
  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
! available number. BCP TEPs start at 1 and all other TEPs
! (Documentary, Experimental, and Informational) start at 101.
  
  The second field states the name of the working group that produced
***************
*** 135,139 ****
  The third field is "Type," and specifies the type of TEP the document
  is. There are four types of TEP: Best Current Practice (BCP),
! Documentary, Informational, and Experimental. This document is Best
  Current Practice.
  
--- 139,143 ----
  The third field is "Type," and specifies the type of TEP the document
  is. There are four types of TEP: Best Current Practice (BCP),
! Documentary, Informational, and Experimental. This document's type is Best
  Current Practice.
  
***************
*** 162,168 ****
  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," its body MUST NOT change. 
! The values of its header fields MUST NOT change. The header of a
! Final TEP MAY have an "Obsoleted By" field added.
  
  The "Obsoletes" field is a backward pointer to an earlier TEP which
--- 166,171 ----
  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.
  
  The "Obsoletes" field is a backward pointer to an earlier TEP which
***************
*** 223,234 ****
  implementation documented.
  
! If a TEP is Best Current Practices, it MUST have a section entitled
  "Reference," which points the reader to one or more reference uses of
  the practices.
  
! The last 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.
  
  4. Reference
  ====================================================================
--- 226,240 ----
  implementation documented.
  
! 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.
  
! 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.
  
+ A TEP MAY have appendices after its Author section. Unlike regular sections,
+ appendices are lettered. Please refer to Appendix A for details.
+ 
  4. Reference
  ====================================================================
***************
*** 259,260 ****
--- 265,271 ----
  .. [1] reStructuredText Markup Specification. <http://docutils.sourceforge.net/docs/ref/rst/restructuredtext.html>
   
+ 
+ Appendix A. Example Appendix
+ ====================================================================
+ 
+ This is an example appendix. Appendices begin with the letter A.