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

[Ion Yannopoulos]

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

Modified Files:
	tep3.txt 
Log Message:
Incorporating changes suggested by David Gay:
  - No prefixes for core
  - No obligatory prefixes for applications
  - Explicitly make clear modules are private
  - Distinguish between C type names and C tag names.
Add in notion of opaque pointer types (hiding pointers).


Index: tep3.txt
===================================================================
RCS file: /cvsroot/tinyos/tinyos-1.x/beta/teps/txt/tep3.txt,v
retrieving revision 1.5
retrieving revision 1.6
diff -C2 -d -r1.5 -r1.6
*** tep3.txt	26 Feb 2005 02:24:32 -0000	1.5
--- tep3.txt	26 Feb 2005 02:39:58 -0000	1.6
***************
*** 119,125 ****
    - If an interface and component are related it is useful if they have
      the same name except for the suffix of the component.
!   - Any public module should have a similarly named configuration.  Wiring
!     in a configuration should only be done to other configurations, to this
!     module, or to private components.
    - Commands, events, tasks and functions should be mixed case, starting
      lower case.
--- 119,125 ----
    - If an interface and component are related it is useful if they have
      the same name except for the suffix of the component.
!   - Modules are private.   To make a module publically available, build a
!     configuration for it.  Wiring in a configuration should only be done
!     to other configurations, to this module, or to private components.
    - Commands, events, tasks and functions should be mixed case, starting
      lower case.
***************
*** 146,152 ****
      package they belong to.  Names are chosen as follows:
  
!     - The TinyOS core (i.e. in `system/`) has no prefix.
!     - A platform, library, or application (e.g. `MSP430`, `Deluge`, `Mate`)
!       should have a prefix which matches the directory name.
      - All HAL [TEP_2]_ interfaces and components are public to their
        platform, and should be prefixed with their platform.
--- 146,154 ----
      package they belong to.  Names are chosen as follows:
  
!     - The TinyOS core (i.e. in `system/` and `interfaces/`) has no prefix.
!     - A platform, library (e.g. `MSP430`, `Deluge`, `Mate`) should have a
!       prefix which matches the directory name.
!     - Applications do not need prefixes but large ones are encouraged to
!       use one to avoid possible collisions with future core names.
      - All HAL [TEP_2]_ interfaces and components are public to their
        platform, and should be prefixed with their platform.
***************
*** 197,203 ****
        hardware specific macros in TinyOS 1.x should be replaced with nesC
        components in TinyOS 2.x.
!   - C type names (`struct`, `enum`, or `typedef`) should be lower case,
!     words separated by underscores, prefixed by package, and ending in
!     `'_t'`.
    - Functions should be lower case, words separated by underscores,
      prefixed by package.
--- 199,209 ----
        hardware specific macros in TinyOS 1.x should be replaced with nesC
        components in TinyOS 2.x.
!   - C type names (define with `typedef`) should be lower case, words
!     separated by underscores, prefixed by package, and ending in `'_t'`.
!   - C tag names (for `struct`, `union`, or `enum`) should be lower case,
!     words separated by underscores, prefixed by package.  Types with tag
!     names should provide a typedef with a '_t' extension.
!   - C types which represent opaque pointers (for use in parameters) should
!     be named similar to other types but should end in `'_ptr_t'`.
    - Functions should be lower case, words separated by underscores,
      prefixed by package.