Fix comments.
authorasterix <asterix@38d2e660-2303-0410-9eaa-f027e97ec537>
Fri, 21 May 2010 15:42:12 +0000 (15:42 +0000)
committerasterix <asterix@38d2e660-2303-0410-9eaa-f027e97ec537>
Fri, 21 May 2010 15:42:12 +0000 (15:42 +0000)
git-svn-id: https://src.develer.com/svnoss/bertos/trunk@3785 38d2e660-2303-0410-9eaa-f027e97ec537

boards/at91sam7x-ek/examples/sd_fat/main.c

index da45694e08ba2e86b040a560dfe5f29e7b6b537a..892a6004d7c67850b02574c4ab237732dba4b1db 100644 (file)
  * - wait the sample_time (from ini file)
  * - contine from beginning.
  *
+ * Here we put the ini file that this example uses. To use it copy
+ * the folling configutation line into the file called sd_fat.ini (or see INI_FILE_NAME
+ * define if you want chande the name).
+ * \code
+ *
+ *   # Bertos SD fat project example
+ *   #
+ *   # Basic configurarion
+ *   #
+ *
+ *   [log]
+ *   # Name of log file
+ *   name = test.log
+ *   # Enable the logging on serial device (enable = 1, disable = 0)
+ *   log_on_serial = 1
+ *   # Enable logging on sd file (enable = 1, disable = 0)
+ *   log_on_file = 1
+ *   # Period between two log in millisecond
+ *   sample_time = 1000
+ *
+ *   [serial_log]
+ *   # Select serial port where log
+ *   port = 0
+ *   # Serial port baudrate
+ *   baud = 115200
+ *
+ *   [log_format]
+ *   # Default text to insert on each log line
+ *   line_header = BeRTOS Log: 
+ *   # Use this char to separate each log field
+ *   field_sep = ;
+ *
+ *   [temperature]
+ *   unit_label = C
+ *
+ *   [pressure]
+ *   unit_label = hPa
+ *
+ *   [voltage]
+ *   unit_label = V
+ *
+ * \endcode
  */
 
 #include <cfg/debug.h>