Author:paolanto

Date:2014-06-20T13:42:23.000000Z


git-svn-id: https://svn.eiffel.com/eiffel-org/trunk@1384 abb3cda0-5349-4a8f-a601-0c33ac3a8c38
This commit is contained in:
paolanto
2014-06-20 13:42:23 +00:00
parent de18809940
commit e71ea03852
2 changed files with 11 additions and 4 deletions

View File

@@ -182,17 +182,24 @@ To produce documentation for a view other than ''Text'', use its option in the c
</code>
==Commands for Eiffel Inspector==
To start the Eiffel Inspector you need to pass the '''-code-analysis''' command line options. If no other options are given, it will analyze the whole system. To specify some preferences or analyze part of a system, you will need to provide some more options described below:
To start the Eiffel Inspector you need to pass the '''-code-analysis''' command line options. If no other options are given, it will analyze the whole system. To specify some preferences, enable specific rules or analyze part of a system, you will need to provide some more options described below:
<code lang="text">
ec -config project.ecf -code-analysis [-cadefaults | -caloadprefs pref_file | -caclasses class ...]
ec -config project.ecf -code-analysis [-cadefaults | -caloadprefs pref_file | -caclasses "CLASS1 CLASS2" |
-caforcerules "RULE1 (First preference=1, Second preference=2) RULE2"]
</code>
; -cadefaults : If provided, all preferences regarding the analysis will be reset to their default values (before the analysis is run). For example this leads to enabling all rules that are enabled by default, no matter whether they have been disabled before.
; -caloadprefs : Use preferences from ''pref_file'', an XML file containing the code analysis preferences. ''pref_file'' can be generated by exporting the current preferences in the GUI.
; -caclass : Followed by a list of class names (without file extension ''.e'') of the classes that shall be analyzed. If omitted then the whole system will be analyzed.
; -caclass : Followed by a list of class names (without file extension ''.e'') of the classes that shall be analyzed. If omitted then the whole system will be analyzed. If more than one class is to be specified, the list must be wrapped in double quotes. The class names can optionally be separated by semicolons ("CLASS1; CLASS2").
; -caforcerules: Followed by a list of rules, enables those rules for the analysis and disables all the others, overriding the current preferences. Specific rule preferences can also be provided in parentheses. Preferences must be separated by commas. The class names can optionally be separated by semicolons. The following example summarizes the syntax of this option:
<code lang="text">
-caforcerules "RULE1; RULE2 (Maximum length threshold=20, Enable something=False); RULE3"
</code>
==Command options==

View File

@@ -58,7 +58,7 @@ Upon a successful compilation either the whole system or the classes mentioned i
As soon as everything needed has been analyzed the results will be displayed as a list of rule violations. These rule violations are sorted by class and by location. In addition to the name of the violated rule and the rule ID, a description of the concrete violation will be displayed as well.
[img_assist|nid=2650|title=Eiffel Inspector - Command Line|desc=|link=node|align=center|width=640|height=627]
[img_assist|nid=2677|title=Eiffel Inspector - Command Line|desc=|link=node|align=center|width=877|height=691]
=== Output to file ===