adlint 2.2.0 → 2.4.0

data/share/doc/users_guide_en.texi

@@ -2,7 +2,7 @@
 @setfilename users_guide_en.info
 @documentlanguage en
 @documentencoding utf-8
-@settitle AdLint 2.2.0 User's Guide
+@settitle AdLint 2.4.0 User's Guide
 
 @copying
 Copyright (C) 2010-2012, OGIS-RI Co.,Ltd.
@@ -883,6 +883,18 @@ And embed environment variables in a string value like below;
   item: "prefix${ENV_VAR}suffix"
 @end verbatim
 
+You can also specify multiple values of directory pathname list item by one
+environment variable like below;
+
+@verbatim
+% export ENV_VAR="/usr/local/include:/usr/include"
+@end verbatim
+
+@verbatim
+  include_path:
+    - $ENV_VAR
+@end verbatim
+
 
 @node Global Traits
 @subsection Global Traits
@@ -955,6 +967,15 @@ string
 @tab
 Set project name.
 @item 2
+@cindex project_traits:project_root
+@anchor{project_traits:project_root}
+@tab
+@code{project_root}
+@tab
+string
+@tab
+Set pathname of the project root directory.
+@item 3
 @cindex project_traits:include_path
 @anchor{project_traits:include_path}
 @tab
@@ -963,7 +984,8 @@ Set project name.
 array of string
 @tab
 Set project specific include path.
-@item 3
+An entry can have multiple pathnames with @code{`:'} separators.
+@item 4
 @cindex project_traits:initial_header
 @anchor{project_traits:initial_header}
 @tab
@@ -974,7 +996,7 @@ string
 Set the header files which is included at the top of specified source files.
 For example, project specific macro definition will be described in this file.
 
-@item 4
+@item 5
 @cindex project_traits:coding_style:indent_style
 @anchor{project_traits:coding_style:indent_style}
 @tab
@@ -1021,7 +1043,7 @@ foo(int i)
 @}
 @end example
 
-@item 5
+@item 6
 @cindex project_traits:coding_style:tab_width
 @anchor{project_traits:coding_style:tab_width}
 @tab
@@ -1030,7 +1052,7 @@ foo(int i)
 integer value
 @tab
 Set the appearance number of digits of tab character
-@item 6
+@item 7
 @cindex project_traits:coding_style:indent_width
 @anchor{project_traits:coding_style:indent_width}
 @tab
@@ -1039,7 +1061,7 @@ Set the appearance number of digits of tab character
 integer value
 @tab
 Set the appearance number of digits of indent
-@item 7
+@item 8
 @cindex project_traits:file_encoding
 @anchor{project_traits:file_encoding}
 @tab
@@ -1268,6 +1290,7 @@ If @code{`char'} type treat as @code{`unsigned char'}, set true.
 array of string
 @tab
 Set the compiler specific include path.
+An entry can have multiple pathnames with @code{`:'} separators.
 @item 24
 @cindex compiler_traits:arithmetic:logical_right_shift
 @anchor{compiler_traits:arithmetic:logical_right_shift}
@@ -1377,22 +1400,32 @@ In case of @code{true}, AdLint will output messages with name of the
 examination package, message category and message severity to the @ref{Message
 File, message file}.
 @item 3
-@cindex message_traits:warn_only_files_in
-@anchor{message_traits:warn_only_files_in}
+@cindex message_traits:warn_files_in
+@anchor{message_traits:warn_files_in}
 @tab
-@code{warn_only_files_in}
+@code{warn_files_in}
 @tab
-string
+array of string
 @tab
-@b{This item has no effect on AdLint 2.0.0, yet.}
-
-This item represents root directory path of the target project.
+@b{This item has no effect on AdLint 2.4.0, yet.}
 
 If a directory path is specified, AdLint will output warning messages about
 source files located under the specified directory.
 If omitted, AdLint will output warning messages about all the files included by
 the target source files such as system headers or 3rd-party library headers.
 @item 4
+@cindex message_traits:warn_files_not_in
+@anchor{message_traits:warn_files_not_in}
+@tab
+@code{warn_files_not_in}
+@tab
+array of string
+@tab
+@b{This item has no effect on AdLint 2.4.0, yet.}
+
+If a directory path is specified, AdLint will suppress warning messages about
+source files located under the specified directory.
+@item 5
 @cindex message_traits:individual_selection
 @anchor{message_traits:individual_selection}
 @tab
@@ -1400,13 +1433,13 @@ the target source files such as system headers or 3rd-party library headers.
 @tab
 boolean
 @tab
-@b{This item has no effect on AdLint 2.0.0, yet.}
+@b{This item has no effect on AdLint 2.4.0, yet.}
 
 This item enables code check selection by annotations in the target source
 files.
 
 In case of @code{true}, code check selection by annotations will be enabled.
-@item 5
+@item 6
 @cindex message_traits:exclusion:categories
 @anchor{message_traits:exclusion:categories}
 @tab
@@ -1414,10 +1447,10 @@ In case of @code{true}, code check selection by annotations will be enabled.
 @tab
 array of string
 @tab
-@b{This item has no effect on AdLint 2.0.0, yet.}
+@b{This item has no effect on AdLint 2.4.0, yet.}
 
 This item represents excluding code checks by its message categories.
-@item 6
+@item 7
 @cindex message_traits:exclusion:severities
 @anchor{message_traits:exclusion:severities}
 @tab
@@ -1425,10 +1458,10 @@ This item represents excluding code checks by its message categories.
 @tab
 regexp string
 @tab
-@b{This item has no effect on AdLint 2.0.0, yet.}
+@b{This item has no effect on AdLint 2.4.0, yet.}
 
 This item represents excluding code checks by its message severities.
-@item 7
+@item 8
 @cindex message_traits:exclusion:messages
 @anchor{message_traits:exclusion:messages}
 @tab
@@ -1436,13 +1469,13 @@ This item represents excluding code checks by its message severities.
 @tab
 map of Message ID and string
 @tab
-@b{This item has no effect on AdLint 2.0.0, yet.}
+@b{This item has no effect on AdLint 2.4.0, yet.}
 
 This item represents excluding code checks by its message ID.
 
 Because a message ID is not unique in multiple examination packages, you should
 also specify the name of the examination package including the message.
-@item 8
+@item 9
 @cindex message_traits:inclusion:messages
 @anchor{message_traits:inclusion:messages}
 @tab
@@ -1450,15 +1483,14 @@ also specify the name of the examination package including the message.
 @tab
 map of Message ID and string
 @tab
-@b{This item has no effect on AdLint 2.0.0, yet.}
+@b{This item has no effect on AdLint 2.4.0, yet.}
 
 This item represents messages which is excluded by settings of @code{exclusion}
 section but will be used by AdLint.
 
 For example, you can bring back the specified code checks which is excluded by
 @ref{message_traits:exclusion:categories, exclusion:categories}.
-@item 9
-@item 2
+@item 10
 @cindex message_traits:change_list
 @anchor{message_traits:change_list}
 @tab