[Tinyos-2-commits] CVS: tinyos-2.x/doc/txt tep128.txt, 1.2, 1.3 tep129.txt, 1.2, 1.3

[Jan Beutel]

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

Modified Files:
	tep128.txt tep129.txt 
Log Message:
repaired warnings on compilation to html

Index: tep128.txt
===================================================================
RCS file: /cvsroot/tinyos/tinyos-2.x/doc/txt/tep128.txt,v
retrieving revision 1.2
retrieving revision 1.3
diff -C2 -d -r1.2 -r1.3
*** tep128.txt	14 Jun 2007 17:34:50 -0000	1.2
--- tep128.txt	14 Jun 2007 18:39:53 -0000	1.3
***************
*** 269,283 ****
  
  
! read(uint32_t addr, void *buf, uint32_t len);
!  - Read 'len' bytes into '*buf' from the given address
   - Returns FAIL if the volume is already in use
   - Signals readDone(...) when complete.
  
! write(uint32_t addr, void *buf, uint32_t len);
!  - Write 'len' bytes from '*buf' starting at the given address
   - Returns FAIL if the volume is already in use
   - Signals writeDone(...) when complete.
  
! erase(uint16_t eraseUnitIndex);
   - Erase a single 0-indexed erase unit
   - Returns FAIL if the volume is already in use
--- 269,283 ----
  
  
! ``read(uint32_t addr, void '*buf', uint32_t len);``
!  - Read 'len' bytes into ``*buf`` from the given address
   - Returns FAIL if the volume is already in use
   - Signals readDone(...) when complete.
  
! ``write(uint32_t addr, void '*buf', uint32_t len);``
!  - Write 'len' bytes from ``*buf`` starting at the given address
   - Returns FAIL if the volume is already in use
   - Signals writeDone(...) when complete.
  
! ``erase(uint16_t eraseUnitIndex);``
   - Erase a single 0-indexed erase unit
   - Returns FAIL if the volume is already in use
***************
*** 355,359 ****
  
  
! modify(uint32_t addr, void *buf, uint32_t len)
   - Modify 'len' bytes located on non-volatile memory at the given address,
     replacing them with data from the given buffer
--- 355,359 ----
  
  
! ``modify(uint32_t addr, void *buf, uint32_t len)``
   - Modify 'len' bytes located on non-volatile memory at the given address,
     replacing them with data from the given buffer
***************
*** 361,376 ****
   - Signals modified(...) when the operation is complete
  
! read(uint32_t addr, void *buf, uint32_t len)
!  - Read 'len' bytes into '*buf' from the given address
   - Same as DirectStorage.read(...)
   - Returns FAIL if the volume is already in use
   - Signals readDone(...) when complete.
  
! erase(uint16_t eraseUnitIndex);
   - Erase a single 0-indexed erase unit
   - Returns FAIL if the volume is already in use
   - Signals eraseDone(...) when complete.
  
! flush()
   - All data that has been previously written and is not yet located on 
     non-volatile memory should be immediately stored to non-volatile memory.
--- 361,376 ----
   - Signals modified(...) when the operation is complete
  
! ``read(uint32_t addr, void *buf, uint32_t len)``
!  - Read 'len' bytes into ``*buf`` from the given address
   - Same as DirectStorage.read(...)
   - Returns FAIL if the volume is already in use
   - Signals readDone(...) when complete.
  
! ``erase(uint16_t eraseUnitIndex);``
   - Erase a single 0-indexed erase unit
   - Returns FAIL if the volume is already in use
   - Signals eraseDone(...) when complete.
  
! ``flush()``
   - All data that has been previously written and is not yet located on 
     non-volatile memory should be immediately stored to non-volatile memory.
***************
*** 379,383 ****
   - Signals flushDone(...) when complete.
  
! crc(uint32_t addr, uint32_t len, uint16_t baseCrc);
   - Calculate the CRC of 'len' bytes starting at the given address, using
     the given baseCrc as a seed.
--- 379,383 ----
   - Signals flushDone(...) when complete.
  
! ``crc(uint32_t addr, uint32_t len, uint16_t baseCrc);``
   - Calculate the CRC of 'len' bytes starting at the given address, using
     the given baseCrc as a seed.
***************
*** 385,389 ****
   - Signals crcDone(...) when complete.
  
! isSupported()
   - Returns TRUE if DirectModify is available on the current memory type
  
--- 385,389 ----
   - Signals crcDone(...) when complete.
  
! ``isSupported()``
   - Returns TRUE if DirectModify is available on the current memory type
  

Index: tep129.txt
===================================================================
RCS file: /cvsroot/tinyos/tinyos-2.x/doc/txt/tep129.txt,v
retrieving revision 1.2
retrieving revision 1.3
diff -C2 -d -r1.2 -r1.3
*** tep129.txt	14 Jun 2007 17:34:50 -0000	1.2
--- tep129.txt	14 Jun 2007 18:39:53 -0000	1.3
***************
*** 108,118 ****
  
  
! read(uint32_t addr, void *buf, uint32_t len);
!  - Read 'len' bytes into '*buf' from the given address
   - Returns FAIL if the request cannot be handled
   - Signals readDone(...) when complete.
  
! write(uint32_t addr, void *buf, uint32_t len);
!  - Write 'len' bytes from '*buf' starting at the given address
   - Returns FAIL if the request cannot be handled
   - Signals writeDone(...) when complete.
--- 108,118 ----
  
  
! ``read(uint32_t addr, void *buf, uint32_t len);``
!  - Read 'len' bytes into ``*buf`` from the given address
   - Returns FAIL if the request cannot be handled
   - Signals readDone(...) when complete.
  
! ``write(uint32_t addr, void *buf, uint32_t len);``
!  - Write 'len' bytes from ``*buf`` starting at the given address
   - Returns FAIL if the request cannot be handled
   - Signals writeDone(...) when complete.
***************
*** 376,388 ****
   - Signals totalKeys(...) when complete
  
! insert(uint32_t key, void *value, uint16_t valueSize)
   - Insert some data into the configuration storage associated with the
     given key
   - Signals inserted(...) when complete
  
! retrieve(uint32_t key, void *valueHolder, uint16_t maxValueSize)
   - Retrieve the value associated with the given key.  The maximum value
     size is the maximum amount of data that can be loaded into the 
!    *valueHolder location, to avoid overflow
   - Signals retrieved(...) when complete
  
--- 376,388 ----
   - Signals totalKeys(...) when complete
  
! ``insert(uint32_t key, void *value, uint16_t valueSize)``
   - Insert some data into the configuration storage associated with the
     given key
   - Signals inserted(...) when complete
  
! ``retrieve(uint32_t key, void *valueHolder, uint16_t maxValueSize)``
   - Retrieve the value associated with the given key.  The maximum value
     size is the maximum amount of data that can be loaded into the 
!    ``*valueHolder`` location, to avoid overflow
   - Signals retrieved(...) when complete