[rtems commit] doc: Document format in conf.t

[Gedare Bloom]

Module:    rtems
Branch:    master
Commit:    e4ced53e683a3ab5f79c5c1016a0b2f7b7df3965
Changeset: http://git.rtems.org/rtems/commit/?id=e4ced53e683a3ab5f79c5c1016a0b2f7b7df3965

Author:    Shubham Somani <shubhamsomani92 at gmail.com>
Date:      Tue Oct 15 13:14:13 2013 -0400

doc: Document format in conf.t

---

 doc/user/conf.t |   56 +++++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 files changed, 56 insertions(+), 0 deletions(-)

diff --git a/doc/user/conf.t b/doc/user/conf.t
index 94d523f..a3f9824 100644
--- a/doc/user/conf.t
+++ b/doc/user/conf.t
@@ -183,6 +183,62 @@ information.  However, it is quite easy to use a library and forget to
 account for its resources.
 
 @c
+ at c === Format to be followed for making changes in this file ===
+ at c
+ at section Format to be followed for making changes in this file
+
+ at itemize @bullet
+ at item MACRO NAME
+Should be alphanumeric. Can have '_' (underscore).
+
+ at item DATA TYPE
+Please refer to all existing formats.
+
+ at item RANGE:
+The range depends on the Data Type of the macro.
+ at itemize @minus
+ at item If the data type is of type task priority, then its value should
+be an integer in the range of 1 to 255.
+
+ at item If the data type is an integer, then it can have numbers, characters
+(in case the value is defined using another macro) and arithmetic operations
+(+, -, *, /).
+
+ at item If the data type is a function pointer the first character
+should be an alphabet or an underscore. The rest of the string
+can be alphanumeric.
+
+ at item If the data type is RTEMS Attributes or RTEMS Mode then
+the string should be alphanumeric.
+
+ at item If the data type is RTEMS NAME then the value should be
+an integer>=0 or RTEMS_BUILD_NAME( 'U', 'I', '1', ' ' )
+ at end itemize
+
+ at item DEFAULT VALUE
+The default value should be in the following formats-
+Please note that the '.' (full stop) is necessary.
+
+ at itemize @minus
+ at item In case the value is not defined then:
+      This is not defined by default.
+
+ at item If we know the default value then:
+      The default value is XXX.
+
+ at item If the default value is BSP Specific then:
+      This option is BSP specific.
+ at end itemize
+
+ at item DESCRIPTION
+The description of the macro. (No specific format)
+
+ at item NOTES
+Any further notes. (No specific format)
+
+ at end itemize
+
+ at c
 @c === Configuration Example ===
 @c
 @section Configuration Example