mirrors/eiffel-org
1
0
Fork 0
mirror of https://github.com/EiffelSoftware/eiffel-org.git synced 2025-12-08 15:52:26 +01:00
Code Issues Packages Projects Releases Wiki Activity

Author:halw

Browse Source 
Date:2009-01-14T05:38:12.000000Z


git-svn-id: https://svn.eiffel.com/eiffel-org/trunk@162 abb3cda0-5349-4a8f-a601-0c33ac3a8c38
This commit is contained in:
halw
2009-01-14 05:38:12 +00:00
parent 8defe4bb0c
commit 7c808cf461
27 changed files with 169 additions and 124 deletions
Download Patch File Download Diff File Expand all files Collapse all files

5
documentation/current/eiffelstudio/eiffelstudio-reference/compiler/command-line/command-line-interactive-mode/class-menu.wiki
View File

@@ -2,7 +2,7 @@
[[Property:weight|2]]
[[Property:uuid|441d6cbb-2c48-5d44-8cb1-0884ade26b98]]
The Class command (c or C) in the main menu will only work if the system has been successfully compiled, and will give you information based on the result of the last successful compilation. It produces the following menu:
<code>
<code lang=text>
(A) Ancestors : show the ancestors of a class.
(B) Attributes : show the attributes of a class.
(C) Clients : show the clients of a class.
@@ -26,7 +26,8 @@ The Class command (c or C) in the main menu will only work if the system has bee
</code>
Each command will prompt you for the name of a class and a filter to use; you can also include the class name and the filter name after the command, separated by a space, as in:
<code>Command => a linked_list ascii</code>
<code>
Command => a linked_list ascii</code>
to obtain the ancestors of the <eiffel>LINKED_LIST</eiffel> class:
<code>
-- Automatic generation produced by ISE Eiffel --

4
documentation/current/eiffelstudio/eiffelstudio-reference/compiler/command-line/command-line-interactive-mode/compile-and-run-menu.wiki
View File

@@ -2,7 +2,7 @@
[[Property:weight|1]]
[[Property:uuid|58af783e-7fc4-9fa3-2374-4143204948bb]]
The Compile command (i or I) in the main menu yields the following item menu:
<code>
<code lang=text>
(A) Arguments : set the arguments.
(C) F-compile : (re)compile the C code generated by finalize.
(Z) Finalize : finalize the system (discard assertions by default).
@@ -20,7 +20,7 @@ The Compile command (i or I) in the main menu yields the following item menu:
The most common compiling option is L (Melt): recompile the system, melting recent changes. The other compilation possibilities are F (Freeze) and Z (Finalize). After a Freeze you will need to C-compile the result using the W (W-compile) command; similarly, you can C-compile the result of a Finalize using C (F-compile).
{{warning| '''Caution''': You cannot select a different project from within ec loop; also, you cannot select a different configuration file from within the command, although you may of course change the contents of the configuration file (for example by using an editor in an other window). }}
{{caution|You cannot select a different project from within ec loop; also, you cannot select a different configuration file from within the command, although you may of course change the contents of the configuration file (for example by using an editor in an other window). }}
The R option (Run) runs the application. You will be prompted for the arguments if the application needs any.

2
documentation/current/eiffelstudio/eiffelstudio-reference/compiler/command-line/command-line-interactive-mode/documentation-menu.wiki
View File

@@ -2,7 +2,7 @@
[[Property:weight|7]]
[[Property:uuid|4ed93bc4-07eb-57ed-b339-4890b5f58fcc]]
The Documentation Menu enables you to generate documentation about the classes of your system:
<code>
<code lang=text>
(I) Documentation (Flat/Short): Generate flat/short form of all classes in system.
(S) Documentation (Short): Generate short form of all classes in system.
(F) Documentation (Flat): Generate flat form of all classes in system.

8
documentation/current/eiffelstudio/eiffelstudio-reference/compiler/command-line/command-line-interactive-mode/feature-menu.wiki
View File

