[Tinyos-beta-commits] CVS: tinyos-1.x/beta/teps/txt tep3.txt, 1.6, 1.7

[Ion Yannopoulos]

Update of /cvsroot/tinyos/tinyos-1.x/beta/teps/txt
In directory sc8-pr-cvs1.sourceforge.net:/tmp/cvs-serv19990/txt

Modified Files:
	tep3.txt 
Log Message:
Packages:
  - Elaboration of rules for packages.
  - Extension of default package list


Index: tep3.txt
===================================================================
RCS file: /cvsroot/tinyos/tinyos-1.x/beta/teps/txt/tep3.txt,v
retrieving revision 1.6
retrieving revision 1.7
diff -C2 -d -r1.6 -r1.7
*** tep3.txt	26 Feb 2005 02:39:58 -0000	1.6
--- tep3.txt	26 Feb 2005 03:05:31 -0000	1.7
***************
*** 61,71 ****
  
  Packages
! --------
   
  For the purposes of this document a package is a collection of related
  source and other files, in whatever languages are needed.  A package is
  a logical grouping.  It may or may not correspond to a physical grouping
! such as a directory, though a package is most often a directory with
! possible subdirectories.
  
  It should be possible to easily identify what package a name is in.
--- 61,71 ----
  
  Packages
! ========================================================================
   
  For the purposes of this document a package is a collection of related
  source and other files, in whatever languages are needed.  A package is
  a logical grouping.  It may or may not correspond to a physical grouping
! such as a single directory.  In TinyOS a package is most often a
! directory with zero or more subdirectories.
  
  It should be possible to easily identify what package a name is in.
***************
*** 81,102 ****
    - Each package should have a name, to be used as a prefix to identify
      it in code.  This should usually be the same as the directory name,
!     or very close to it.
!     Any further namespacing is optional.
!   - Each directory should have a README.
!   - The default packages in a TinyOS distribution are at least:
  
!     - `tos/system/`.  Core TinyOS components.  This directory is what's
!        necessary for TinyOS to actually run.  [Should this be tos/components?]
      - `tos/interfaces/`.  Core TinyOS interfaces, including
!        hardware-independent abstractions.
      - `tos/platforms/`.  Contains code specific to mote platforms, but
         chip-independent.
!     - `tos/chips/`.  Contain code specific to particular chips and to
         chips on particular platforms.
      - `apps/`, `apps/demos`, `apps/tests`, `apps/tutorials`.  Contain
!        applications with some division by purpose.
    - It is not necessary that packages other than the core break up their
      components and their interfaces.  The core should allow overrides of
      components fairly easily however.
  
  
--- 81,113 ----
    - Each package should have a name, to be used as a prefix to identify
      it in code.  This should usually be the same as the directory name,
!     or very close to it:
  
!     - Core TinyOS components, types and interfaces do not have a prefix.
!     - Libraries must have a prefix corresponding to their directory name.
!     - Applications do not need a prefix but are encouraged to have one.
!     - Subdirectories do not need to be incorporated into the prefix.
!     - Any further namespacing is optional.
!   - The default packages in a TinyOS distribution are:
! 
!     - `tos/system/`.  Core TinyOS components.  This directory's
!        components are the ones necessary for TinyOS to actually run.
!        [Should this be `tos/components`?]
      - `tos/interfaces/`.  Core TinyOS interfaces, including
!        hardware-independent abstractions.  Expected to be heavily
!        used not just by `tos/system` but throughout all other code.
      - `tos/platforms/`.  Contains code specific to mote platforms, but
         chip-independent.
!     - `tos/chips/`.  Contains code specific to particular chips and to
         chips on particular platforms.
+     - `tos/libs/`.  Contains interfaces and components which extend the
+        usefulness of TinyOS but which are not viewed as essential to its
+        operation.  Libraries will likely contain subdirectories.
      - `apps/`, `apps/demos`, `apps/tests`, `apps/tutorials`.  Contain
!        applications with some division by purpose.  Applications may
!        contain subdirectories.
    - It is not necessary that packages other than the core break up their
      components and their interfaces.  The core should allow overrides of
      components fairly easily however.
+   - Each directory should have a README describing its purpose.