[m-rev.] diff: Improve the Morphine documentation.
Erwan Jahier
Erwan.Jahier at irisa.fr
Thu Jun 14 22:19:26 AEST 2001
Hi there.
This was lying around in a branch of my version manager for a long time now.
I don't expect anybody to review that.
--
Estimated hours taken: 20
Branch: main
Improve the Morphine documentation.
extras/morphine/source/forward_move.op:
extras/morphine/source/current_arg.op:
extras/morphine/source/current_slots.op:
extras/morphine/source/event_attributes.op:
extras/morphine/source/exec_control.op:
extras/morphine/source/coprocess.op:
extras/morphine/source/interactive_queries.op:
extras/morphine/source/step_by_step.op:
extras/morphine/source/display.op:
extras/morphine/source/source.op:
extras/morphine/source/collect.op:
extras/morphine/source/collect.in:
extras/morphine/source/make_scenario.pl:
Make the documentation more homogeneous; in particular, wrap all
predicates, variables, and atoms with quotes like this:
`...'. Also make the help messages begin with a verb when
possible for consistency.
Fix a few typos.
Fix quite a few grammatical errors.
I
Index: source/collect.op
===================================================================
RCS file: /home/mercury1/repository/mercury/extras/morphine/source/collect.op,v
retrieving revision 1.5
diff -u -d -u -r1.5 collect.op
--- source/collect.op 2000/08/16 12:17:48 1.5
+++ source/collect.op 2001/06/14 11:59:56
@@ -9,50 +9,59 @@
% This file implements the collect command.
%
% There are several things to do in order to be able to execute a
-% collect/1 command:
+% `collect/1' command:
% 1) create a file that will that contain the definition of collected_type,
-% initialize/1 and filter/4,
-% 2) generate `collect.m' from this file (generate_collect/1),
-% 3) compile collect.m (compile_collect/0),
-% 4) dynamically link it with the current execution (dyn_link_collect/2).
-% 5) run the command (run_command/1).
+% `initialize/1' and `filter/4',
+% 2) generate `collect.m' from this file (`generate_collect/1'),
+% 3) compile `collect.m' (`compile_collect/0'),
+% 4) dynamically link it with the current execution (`dyn_link_collect/2').
+% 5) run the command (`run_command/1').
opium_scenario(
name : collect,
files : [collect],
scenarios : [],
message :
-"Scenario that implements the collect/2 monitoring command that collects \
+"Scenario that implements the `collect/2' monitoring command that collects \
runtime information from Mercury program executions. It is intended to let \
users easily implement their own monitors with acceptable performances.\n\
\n\
To use it, users just need to define 4 things in a file, using the Mercury \
-syntax:\n\
- (1) a `collected_type' which is the type of the collecting \n\
+syntax.\n\
+ (1) A `collected_type' which is the type of the collecting \n\
variable that will contain the result of the monitoring\n\
activity.\n\
- (2) The predicate initialize/1 which initializes this collecting \n\
- variable. initialize/1 should follow the \n\
+ (2) A predicate `initialize/1' which initializes this collecting \n\
+ variable. Predicate `initialize/1' should respect the \n\
following declarations:\n\
:- pred initialize(collected_type).\n\
:- mode initialize(out) is det.\n\
- (3) The predicate filter/4 which updates the collecting variable \n\
- at each execution event. filter/4 also outputs a variable that \n\
+ (3) A predicate `filter/4' which updates the collecting variable at \n\
+ each execution event. The fourth argument of `filter/4' \n\
indicates whether to stop collecting. If this variable is set to \n\
`stop', the collect process stops; if it is set to `continue', it \n\
continues. If this variable is always set to `continue', the \n\
- collecting will process until the last event is reached. filter/4 \n\
- should follow the following declarations:\n\
+ collecting processes until the last event is reached. `filter/4' \n\
+ should respect the following declarations:\n\
:- pred filter(event, collected_type, collected_type, \n\
stop_or_continue).\n\
:- mode filter(in, acc_in, acc_out, out) is det.\n\
- where `acc_in' and `acc_out' have `in' and `out' respectively\n\
- as default values.\n\
- (4) And optionally the mode definition of `acc_in' and `acc_out'\n\
- in one want to override their default values.\n\
+ where modes `acc\_in' and `acc\_out' are equivalent to\n\
+ `in' and `out' respectively by default.\n\
+ (4) And optionally, a mode definition for `acc_in' and `acc_out'\n\
+ if one wants to override their default values.\n\
\n\
-The event type is defined as follows (for more detail about the meaning of \
-each event attributes, please refer to the Reference Manual):\n\
+Then, this file is used to generate the Mercury module `collect.m', \
+which is compiled and dynamically linked with the current execution. \
+When a `collect' request is made from the external debugger, a variable \
+of type `collected_type' is first initialized (with `initialize/1') and \
+then updated (with `filter/4') for all the remaining events of the \
+execution. When the fourth argument of `filter/4' is equal to `stop', or when \
+the end of the execution is reached, the last value of \
+the collecting variable is send to Morphine.\n\
+\n\
+The event type is defined as follows (for more details about the meaning of \
+each event attributes, please refer to the morphine Reference Manual):\n\
\n\
:- type event ---> \n\
event(\n\
@@ -125,22 +134,12 @@
\n\
(*) To be able to retrieve arguments, you to need to have the opium parameter \n\
`collect_arg' set to yes (`man collect_arg.' for more details).\n\
-\n\
-Then, this file is used to generate the Mercury module `collect.m', \
-which is compiled and dynamically linked with the current execution. \
-When a `collect' request is made from the external debugger, a variable \
-of type collected_type is first initialized (with initialize/1) and \
-then updated (with filter/4) for all the events of the remaining \
-execution. When the fourth argument of filter is equal to yes, or when \
-the end of the execution is reached, the last value of \
-the collecting variable is send to Morphine.\n\
\n\
-collect/2 can be seen as fold/4 meta-predicate except that (1) the \
-initialization and the updating of the accumulator is done via Mercury \
-predicates defined in a separate file (2) it does not take a list as \
-argument but operates on the fly on a list of events (3) we can stop \
-the process at anytime thanks the fourth argument of filter\4."
- ).
+Predicate `collect/2' can be seen as a `foldl/4' operator except that \
+it does not take a list as argument but operates on the fly on a list \
+of events; and we can stop the process at anytime thanks the fourth \
+argument of `filter/4'."
+).
%------------------------------------------------------------------------------%
opium_command(
@@ -153,12 +152,13 @@
implementation : collect_Op,
parameters : [collect_arg],
message :
-"If File contains the implementation of the Mercury predicates initialize/1 \
-and filter/4, collect(File, Result) calls filter/4 with each event of the \
-execution and an accumulator initialized by initialize/1, and returns the \
-final value in Result. The fourth argument of filter is a flag that is set \
-to `continue' or `stop' depending if you want to continue or stop the \
-monitoring process; this useful if one want to be able to stop the monitoring \
+"If File contains the implementation of the Mercury predicates \
+`initialize/1' and `filter/4', `collect(File, Result)' calls `filter/4' \
+with each remaining event of the current execution and an accumulator \
+initialized by `initialize/1', and returns the final value in `Result'. \
+The fourth argument of filter is a flag that is set to `continue' or \
+`stop' depending if you want to continue or stop the monitoring \
+process; this useful if one wants to be able to stop the monitoring \
process before the last event is reached.\n\
\n\
Here is an example of a simple monitor that counts calls.\n\
@@ -176,8 +176,8 @@
AccOut = AccIn\n\
).\n\
'\n\
-Then the command `collect(count_call, Result)' will unify Result with the \
-number of calls that occur during the program execution.\
+Then the goal `run(queens), collect(count_call, Result)' will unify `Result' \
+with the number of calls occurring during the execution of `queens' program.\
"
).
@@ -221,8 +221,8 @@
default : [no],
commands : [collect],
message :
-"Parameter which tells whether it is possible to use arguments/1 within \
-collect:filter/4. If you do not use arguments, it is better to set this \
+"Specifies whether or not it is possible to use `arguments/1' within \
+`collect:filter/4'. If you do not use arguments, it is better to set this \
parameter to `no' since when arguments are very big, it might slow down \
the execution of collect a lot."
).
@@ -236,7 +236,7 @@
abbrev : _,
implementation : compile_collect_Op,
message :
-"Compile the module `collect.m'."
+"Compiles the module `collect.m'."
).
compile_collect_Op :-
@@ -291,9 +291,8 @@
abbrev : _,
implementation : generate_collect_Op,
message :
-"Generates a Mercury module named `collect.m' from file File; File should \
-contain the definition of the accumulator type (collected_type), \
-initialize/1 and filter/4 predicates."
+"Generates a Mercury module named `collect.m' from file `File'; `File' should \
+contain the definition of `collected_type', `initialize/1', and `filter/4'."
).
generate_collect_Op(File) :-
@@ -374,7 +373,7 @@
abbrev : _,
implementation : dyn_link_collect_Op,
message :
-"Dynamically links the collect module with the currently run program."
+"Dynamically links the collect module with the current execution."
).
dyn_link_collect_Op(File, FileSo) :-
@@ -389,7 +388,7 @@
!
;
write("Can't find `collect.m'; you should "),
- write("use generate_collect/1 primitive before.\n"),
+ write("use `generate_collect/1' primitive before.\n"),
fail
),
send_message_to_socket(link_collect("\"./collect.so\"")),
@@ -432,9 +431,8 @@
abbrev : _,
implementation : run_collect_Op,
message :
-"Executes the collect command provided that collect.m has been correctly, \
-generated, compiled and dynamically linked with the current program \
-execution."
+"Executes the collect command provided that `collect.m' has been correctly \
+generated, compiled, and dynamically linked with the current execution."
).
run_collect_Op(Result) :-
@@ -478,9 +476,9 @@
!
;
CollectLinked == collect_not_linked,
- print("You can't call run_collect/1; "),
+ print("You can't call `run_collect/1'; "),
print("The collect module has not been linked with "),
- print("the current execution (cf dyn_link_collect/2).\n"),
+ print("the current execution (cf `dyn_link_collect/2').\n"),
!,
fail
;
Index: source/coprocess.op
===================================================================
RCS file: /home/mercury1/repository/mercury/extras/morphine/source/coprocess.op,v
retrieving revision 1.4
diff -u -d -u -r1.4 coprocess.op
--- source/coprocess.op 1999/12/20 14:44:12 1.4
+++ source/coprocess.op 2001/06/14 12:00:00
@@ -155,7 +155,7 @@
implementation : morphine_write_debug_Op,
parameters : [debug_morphine],
message :
-'This procedure is used to print information to debug Morphine.'
+'Prints additional information to debug Morphine.'
).
morphine_write_debug_Op(X) :-
@@ -172,7 +172,7 @@
implementation : morphine_write_debug_Op,
parameters : [debug_morphine],
message :
-'This procedure is used to print information to debug Morphine.'
+'Prints additional information to debug Morphine.'
).
morphine_write_debug_Op(Stream, X) :-
@@ -190,7 +190,7 @@
implementation : morphine_printf_debug_Op,
parameters : [debug_morphine],
message :
-'This procedure is used to print information to debug Morphine.'
+'Prints additional information to debug Morphine.'
).
morphine_printf_debug_Op(Format, X) :-
@@ -207,7 +207,7 @@
implementation : morphine_printf_debug_Op,
parameters : [debug_morphine],
message :
-'This procedure is used to print information to debug Morphine.'
+'Prints additional information to debug Morphine.'
).
morphine_printf_debug_Op(Stream, Format, X) :-
Index: source/current_arg.op
===================================================================
RCS file: /home/mercury1/repository/mercury/extras/morphine/source/current_arg.op,v
retrieving revision 1.5
diff -u -d -u -r1.5 current_arg.op
--- source/current_arg.op 2001/02/28 12:06:04 1.5
+++ source/current_arg.op 2001/06/14 12:00:22
@@ -19,14 +19,14 @@
implementation : current_arg_Op,
message :
"Gets or checks the values of the currently live arguments of the current \
-event. It will unify non-live arguments with the atom '-'.\n\
+event. Unifies non-live arguments with the atom '-'.\n\
Example: if the first argument of the current procedure is 2, the second is \
-[4, 6] and the third is not live, current_arg(Arg) will unify Arg with the \
-list [2, [4, 6], -].\n\
+`[4, 6]' and the third is not live, `current_arg(Arg)' unifies `Arg' with the \
+list `[2, [4, 6], -]'.\n\
\n\
If you do not want to retrieve an argument (because it is very big for \
-example), you can use the atom '-': for example, current_arg([X, -, -]) will \
-only retrieve the first argument."
+example), you can use the atom '-': for example, `current_arg([X, -, -])' \
+only retrieves the first argument of the current procedure."
).
current_arg_Op(Arg) :-
@@ -121,8 +121,8 @@
abbrev : _,
implementation : current_arg_names_Op,
message :
-"Gets or checks the list of the names of the current procedure arguments. \
-Unify non-live arguments with the atom '-'."
+"Gets or checks the list of names of the current procedure arguments. \
+Unifies non-live arguments with the atom '-'."
).
current_arg_names_Op(ListArgNames) :-
@@ -155,8 +155,8 @@
abbrev : _,
implementation : current_arg_types_Op,
message :
-"Gets or checks the list of the arguments types of the current procedure. \
-Unify non-live arguments with the atom '-'"
+"Gets or checks the list of arguments types of the current procedure. \
+Unifies non-live arguments types with the atom '-'."
).
current_arg_types_Op(ListArgTypes) :-
@@ -196,7 +196,7 @@
\n\
(*) We say that a variable is live at a given point of the execution if it has \
been instantiated and if the result of that instantiation is still available \
-(which is not the case for for destructively updated variables).\
+(which is not the case for destructively updated variables).\
"
).
@@ -299,7 +299,7 @@
X = [_| TailArg],
Arg = 'error',
write("\n***** Can't retrieve that type of argument. "),
- write("This is a bug in Morphine...\n")
+ write("This is probably a bug in Morphine...\n")
),
synthetise_list_univ_and_list_string2(TailArg, TailName, TailType,
ListArgLeft),
@@ -330,22 +330,22 @@
implementation : current_live_var_Op,
parameters : [],
message :
-'Gets or checks the name, the value and the type of the currently live \
-variables. VarId can be a string representing the variable name or, if it is \
+"Gets or checks the name, the value and the type of the currently live \
+variables. `VarId' can be a string representing the variable name or, if it is \
an argument of the current procedure, an integer representing the rank the \
argument.\n\
Example: \
-current_live_var("HeadVar__3", VarValue, _Type) (or equivalently \
-current_live_var(3, VarValue, _Type)) binds VarValue with the \
+`current_live_var(\"HeadVar__3\", VarValue, _Type)' (or equivalently \
+`current_live_var(3, VarValue, _Type)') binds `VarValue' with the \
current value of the third argument of the current predicate if it exists \
and if it is live, fails otherwise. \
You can get all the live variables by querying \
-current_live_var(VarId, VarValue, VarType) and typing \";\" at the prompt to \
+`current_live_var(VarId, VarValue, VarType)' and typing `;' at the prompt to \
search for other solutions. \
-You can also get the list of all the currently live variables of type int \
+You can also get the list of all the currently live variables of type `int' \
with the Morphine query \
-setof((Name, Value), current_live_var(Name, Value, int), List).\
-'
+`setof((Name, Value), current_live_var(Name, Value, int), List)'.\
+"
).
@@ -412,8 +412,8 @@
implementation : current_live_var_names_and_types_Op,
message :
"Gets or checks the list of names and types of the currently live variables. \
-Each live variable is represented by the term \
-live_var_names_and_types(VariableName, TypeOfTheVariable).\
+Each live variable is a term of the form \
+`live_var_names_and_types(VariableName, TypeOfTheVariable)'.\
"
).
@@ -461,9 +461,8 @@
abbrev : _,
implementation : current_live_var_names_and_types_Op,
message :
-"current_live_var_names_and_types/0 gets and displays the live variable names \
-and types. You can change this display by customizing the procedure \
-display_list_var_names.\
+"Gets and displays the live variable names and types. You can change this \
+display by customizing the procedure `display_list_var_names/0'.\
"
).
Index: source/current_slots.op
===================================================================
RCS file: /home/mercury1/repository/mercury/extras/morphine/source/current_slots.op,v
retrieving revision 1.5
diff -u -d -u -r1.5 current_slots.op
--- source/current_slots.op 2000/08/15 15:53:58 1.5
+++ source/current_slots.op 2001/06/14 12:00:24
@@ -24,21 +24,20 @@
parameters : [],
message :
"Gets or checks the values of the event attributes specified in \
-AttributesConjunctOrList. AttributesConjunctOrList is a conjunction or a list \
-of terms of the form attribute = Value. \n\
-If Value is a free variable, it is unified with the current value of the \
-attribute. \
-If Value is a ground term, the current value of the attribute is retrieved and \
-checked against Value.\n\
+`AttributesConjunctOrList'. `AttributesConjunctOrList' is a conjunction or a list \
+of terms of the form `attribute = Value'. \n\
+If `Value' is a free variable, it is unified with the current value of the \
+attribute. If `Value' is a ground term, the current value of the attribute \
+is retrieved and checked against `Value'.\n\
\n\
-The different attributes for current/1 are : \n\
+The different attributes of `current/1' are: \n\
\n\
chrono: \n\
chronological event number of the event, \n\
call: \n\
call event number of the event, \n\
depth: \n\
- depth in the proof three (number of ancestors - 1) of the event, \n\
+ depth in the proof tree (number of ancestors - 1) of the event, \n\
port: \n\
type of the event, \n\
proc_type: \n\
@@ -84,12 +83,12 @@
current(args = [Arg1, -, -]) will unify Arg1 with the first argument of the \
current procedure if is live. \n\
\n\
-(*) non lived arguments are unified with '-' and if you do not want to retrieve \
-all the arguments (because one of them is very big for example), \
-you can use the atom '-': for example, current(arg = [X, -, -]) will only \
-retrieve \
-the first argument. Note that current(arg = [X, _, _] will have the same \
-behaviour, but arguments will be retrieved through the socket."
+(*) Non lived arguments are unified with `-'. Moreover, if you do not want \
+to retrieve all the arguments (because one of them is very big for example), \
+you can use the atom `-': for example, `current(arg = [X, -, -])' only \
+retrieves the first argument. Note that `current(arg = [X, _, _])' produces the \
+same result, except arguments are effectively retrieved, which can take \
+some times."
).
current_Op(ListOrConj) :-
@@ -130,8 +129,7 @@
abbrev : _,
implementation : current_attributes_Op,
message :
-"current_attributes/12 retrieves all the event attributes except the argument \
-attributes."
+"Retrieves all the event attributes except the argument attributes."
).
% :- pred current_attributes(atom, ..., atom).
@@ -486,13 +484,13 @@
name : is_list_or_conj_of_attributes_current,
implementation : is_list_or_conj_of_attributes_current_Op,
message :
-"Type which succeeds for list or conjunctions of terms of the form: \
-\"AttributeAlias = Term\", where AttributeAlias is an alias of a Mercury \
-event attribute and Term is a variable or a possible \
-value for the corresponding attribute.\n\
+"Succeeds for list or conjunctions of terms of the form: \
+`Attribute = Term', where `Attribute' is a Mercury event attribute (or an \
+alias of it) and `Term' is a term, e.g., a variable or a possible \
+value for the attribute.\n\
Example:\n\
-current(name = Name and decl_module = module1), current([port = call, name = \
-Name]).\
+`current(name = Name and decl_module = module1), current([port = call, name = \
+Name])'.\
"
).
Index: source/display.op
===================================================================
RCS file: /home/mercury1/repository/mercury/extras/morphine/source/display.op,v
retrieving revision 1.4
diff -u -d -u -r1.4 display.op
--- source/display.op 1999/12/20 14:44:13 1.4
+++ source/display.op 2001/06/14 12:00:29
@@ -32,7 +32,7 @@
message :
"Prints the current trace event according to the value of the \
display parameters. The name of the printed attributes can be get with the \
-command print_displayed_attributes/0.\
+command `print_displayed_attributes/0'.\
"
).
@@ -108,7 +108,7 @@
parameters : [indent_display, attribute_display, arg_undisplay,
list_display, term_display],
message :
-"Prints the names of the attributes displayed by print_event/0.\
+"Prints the names of the attributes displayed by `print_event/0'.\
"
).
@@ -183,7 +183,7 @@
parameters : [indent_display, attribute_display, arg_undisplay,
list_display, term_display],
message :
-"Prints the names of the attributes printed by print_full_event/0."
+"Prints the names of the attributes printed by `print_full_event/0'."
).
% :- pred print_full_displayed_attributes_Op is det.
@@ -219,7 +219,7 @@
implementation : indent_Op,
parameters : [indent_display],
message :
- "Sets relative indentation on/off. If a tracing process is \
+"Sets relative indentation on/off. If a tracing process is \
on, it sets the depth at which the indentation has to start to the \
current depth. Otherwise the starting depth is 1.\
"
@@ -247,7 +247,7 @@
parameters : [indent_display],
message :
"Sets the indentation on and sets the depth at which the \
-indentation has to start to Depth.\
+indentation has to start to `Depth'.\
"
).
@@ -265,10 +265,10 @@
implementation : write_indent_Op,
parameters : [indent_display],
message :
- "Procedure which displays an indentation -- if indentation is on -- \
+"Displays an indentation -- if indentation is on -- \
according to the current depth and the indentation starting depth. If \
-IndentFlag is on, it prints N times IndentValue, where N is \
-CurrDepth - IndentDepth if this is positive, 1 otherwise.\
+`IndentFlag' is set to `on', it prints `N' times `IndentValue', where `N' is \
+`CurrDepth - IndentDepth' if this is positive, 1 otherwise.\
"
).
@@ -311,13 +311,11 @@
implementation : write_attribute_Op,
parameters : [attribute_display],
message :
- "Procedure which displays an attribute of the trace line. AttributeName is \
+"Displays an attribute of the trace line. `AttributeName' is \
a member of the following list: [chrono, call, depth, port, proc_type, \
decl_module, def_module, arity, mode_number, args, deter, goal_path, \
-non_arg_var]. \
-To customize the way arguments are displayed, you should rather modify \
-write_arg.\
-"
+non_arg_var]. To customize the way arguments are displayed, you should \
+rather modify `write_arg/1'."
).
%:- pred write_attribute_Op(atom, atom).
@@ -443,9 +441,9 @@
implementation : write_arg_attribute_Op,
parameters : [attribute_display],
message :
- "Procedure which displays the arguments of the trace event when the \
-current procedure is Module:Name/Arity-ModeNum. If only the nth argument \
-of a procedure needs a special treatment, you should customize write_arg/1.\
+"Displays the arguments of the trace event when the \
+current procedure is `Module:Name/Arity-ModeNum'. If only the nth argument \
+of a procedure needs a special treatment, you should customize `write_arg/1'.\
"
).
@@ -526,8 +524,7 @@
parameters : [arguments_display, arg_undisplay, term_display,
list_display],
message :
-"Procedure which displays the Nth argument of procedure Procedure in \
-DeclModule.\
+"Displays the nth argument of procedure `Procedure' in `DeclModule'.\
"
).
@@ -554,7 +551,7 @@
implementation : write_arg_Op,
parameters : [term_display, list_display],
message :
-"Procedure which prints an argument.\
+"Prints procedure arguments.\
"
).
@@ -589,8 +586,7 @@
implementation : write_term_Op,
parameters : [term_display],
message :
-"Procedure which displays a structured term, taking into account the \
-term_display parameter.\
+"Displays a structured term, taking into account the `term_display' parameter.\
"
).
@@ -911,8 +907,7 @@
implementation : write_list_Op,
parameters : [list_display],
message :
-"Procedure which displays a list, taking into account the list_display \
-parameter.\
+"Displays a list, taking into account the `list_display' parameter.\
"
).
@@ -1106,8 +1101,7 @@
implementation : write_ersatz_Op,
parameters : [],
message :
-"Procedure which writes \"...\" as a replacement for the hidden parts of the \
-arguments.\
+"Writes `...' as a replacement for the hidden parts of the arguments.\
"
).
@@ -1123,8 +1117,7 @@
implementation : write_comma_Op,
parameters : [],
message :
-"Procedure which writes \", \".\
-"
+"Writes `, '."
).
write_comma_Op :-
@@ -1192,10 +1185,9 @@
default : [normal],
commands : [write_arg],
message :
-"Parameter which tells how arguments shall be displayed. If Type is \
-\"simple\", \
-then arguments are displayed without taking the list_display and term_display \
-parameters into account.\
+"Specifies how arguments shall be displayed. If `Type' is set to `simple', \
+then arguments are displayed without taking the `list_display' and \
+`term_display' parameters into account.\
"
).
@@ -1209,10 +1201,10 @@
default : [normal, 0],
commands : [select_list_display, write_list],
message :
-"Parameter which tells how lists shall be displayed. If Type is \"normal\", \
-lists are displayed in the standard Prolog way. If Type is \"nest\", \
-the nested lists are displayed only till level Range (included). If Type is \
-\"truncate\", only the first Range elements of the lists are displayed.\
+"Specifies how lists shall be displayed. If `Type' is set to `normal', \
+lists are displayed in the standard Prolog way. If `Type' is set to `nest', \
+the nested lists are displayed only till level `Range' (included). If `Type' is \
+set to `truncate', only the first `Range' elements of the lists are displayed.\
"
).
@@ -1226,11 +1218,11 @@
default : [normal, 0],
commands : [write_term],
message :
-"Parameter which tells how structured terms shall be displayed. If Type is \
-\"normal\", terms are displayed in the standard Prolog way. If Type is \
-\"nest\", \
-the nested terms are displayed only till level Range (included). If Type is \
-\"truncate\", only the first Range elements of the term are displayed.\
+"Specifies how structured terms shall be displayed. If `Type' is set to \
+`normal', terms are displayed in the standard Prolog way. If `Type' is \
+set to `nest', the nested terms are displayed only till level `Range' \
+(included). If `Type' is set to `truncate', only the first `Range' elements \
+of the term are displayed.\
"
).
@@ -1244,8 +1236,7 @@
default : [on, ' ', 1],
commands : [print_event, write_indent],
message :
-"Paramater which tells whether indentation is \"on\" or \"off\", what has \
-to be \
+"Specifies whether indentation is `on' or `off', what has to be \
printed as indentation value, and at which depth the indentation has to be \
started.\
"
@@ -1261,7 +1252,7 @@
default : [30],
commands : [write_indent],
message :
-"Parameter which tells up to which depth the trace events shall be indented.\
+"Specifies up to which depth the trace events shall be indented.\
"
).
@@ -1275,8 +1266,8 @@
default : nodefault,
commands : [write_arg],
message :
-"Parameter which tells which arguments of which predicates have to be NOT \
-displayed. There must be one \"arg_undisplay\" clause for each argument which \
+"Specifies which arguments of which predicates have to be not \
+displayed. There must be one `arg_undisplay' clause for each argument which \
shall not be displayed.\
"
).
@@ -1305,8 +1296,7 @@
implementation : read_input_Op,
parameters : [],
message :
-"Procedure which reads an input from within the current input stream \
-of Morphine.\
+"Reads an input from within the current input stream of Morphine.\
"
).
@@ -1327,10 +1317,10 @@
implementation : toggle_Op,
parameters : [],
message :
-"Toggles attribute display of print_event command. \n\
-For example, if attribute decl_module is off, you can type \
-\"toggle(decl_module)\" to switch it on. You can list all the attributes \
-you can toggle thanks to list_attribute_aliases/0 command.\
+"Toggles attribute display of `print_event/1' command. \n\
+For example, if attribute `decl_module' is off, you can type \
+`toggle(decl_module)' to switch it on. You can list all the attributes \
+you can toggle thanks to `list_attribute_aliases/0'.\
"
).
@@ -1528,7 +1518,7 @@
implementation : display_stack_Op,
parameters : [],
message :
-"Procedure that displays the ancestors stack."
+"Displays the ancestors stack."
).
display_stack_Op([level(Level) | Tail]) :-
@@ -1578,8 +1568,8 @@
implementation : display_list_var_names_Op,
parameters : [],
message :
-"Display the names of the currently live variables given by \
-current_live_var_names_and_types/1.\
+"Displays the names of the currently live variables given by \
+`current_live_var_names_and_types/1'.\
"
).
Index: source/event_attributes.op
===================================================================
RCS file: /home/mercury1/repository/mercury/extras/morphine/source/event_attributes.op,v
retrieving revision 1.3
diff -u -d -u -r1.3 event_attributes.op
--- source/event_attributes.op 1999/12/20 14:44:13 1.3
+++ source/event_attributes.op 2001/06/14 12:00:30
@@ -15,7 +15,7 @@
name : is_port,
implementation : is_port_Op,
message :
-"Type which succeeds for a Mercury Port. Mercury ports are call (or 'CALL'), \
+"Succeeds for a Mercury Port. Mercury ports are call (or 'CALL'), \
exit (or 'EXIT'), fail (or 'FAIL'), redo (or 'REDO'), then (or 'THEN'), \
else (or 'ELSE'), disj (or 'DISJ'), switch (or 'SWITCH' or 'SWTC'), \
first (or 'FIRST' or 'FRST'), later (or 'LATER' or 'LATR'), \
@@ -29,7 +29,7 @@
name : is_port_or_var,
implementation : is_port_or_var_Op,
message :
-"Type which succeeds for a Mercury port or a variable (See is_port/1).\
+"Succeeds for a Mercury port or a variable (See `is_port/1').\
").
is_port_or_var_Op(X) :-
var(X), !
@@ -41,7 +41,7 @@
name : is_list_of_ports,
implementation : is_list_of_ports_Op,
message :
-"Type which succeeds for a sublist of ['CALL', 'EXIT', 'REDO', 'FAIL', 'THEN',\
+"Succeeds for a sublist of ['CALL', 'EXIT', 'REDO', 'FAIL', 'THEN',\
'ELSE', 'DISJ', 'SWITCH', 'SWTC', 'FIRST', 'FRST', 'LATER', 'LATR', 'EXCP', \
'EXCEPTION', \
call, exit, fail, redo, cond, then, else, disj, switch, first, later, exception, \
@@ -69,7 +69,7 @@
name : is_port_attribute,
implementation : is_port_attribute_Op,
message :
-"Type which succeeds for a port, a negated port (not('CALL')), a list of \
+"Succeeds for a port, a negated port (not('CALL')), a list of \
ports, '-' or a variable.\
").
@@ -95,7 +95,7 @@
name : is_goal_path,
implementation : is_goal_path_Op,
message :
-"Type which succeeds for list of atoms of the form '?','e', 't', '~', 'q', \
+"Succeeds for list of atoms of the form '?','e', 't', '~', 'q', \
'ci', 'si', 'di' where i is an integer > 0."
).
@@ -133,8 +133,7 @@
name : is_goal_path_or_var,
implementation : is_goal_path_or_var_Op,
message :
-"Type which succeeds for a Mercury goal path or a variable (See is_goal_path/1).\
-").
+"Succeeds for a Mercury goal path or a variable (See `is_goal_path/1').").
is_goal_path_or_var_Op(X) :-
var(X), !
@@ -157,9 +156,8 @@
name : is_goal_path_attribute,
implementation : is_goal_path_attribute_Op,
message :
-"Type which succeeds for a goal path, a negated goal path, a list of \
-goal path, '-' or a variable.\
-").
+"Succeeds for a goal path, a negated goal path, a list of goal path, '-' or \
+a variable.").
is_goal_path_attribute_Op(Attribute) :-
@@ -184,9 +182,9 @@
name : is_atom_attribute,
implementation : is_atom_attribute_Op,
message :
-"Type which succeeds for an atom, a negated atoms, a list of atom, a variable \
-or '-'. It is intended to check proc_name def_module and \
-decl_module attributes.\
+"Succeeds for an atom, a negated atoms, a list of atom, a variable \
+or '-'. It is intended to check `proc_name' `def_module' and \
+`decl_module' attributes.\
").
@@ -211,8 +209,7 @@
name : is_proc_type,
implementation : is_proc_type_Op,
message :
-"Type which succeeds for the atoms predicate and function. \
-").
+"Succeeds for the atoms `predicate' and `function'.").
is_proc_type_Op(X) :-
member(X, [predicate, function]).
@@ -223,9 +220,8 @@
name : is_proc_type_attribute,
implementation : is_proc_type_attribute_Op,
message :
-"Type which succeeds for pred or func, not(pred) or not(func), \
-a list of atoms pred or func, '-' or a variable.\
-").
+"Succeeds for pred or func, not(pred) or not(func), \
+a list of atoms pred or func, '-' or a variable.").
is_proc_type_attribute_Op(Attribute) :-
@@ -250,7 +246,7 @@
name : is_det_marker,
implementation : is_det_marker_Op,
message :
-"Type which succeeds for a Mercury determinism marker. Mercury determinism are \
+"Succeeds for a Mercury determinism marker. Mercury determinism are \
det (or 'DET'), semidet (or 'SEMI'), nondet (or 'NON'), multidet (or 'MUL'), \
cc_nondet (or 'CCNON'), cc_multidet (or 'CCMUL'), failure (or 'FAIL') and \
erroneous (or 'ERR'). \
@@ -263,7 +259,7 @@
name : is_det_marker_or_var,
implementation : is_det_marker_or_var_Op,
message :
-"Type which succeeds for a Mercury determinism markers or a variable.\
+"Succeeds for a Mercury determinism markers or a variable.\
").
is_det_marker_or_var_Op(X) :-
@@ -276,10 +272,10 @@
name : is_list_of_dets,
implementation : is_list_of_dets_Op,
message :
-"Type which succeeds for a sublist of [det, semidet, nondet, multidet,\
+"Succeeds for a sublist of [det, semidet, nondet, multidet,\
cc_nondet, cc_multidet, failure, erroneous, 'DET', 'SEMI', 'NON', 'MUL', \
'ERR', 'FAIL', 'CCNON', 'CCMUL'] \
-(the determinism marker in capital letters are the one use in mdb, the \
+(the determinism markers in capital letters are the ones used in mdb, the \
internal Mercury debugger).\
").
@@ -297,7 +293,7 @@
name : is_det_marker_attribute,
implementation : is_det_marker_attribute_Op,
message :
-"Type which succeeds for a Mercury determinism marker, a negated determinism \
+"Succeeds for a Mercury determinism marker, a negated determinism \
(not(nondet)), a list of determinism markers, '-' or a variable.\
").
@@ -325,12 +321,11 @@
implementation : is_proc_Op,
message :
-"Type which succeeds for terms of the form \
-[ProcType+][Module:]ProcName[/Arity][-ModeNum] where terms betwenn square \
-bracquets are optional, ProcType has type is_proc_type_attribute/1, \
-Module and ProcName have type is_atom_attribute/1, Arity and ModeNum have \
-type is_integer_attribute/1.\
-").
+"Succeeds for terms of the form \
+`[ProcType+][Module:]ProcName[/Arity][-ModeNum]' where terms betwenn square \
+bracquets are optional, `ProcType' has type `is_proc_type_attribute/1', \
+`Module' and `ProcName' have type `is_atom_attribute/1', `Arity' and `ModeNum' \
+have `type is_integer_attribute/1'.").
is_proc_Op(Proc) :-
@@ -439,7 +434,7 @@
name : is_proc_or_var,
implementation : is_proc_or_var_Op,
message :
-"Type which succeeds for a Mercury procedure or a variable.\
+"Succeeds for a Mercury procedure or a variable.\
").
is_proc_or_var_Op(X) :-
var(X), !
@@ -451,7 +446,7 @@
name : is_arg_attribute,
implementation : is_arg_attribute_Op,
message :
-"For the time being, you can't perform filtering on arguments i.e. you can \
+"For the time being, you can't perform filtering on arguments, i.e., you can \
only have variables or '-' for that attribute.\
").
is_arg_attribute_Op(Attribute) :-
@@ -463,7 +458,7 @@
name : is_integer_attribute,
implementation : is_integer_attribute_Op,
message :
-"Type which succeeds for an integer, a negated integer (not 6), a list of \
+"Succeeds for an integer, a negated integer (not 6), a list of \
integers ([3, 5, 9]), an interval ('3..11'), a variable or '-'.\
"
).
@@ -507,7 +502,7 @@
name : is_string_attribute,
implementation : is_string_attribute_Op,
message :
-"Type which succeeds for a string, a negated string (not \"foo\"), a list of \
+"Succeeds for a string, a negated string (not \"foo\"), a list of \
strings, a variable or '-'.\
").
is_string_attribute_Op(Attribute) :-
@@ -546,9 +541,8 @@
implementation : list_attribute_aliases_op,
parameters : [],
message :
-"List the available aliases for the different Mercury event attributes \
-(fget/1 and current/1).\
-").
+"Lists the available aliases for the different Mercury event attributes \
+(`fget/1' and `current/1').").
list_attribute_aliases_op :-
findall(X, is_alias_for(chrono, X), Lchrono),
@@ -656,7 +650,7 @@
is_alias_for(goal_path, gp).
-% XXX Those one are not hanled in fget yet.
+% XXX Those ones are not hanled in fget yet.
is_alias_for(args, arguments).
is_alias_for(args, args).
is_alias_for(args, arg).
Index: source/exec_control.op
===================================================================
RCS file: /home/mercury1/repository/mercury/extras/morphine/source/exec_control.op,v
retrieving revision 1.4
diff -u -d -u -r1.4 exec_control.op
--- source/exec_control.op 1999/12/20 14:44:13 1.4
+++ source/exec_control.op 2001/06/14 12:00:32
@@ -73,7 +73,7 @@
implementation : re_init_morphine_Op,
parameters : [],
message :
-'Re-initializes Morphine. This command migth be useful if Morphine is broken.\
+'Re-initializes Morphine. This command might be useful if Morphine is broken.\
'
).
@@ -97,13 +97,12 @@
implementation : run_Op,
parameters : [],
message :
-'Executes a Mercury program from Morphine. \n\
+"Executes a Mercury program from Morphine. \n\
\n\
-Example: \
-run(hello) will run the Mercury program hello under the control of Morphine .\
-run(\"./cat filename\") will run \
-the Mercury program \"cat\" that takes \"filename\" as argument.\
-'
+Example: `run(hello)' executes the Mercury program `hello' under the control \
+of Morphine. `run(\"./cat filename\")' executes the Mercury program `cat' \
+that takes `filename' as argument.\
+"
).
% :- pred run_Op(atom).
@@ -173,7 +172,7 @@
abbrev : _,
implementation : decompose_path_call_and_args_Op,
message :
-"Split a Mercury program call into its path, call and arguments list."
+"Splits a Mercury program call into its path, call, and arguments list."
).
@@ -278,9 +277,9 @@
name : is_mercury_program_call,
implementation : is_mercury_program_call_Op,
message :
-"Type which succeeds for terms or strings of the form: \
+"Succeeds for terms or strings of the form: \
`path/programcall arg1 arg2 ...' or `path/programcall(arg1, arg2, ...)'. \
-It is intended to check the argument of run/1.\n\
+It is intended to check the argument of `run/1'.\n\
\n\
Examples: `run(foo)', `run(\"foo\")', `run(\"./cat file\")', \
`run(./cat(file))', `run(\"../dir/cat file1 file2\")', \
@@ -508,10 +507,8 @@
implementation : goto_Op,
parameters : [],
message :
-'Moves forwards the trace pointer to the event with chronological \
-event number Chrono. If the current event number is larger than Chrono, \
-it fails.\
-').
+"Moves forwards the trace pointer to the event with chronological event \
+number `Chrono'. Fails if the current event number is larger than `Chrono'.").
%:- pred goto(integer).
%:- mode goto(in) is semidet.
@@ -538,8 +535,8 @@
default : [unix],
commands : [run, rerun],
message :
-"Parameter which tells which domain is used by the socket communication \
-betwenn the two processes.\
+"Specifies which domain is used by the socket communication \
+between the two processes.\
"
).
@@ -552,10 +549,10 @@
default : [""],
commands : [run, rerun],
message :
-"Parameter which specifies the command used to fork a new window to execute the \
-Mercury program in. By default, no other window is used (\"\"). \
-For example, if one want to execute a Mercury program within a xterm window, \
-one just need to use the command: \
+"Specifies the command used to fork a new window to execute the \
+Mercury program in. By default, no other window is used. \
+For example, if one wants to execute a Mercury program within a xterm window, \
+one just needs to use the command: \
`set_parameter(window_command, [\"xterm -e \"])'.\
"
).
@@ -572,8 +569,8 @@
implementation : no_window_Op,
parameters : [window_command],
message :
-"Set the `window_command' parameter to \"\" (its default value). \
-The Mercury program executes in the same window as Morphine."
+"Sets the `window_command' parameter to `\"\"' (its default value). \
+The Mercury program then executes in the same window as Morphine."
).
no_window_Op :-
@@ -590,9 +587,8 @@
implementation : use_xterm_Op,
parameters : [window_command],
message :
-"Set the `window_command' parameter to \"xterm -e \", which make the Mercury \
-executes in a new xterm window; the program's Input/Output will go to that \
-window and the Morphine's Input/Output will go to the current terminal."
+"Sets the `window_command' parameter to `\"xterm -e \"', which makes the Mercury \
+program executes in a new xterm window."
).
use_xterm_Op :-
@@ -609,7 +605,7 @@
implementation : use_gdb_Op,
parameters : [window_command],
message :
-"Set the `window_command' parameter to \"xterm -e gdb \". This is to be able \
+"Sets the `window_command' parameter to `\"xterm -e gdb \"'. This is to be able \
to use both gdb and Morphine. Note that to use gdb, you will need to compile \
your mercury program with the option `--c-debug'."
).
Index: source/forward_move.op
===================================================================
RCS file: /home/mercury1/repository/mercury/extras/morphine/source/forward_move.op,v
retrieving revision 1.5
diff -u -d -u -r1.5 forward_move.op
--- source/forward_move.op 2000/08/15 15:53:59 1.5
+++ source/forward_move.op 2001/06/14 12:00:36
@@ -31,18 +31,18 @@
parameters : [],
message :
"Moves forwards through the execution until the first event that satisfy the \
-list of constraints specified in AttributeConstraints (*). \
-AttributeConstraints can be either a conjunction of attribute constraints, \
-separated by \"and\" (fget(AC1 and AC2 and ...)) or a list of constraints \
-(fget([AC1, AC2, ...])). \n\
+list of constraints specified in `AttributeConstraints' (*). \
+`AttributeConstraints' can be either a conjunction of attribute constraints, \
+separated by `and' (`fget(AC1 and AC2 and ...)') or a list of constraints \
+(`fget([AC1, AC2, ...])'). \n\
\n\
-The different attributes for fget are : \n\
+The different attributes of `fget/1' are: \n\
chrono: \n\
chronological event number of the event, \n\
call: \n\
call event number of the event, \n\
depth: \n\
- depth in the proof three (number of ancestors - 1) of the event, \n\
+ depth in the proof tree (number of ancestors - 1) of the event, \n\
port: \n\
type of the event, \n\
proc_type: \n\
@@ -58,32 +58,28 @@
mode_number: \n\
procedure mode number, \n\
proc: \n\
- procedure ([proc_type->][decl_module:](name[/arity][-mode_number]) where \
+ procedure (`[proc_type->][decl_module:](name[/arity][-mode_number]') where \
only the attribute name is mandatory), \n\
det: \n\
procedure determinism, \n\
goal_path: \n\
goal path of the call of the procedure.\n\
\n\
-(*) An attribute constraint is a term of the form \"AttributeAlias = Term\" \
-where \
-AttributeAlias is an alias of a Mercury event attribute and Term can be: \n\
-an exact value (attribute = ground_term), \n\
-a negated value (attribute = not(ground_term)), \n\
-a list of values (attribute = [ground_term1, ground_term2, ... ]), \n\
+(*) An attribute constraint is a term of the form `Attribute = Term' \
+where `Attribute' is a Mercury event attribute and `Term' can be: \n\
+an exact value (attribute = <ground term>), \n\
+a negated value (attribute = not(<ground term>)), \n\
+a list of values (attribute = [<ground term>, <ground term>, ... ]), \n\
and for integer attributes (chrono, call, depth, arity), \n\
-an interval (attribute = bottom..up). \n\
+an interval (attribute = <integer>..<integer>). \n\
Each attribute has a list of possible aliases that you can list with the \
-command list_alias_attributes/0.\n\
+command `list_alias_attributes/0'.\n\
\n\
-Example: the Morphine goal fget(chrono = [20, 789] and depth = 3..6 and \
-proc = foo/2) \
-will make the execution move forwards until the first event \
+Example: the Morphine goal `fget(chrono = [20, 789] and depth = 3..6 and \
+proc = foo/2)' will make the execution move forwards until the first event \
which chronological event number is 20 or 789, depth is 3, 4, 5 or 6, \
-procedure name is foo and arity is 2. \
-You can also use a list as an argument of fget: \
-fget([chrono=[20, 789], depth = 3..6, proc = foo/2]) will have the \
-same effect as the previous goal.\
+procedure name is `foo' and arity is 2. An alternative syntax is to use a list \
+as an argument of `fget': `fget([chrono=[20, 789], depth = 3..6, proc = foo/2])'.\
"
).
@@ -291,8 +287,7 @@
implementation : det_fget_Op,
parameters : [],
message :
-"It is the deterministic version of fget/1.\
-"
+"It is the deterministic version of `fget/1'."
).
det_fget_Op(List) :-
@@ -902,16 +897,16 @@
"Restarts execution at the call port of the current goal.\
\n\
The command will fail unless the values of all the input arguments are \
-available at the current port. (The compiler will keep the values of the input \
+lives at the current port. The compiler will keep the values of the input \
arguments of traced procedures as long as possible, but it cannot keep them \
-beyond the point where they are destructively updated.) \n\
+beyond the point where they are destructively updated. \n\
\n\
-The debugger can perform a retry only from an exit or fail port; only at these \
-ports does the debugger have enough information to figure out how to reset the \
-stacks. If the debugger is not at such a port when a retry command is given, \
-the debugger will continue forward execution until it reaches an exit or fail \
-port of the call to be retried before it performs the retry. This may require \
-a noticeable amount of time. \
+The debugger can perform a `retry' only from `exit' and `fail' ports; only at \
+these ports does the debugger have enough information to figure out how to \
+reset the stacks. If the debugger is not at such a port when a `retry' command \
+is invoked, the debugger continues forward the execution until it reaches an \
+`exit' or a `fail' port of the call to be retried, and then performs the \
+`retry'. This may require a noticeable amount of time. \
"
).
Index: source/make_scenario.pl
===================================================================
RCS file: /home/mercury1/repository/mercury/extras/morphine/source/make_scenario.pl,v
retrieving revision 1.6
diff -u -d -u -r1.6 make_scenario.pl
--- source/make_scenario.pl 2000/03/10 10:24:51 1.6
+++ source/make_scenario.pl 2001/06/14 12:00:36
@@ -25,9 +25,11 @@
exists(OPIUM_LIGTH_DIR),
!
;
- print("\n*** You need ECLiPSe 4.1 or later, sorry...\n"),
- print("(In particular, you need eclipse_misc.tgz)\n"),
- print("You can download it at http://www.icparc.ic.ac.uk/eclipse/\n"),
+ print("\n*** You need to install eclipse_misc.tgz."),
+ print("\n*** You can download it at http://www.icparc.ic.ac.uk/eclipse/"),
+ print("\n*** and then de-tar it in your eclipse directory.\n"),
+ print("\n*** If it still does not work, it probably means"),
+ print("\n*** that you need ECLiPSe 4.1 or later.\n"),
abort
),
concat_string([FileNameStr, ".op"], File),
Index: source/source.op
===================================================================
RCS file: /home/mercury1/repository/mercury/extras/morphine/source/source.op,v
retrieving revision 1.4
diff -u -d -u -r1.4 source.op
--- source/source.op 1999/12/20 14:44:17 1.4
+++ source/source.op 2001/06/14 12:00:38
@@ -32,14 +32,13 @@
parameters : [],
message :
"Retrieves the source code of a Mercury procedure or a Mercury type \
-ProcOrType defined in the module Module and unifies it in Listing. \
-Module can be either a library or a user defined module.\
+`ProcOrType' defined in the module `Module', and unifies it with `Listing'. \
+`Module' can be either a library or a user defined module.\
\n\
Note: to be able to retrieve library procedures or types with \
-listing/3, you need to have the source of the Mercury library somewhere \
-and you need \
-to make sure that the environment variable LIB_MERCURY has been set correctly \
-to the path of the Mercury library in the sh script morphine. \
+`listing/3', you need to have the source of the Mercury libraries somewhere \
+and you need to make sure that the environment variable `LIB_MERCURY' has \
+been set correctly to the path of the Mercury libraries in the `morphine' script. \
"
).
@@ -61,16 +60,16 @@
implementation : listing_Op,
parameters : [],
message :
-"listing/2 is the same command as listing/3 except it prints the listing \
-of the code on the standard output.\n\
+"Predicate `listing/2' is the same command as `listing/3' except it prints \
+the listing of the code on the standard output.\n\
\n\
Example:\n\
-1 - listing(foo, bar/3, List) unify List with the list of terms defining \
-the Mercury predicate bar/3. \n\
-2 - listing(\"~/dir/foo\", bar) will display all the predicates bar/n defined \
-in the module foo which is in \"~/dir/\" directory. \n\
-3 - listing(io, io__read/3) will display the source of the Mercury library \
-predicate io__read/3 defined in the Mercury module io.\n\
+1 - `listing(foo, bar/3, List)' unifies `List' with the list of terms defining \
+the Mercury predicate `bar/3'. \n\
+2 - `listing(\"~/dir/foo\", bar)' displays all the predicates with functor \
+`bar' defined in the module `foo' which is in `~/dir/' directory. \n\
+3 - `listing(io, io__read/3)' displays the source of the Mercury library \
+predicate `io__read/3' defined in the Mercury module `io'.\n\
"
).
@@ -261,7 +260,7 @@
implementation : listing_hlds_Op,
parameters : [],
message :
-"See listing_hlds/2."
+"See `listing_hlds/2'."
).
listing_hlds_Op(Module, Name, Listing) :-
@@ -281,10 +280,11 @@
parameters : [],
message :
-"listing_hlds/2 and listing_hlds/3 are the same commands as listing/2 and \
-listing/3 except they will list the HLDS procedures instead of the source code. \
-To be able to list such HLDS code, you need to compile your module with \
-\"-dfinal\" option.\
+"Predicates `listing_hlds/2' and `listing_hlds/3' are the same commands as \
+`listing/2' and `listing/3' except they will list the intermediate code \
+(or HLDS code for High Level Data Structure) of procedures instead \
+of their source code. To be able to list such HLDS code, you need to \
+compile your module with `-dfinal' option.\
"
).
@@ -305,10 +305,9 @@
implementation : listing_current_procedure_Op,
parameters : [],
message :
-"listing_current_procedure/0 prints the source code of the current procedure \
-on the user window. If the current procedure is defined in a file that is not \
-in the current directory, you need to specify the path of this file with \
-listing_current_procedure/1.\
+"Lists the source code of the current procedure. If the current procedure \
+is defined in a file that is not in the current directory, you can specify \
+the path of this file with `listing_current_procedure/1'.\
").
@@ -330,8 +329,9 @@
implementation : listing_current_procedure_Op,
parameters : [],
message :
-"listing_current_procedure/1 is the same as listing_current_procedure/0 \
-except you specify the path of the module of the current procedure.\
+"Predicate `listing_current_procedure/1' is the same as \
+`listing_current_procedure/0' except you specify the path of the module of \
+the current procedure.\
").
% :- pred listing_current_procedure(atom).
@@ -347,9 +347,8 @@
name : is_mercury_proc_or_type,
implementation : is_mercury_proc_or_type_Op,
message :
-"Type which succeeds if its argument is of the form Name or \
-Name/Arity, where Name is an atom and Arity an integer.\
-").
+"Succeeds for terms of the form `atom' or `atom/integer'."
+).
is_mercury_proc_or_type_Op(Name/Arity) :-
@@ -420,7 +419,7 @@
name : is_atom_or_string,
implementation : is_atom_or_string_Op,
message :
-"Type which succeed for an atom or a string."
+"Succeed for atoms or strings."
).
is_atom_or_string_Op(X) :- atom(X), !.
Index: source/step_by_step.op
===================================================================
RCS file: /home/mercury1/repository/mercury/extras/morphine/source/step_by_step.op,v
retrieving revision 1.3
diff -u -d -u -r1.3 step_by_step.op
--- source/step_by_step.op 1999/12/20 14:44:17 1.3
+++ source/step_by_step.op 2001/06/14 12:00:38
@@ -29,9 +29,9 @@
implementation : next_Op,
parameters : [traced_ports],
message :
-"Command which moves forward to the next trace event according to the \
-``traced_ports'' parameter. This is the same command as step/0 (``next'' is \
-the name used in Opium (The Prolog version of Morphine), ``step'' is the name \
+"Moves forward to the next trace event according to the \
+`traced_ports' parameter. This is the same command as `step/0' (`next/0' is \
+the name used in Opium (The Prolog version of Morphine), `step' is the name \
used in the internal Mercury debugger mdb)."
).
@@ -46,7 +46,7 @@
implementation : next_Op,
parameters : [traced_ports],
message :
-"See next/0."
+"See `next/0'."
).
next_Op :-
@@ -78,7 +78,7 @@
implementation : det_next_Op,
parameters : [traced_ports],
message :
-"See det_next/0."
+"See `det_next/0'."
).
det_next_Op :-
@@ -97,8 +97,7 @@
implementation : next_Op,
parameters : [traced_ports],
message :
-"Command which prints the N next trace events according to the ``traced_ports'' \
-parameter."
+"Prints `N' next trace events according to the `traced_ports' parameter."
).
opium_command(
@@ -111,7 +110,7 @@
implementation : next_Op,
parameters : [traced_ports],
message :
-"See next/1."
+"See `next/1'."
).
next_Op(N) :-
@@ -136,11 +135,11 @@
implementation : skip_Op,
parameters : [],
message :
-"Command which makes the execution continuing until it reaches a final port \
-(exit or fail) of the goal to which the current event refers. If the current \
-port is already final, it acts like a step/0.\n\
-It is the same command as skip/0 (``skip'' is the name used in the Prolog \
-version of Opium, ``finish'' is the name used in the internal Mercury \
+"Makes the execution continuing until it reaches a final port \
+(`exit' or `fail') of the goal to which the current event refers. If the current \
+port is already final, it acts like `step/0'.\n\
+It is the same command as `skip/0' (`skip' is the name used in the Prolog \
+version of Opium, `finish' is the name used in the internal Mercury \
debugger)."
).
@@ -184,8 +183,8 @@
switch, disj, first, later]],
commands : [next],
message :
-"Parameter which tells which events (w.r.t. ports) are to be traced by \
-commands ``next'' and ``step''."
+"Specifies which events (w.r.t. ports) are to be traced by \
+commands `next' and `step'."
).
--
R1.
--------------------------------------------------------------------------
mercury-reviews mailing list
post: mercury-reviews at cs.mu.oz.au
administrative address: owner-mercury-reviews at cs.mu.oz.au
unsubscribe: Address: mercury-reviews-request at cs.mu.oz.au Message: unsubscribe
subscribe: Address: mercury-reviews-request at cs.mu.oz.au Message: subscribe
--------------------------------------------------------------------------
More information about the reviews
mailing list