@@ -2,7 +2,7 @@
[[Property:weight|3]]
[[Property:uuid|a662251b-777d-5e28-0e52-ba4932195528]]
The Feature Menu enables you to find properties of a feature:
<code>
<code lang=text>
(A) Ancestors : show the ancestor versions of a feature.
(C) Callers : show the callers of a feature.
(D) Descendants : show the descendant versions of a feature.
@@ -18,7 +18,7 @@ The Feature Menu enables you to find properties of a feature:
</code>
Each command will prompt you for the name of a class, the name of a feature in that class and a filter name; you can specify these names (or just the class name) after the command.
{|
{| border="1"
|-
| <center>'''Command'''</center>
| <center>'''Description'''</center>
@@ -26,7 +26,7 @@ Each command will prompt you for the name of a class, the name of a feature in t
| <code>Ancestors</code>
| All the versions of a feature that appeared in ancestors.
|-
| <!Unavailable:vertical_alignment!><code>Callers</code>
| <code>Callers</code>
| The list of classes which contains calls to the feature. Modifiers:
* <code>All senders</code> - include all callers rather than only those in the specified class
* <code>Only assigners</code> - restrict callers to those that use given feature only as a target of an assignment instruction
@@ -34,7 +34,7 @@ Each command will prompt you for the name of a class, the name of a feature in t
|-
| <code>Descendants</code>
| All the versionsof a feature that appeared in descendants.
| All the versions of a feature that appeared in descendants.
|-
| <code>Implementers</code>
| The list of classes where the feature is redeclared.

28
documentation/current/eiffelstudio/eiffelstudio-reference/compiler/command-line/command-line-interactive-mode/index.wiki
View File

@@ -1,14 +1,26 @@
[[Property:title|Command line interactive mode]]
[[Property:weight|3]]
[[Property:uuid|3a0acea6-c6d1-c7b9-c2f9-88021cad26b6]]
* [[Interactive command line: Introduction|Introduction]]
* [[Compile (and run) menu|The Compile (and Run) menu]]
* [[Class menu|The Class menu]]
* [[Feature menu|The Feature menu]]
* [[System menu|The System menu]]
* [[Profile menu|The Profile menu]]
* [[Documentation menu|The Documentation menu]]
If you need to use '''ec''' to execute a number of successive operations on a system, you do not need to restart the command each time; instead you may use the -loop option, which will interactively prompt you for successive operations.
If you launch '''ec''' with this option, you will get the interactive version's Main Menu:
<code>
==== ISE EiffelStudio - Interactive Batch Version (v5.5.0926 Enterprise Edition) ===
(C) Class : class formats and information.
(I) Compile : compile or run the system.
(F) Feature : feature formats and information.
(S) System : Config and cluster details.
(P) Profile : information about a profiled run.
(D) Documentation: create documents from the system.
(H) Help : show list of commands.
(Q) Quit : terminate session.
(Y) Yank : yank (save) output of last command to a file.
Command =></code>
<br/>
The revision number in the first line may be different in your case to indicate that you have a more recent delivery. In this menu, and in all subsequent ones, the commands appear in two groups.
* commands in the first group are specific to each menu
* commands in the second group H (Help) to repeat the list of choices, Y (Yank) to save the output of the last command to a file that you will be prompted to name, and Q (Quit) to quit appear in all menus, and will be complemented in the Item Menus below by the M (Main) command which returns to the main menu.
By typing one of the letters shown in the Main Menu's first group, you can go to one of the Item Menus: [[Class menu|Class]], [[Compile (and run) menu|Compile]], [[Feature menu|Feature]], [[System menu|System]], [[Profile menu|Profile]], and [[Documentation menu|Documentation]]. [[Compile (and run) menu|Compile]] enables you to compile a system and execute the result; the next three enable you to obtain information about your project. [[Profile menu|Profile]] will enable you to exploit profiling information. Finally, [[Documentation menu|Documentation]] will enable you to generate HTML documentation about your project.

35
documentation/current/eiffelstudio/eiffelstudio-reference/compiler/command-line/command-line-interactive-mode/profile-menu.wiki
View File

@@ -5,7 +5,7 @@ An execution of an instrumented system will generate a file that contains profil
The profile menu will enable you to produce the Execution profile and to extract information from it.
The menu (obtained by selecting (P) Profile in the main menu) looks like this:
<code>
<code lang=text>
(S) Switches : show the output switches
#Call-E Name-E Total-D
Self-D Desc-D %Time-D.
@@ -25,7 +25,7 @@ The menu (obtained by selecting (P) Profile in the main menu) looks like this:
==Switches submenu==
The (S) Switches submenu enables you to set global options. It leads you to the following set of choices:
<code>
<code lang=text>
(N) Calls : disable output of number of calls to a feature [enabled].
(F) Feature name : disable output of feature names [enabled].
(T) Total : enable output of time spent in both the function and its descendants [disabled].
@@ -43,7 +43,7 @@ Each one of these commands switches on or off the corresponding column output. T
==Query submenu==
The (U) Query submenu enables you to define a set of queries. The result will be a Total Query; by default it is the boolean and all the queries you have entered individually, but you may deactivate some of these and choose other boolean operators.
<code>
<code lang=text>
(A) Add : add a sub query.
(I) Inactivate : inactivate sub query.
(R) Reactivate : reactivate sub query.
@@ -56,15 +56,22 @@ The (U) Query submenu enables you to define a set of queries. The result will be
(Q) Quit : terminate session.
(Y) Yank : yank (save) output of last command to a file.</code>
To get useful information, you should add the appropriate queries through (A) Add. Each individual query has the following form: attribute operator value, where attribute is one of:
To get useful information, you should add the appropriate queries through (A) Add. Each individual query has the following form: ''attribute operator value'', where ''attribute'' is one of:
* feature name
* calls
* total
* self
* descendants
* percentage
operator is one of: <, >, <=, >=, =, /=, in
and value is one of:
''operator'' is one of:
* <
* >
* <=
* >=
* =
* /=
* in <br/>
and ''value'' is one of:
* An integer (for calls)
* A string (for feature name). The string may contain wild card characters: ?, standing for arbitrary characters, and *,standing for arbitrary substrings.
* A real value (for other attributes)
@@ -78,7 +85,7 @@ To inactivate a query, use (I) Inactivate. You will be prompted for a query inde
To reactivate a query, use (R) Reactivate. Again you will have to provide a query index.
The Total Query resulting from a succession of (A) Add commands, possibly with some (I) Inactivate and (R) Reactivate commands, is a boolean query resulting by default from adding all the currently active queries. For example after the following set of commands(note that commands output help lines, which have been skipped here):
<code>
<code lang=text>
Command => a
--> Subquery: featurename = put*
@@ -102,7 +109,7 @@ Command =&gt; a
--> Subquery: calls > 5</code>
<br/>
The (S) Show command will show the following result:
<code>
<code lang=text>
Command => s
All subqueries:
[1] featurename = put* is active
@@ -114,7 +121,7 @@ featurename = put* and
calls > 5</code>
To change the boolean operator to 'or' rather than 'and', use the (C) Operator command. It will prompt you for the index of the operator and the new value:
<code>
<code lang=text>
Command => c
--> Operator index followed by operator ('and' or 'or'): 1 or
@@ -132,9 +139,11 @@ calls > 5</code>
The (I) Input command serves to load Execution Profiles. It is initially set to *.pfi meaning that it will load all files with extension pfi. By calling the command repeatedly with new arguments, you are able to load more Execution Profiles. If you use the command without any argument, and the set of input files contained just one file, then the queries will use the last generated output. This avoids explicitly loading a file.
==Language command==
The (L) Language command enables you to specify the languages to which profiling should be applied. You can specify Eiffel only, C only, or both. If you specify only one language, the query results will not contain any information about routines written in the other language.
The default is Eiffel only. To switch to both Eiffel and C, use Command => L eiffel and c
The default is Eiffel only. To switch to both Eiffel and C, use
<code lang=text>
Command => L eiffel and c</code>
To return to just Eiffel, simply type L.
To return to just Eiffel, simply type <code>L</code> .
==Run Command==
To run the current total query, use (R) Run.
@@ -145,7 +154,9 @@ When running the Generate command with no arguments, you will be prompted for th
* Compilation mode: workbench or finalized (default: workbench).
* Name of profiler tool (default: eiffel).
You can also type in the arguments directly without waiting to be prompted, as in command => g profinfo finalize eiffel <br/>
You can also type in the arguments directly without waiting to be prompted, as in
<code lang=text>
Command => g profinfo finalize eiffel </code>
{{seealso|<br/>

2
documentation/current/eiffelstudio/eiffelstudio-reference/compiler/command-line/command-line-interactive-mode/system-menu.wiki
View File

@@ -2,7 +2,7 @@
[[Property:weight|4]]
[[Property:uuid|c1450c9b-a5d3-3709-1176-9c5c49def362]]
The System Menu gives general information about the system:
<code>
<code lang=text>
(A) Config : show the config file.
(L) Classes : show the classes in alphabetic order.
(S) Cluster hierarchy: display the cluster hierarchy of the system.

2
documentation/current/eiffelstudio/eiffelstudio-reference/compiler/command-line/index.wiki
View File

@@ -4,7 +4,7 @@
==Using the command line compiler==
It is possible to compile from outside of the graphical environment, by using the command '''ec'''. The form of compilation's results are the same in both cases. You may therefore alternate between the two techniques. '''ec''' will enable you to [[EiffelStudio: Command line options|melt or freeze]] a project and therefore to use [[Batch compilation|batch compilation]] . It will also enable you to produce [[EiffelStudio: Command line options|information about a class]] such as its Flat and Flat Contract views. <br/>
The [[Interactive command line: Introduction|-loop option]] makes it possible to start '''ec''' just once and then repeatedly request any of the available operations.
The [[EiffelStudio: Command line options|-loop option]] makes it possible to start '''ec''' just once and then repeatedly request any of the available operations.