[m-rev.] trivial diff: fix compiler documentation
Julien Fischer
juliensf at students.cs.mu.OZ.AU
Thu Jul 31 18:23:41 AEST 2003
Estimated hours taken: 0.5
Branches: main.
Fix some mistakes in the compiler documentation. These are mainly
spelling errors and some things identified by the double script
(that I'm fairly certain are mistakes).
compiler/options.m:
Add `.profdeep' to list of grade modifiers.
Fix the formatting of a line so that it fits within 80 chars.
s/attemps/attempts/
s/auxiliarity/auxiliary/
s/whereever/wherever/
Fix some doubled words.
doc/reference_manual.texi:
Remove a few doubled words.
doc/user_guide.texi:
s/behavior/behaviour/
s/occuring/ocurring/
Index: compiler/options.m
===================================================================
RCS file: /home/mercury1/repository/mercury/compiler/options.m,v
retrieving revision 1.414
diff -u -r1.414 options.m
--- compiler/options.m 23 Jul 2003 03:38:11 -0000 1.414
+++ compiler/options.m 31 Jul 2003 07:52:13 -0000
@@ -2883,8 +2883,8 @@
% The ilc grade is not documented because it is not useful;
% it has been superceded by the il grade.
"\tor one of those with one or more of the grade modifiers",
- "\t`.gc', `.mps', `.prof', `.memprof', `.tr', `.rt', `.debug',",
- "\t`.par' and/or `.pic_reg' appended.",
+ "\t`.gc', `.mps', `.prof', `.memprof', `.profdeep', `.tr',",
+ "\t`rt', `.debug', `.par' and/or `.pic_reg' appended.",
"\tDepending on your particular installation, only a subset",
"\tof these possible grades will have been installed.",
"\tAttempting to use a grade which has not been installed",
@@ -2923,7 +2923,8 @@
"\tDon't use MS CLR specific workarounds in the generated code.",
"--support-rotor-clr",
- "\tUse specific workarounds for the ROTOR CLR in the generated code.",
+ "\tUse specific workarounds for the ROTOR CLR in the generated",
+ "\tcode.",
"--java",
"\tAn abbreviation for `--target java'.",
@@ -3442,7 +3443,7 @@
"\tthat the compiler considers to be deterministic.",
"--constraint-propagation",
"\tEnable the constraint propagation transformation,",
- "\twhich attemps to transform the code so that goals",
+ "\twhich attempts to transform the code so that goals",
"\twhich can fail are executed as early as possible.",
"--local-constraint-propagation",
"\tEnable the constraint propagation transformation,",
@@ -3570,7 +3571,7 @@
"--no-static-ground-terms",
"\tDisable the optimization of constructing constant ground terms",
"\tat compile time and storing them as static constants.",
- "\tNote that auxiliarity data structures created by the compiler",
+ "\tNote that auxiliary data structures created by the compiler",
"\tfor purposes such as debugging will still be created as",
"\tstatic constants.",
"--no-middle-rec",
@@ -3608,7 +3609,7 @@
"\tminimize stack consumption, possibly at the expense of speed.",
"--use-local-vars",
"\tDisable the transformation to use local variables in C code",
- "\tblocks whereever possible.",
+ "\tblocks wherever possible.",
"--no-optimize-labels",
"\tDisable elimination of dead labels and code.",
"--optimize-dups",
@@ -3750,7 +3751,7 @@
% --cflags-for-optimization, --c-flag-to-name-object-file,
% --object-file-extension, --pic-object-file-extension
% and --link-with-pic-object-file-extension
- % options are are reserved for use by the `mmc' script;
+ % options are reserved for use by the `mmc' script;
% they are deliberately not documented.
"--javac <javac>",
@@ -3895,7 +3896,7 @@
% --shlib-linker-rpath-flag, --shlib-linker-rpath-separator,
% --linker-allow-undefined-flag and
% --linker-error-undefined-flag,
- % options are are reserved for use by the `mmc' script;
+ % options are reserved for use by the `mmc' script;
% they are deliberately not documented.
]).
Index: doc/reference_manual.texi
===================================================================
RCS file: /home/mercury1/repository/mercury/doc/reference_manual.texi,v
retrieving revision 1.277
diff -u -r1.277 reference_manual.texi
--- doc/reference_manual.texi 23 Jul 2003 03:38:45 -0000 1.277
+++ doc/reference_manual.texi 31 Jul 2003 08:10:51 -0000
@@ -405,7 +405,7 @@
constructed with an operator are allowed to take.
``f'' represents the operator and ``x'' and ``y'' represent arguments.
``x'' represents an argument whose priority must be
-strictly lower that that of the operator.
+strictly lower than that of the operator.
``y'' represents an argument whose priority is
lower or equal to that of the operator.
For example, ``yfx'' indicates a left-associative infix operator,
@@ -2375,7 +2375,7 @@
would be free variables but they would not be distinct.
In Mercury it is always possible to call a procedure with an
-argument that is is more bound than the initial inst specified for that
+argument that is more bound than the initial inst specified for that
argument in the procedure's mode declaration. In such cases, the
compiler will insert additional unifications to ensure that the
argument actually passed to the procedure will have the inst specified.
@@ -3747,7 +3747,7 @@
term. Suppose, for example, that you have a higher-order predicate
term @samp{OldPred} of type @samp{pred(int, char, float)}, and you want
to construct a new higher-order predicate term @samp{NewPred} of type
- at samp{pred(char, float)} from @samp{OldPred} by supplying a value for
+ at samp{pred(char, float)} from @samp{OldPred} by supplying a value
for just the first argument. The solution is the same: use
an explicit lambda expression or a forwarding predicate.
In either case, the body of the lambda expression or the forwarding
@@ -5144,7 +5144,7 @@
@end example
An existentially typed procedure is not allowed to have different
-types for its existentially typed arguments in different clauses or
+types for its existentially typed arguments in different clauses
or in different subgoals of a single clause. For instance, both
of the following examples are illegal:
@@ -5307,7 +5307,7 @@
with respect to the declarative semantics, and so long as they meet a
minimum level of completeness (they must be at least as complete as the
strict commutative semantics, in the sense that every program which
-terminates for all possible orderings must must also terminate in any
+terminates for all possible orderings must also terminate in any
implementation-defined operational semantics).
This compromise allows Mercury to be used in several different ways.
@@ -5341,7 +5341,7 @@
prevents the compiler from improving completeness by optimizing away infinite
loops or calls to @code{require__error/1} or @code{exception__throw/1}.)
The default semantics are the commutative semantics. Enabling all of these
-options gives you the the strict sequential semantics. Enabling just some
+options gives you the strict sequential semantics. Enabling just some
of them gives you a semantics somewhere in between.
Future implementations of Mercury may wish to offer other operational semantics.
@@ -5707,7 +5707,7 @@
Entities declared in @samp{pragma foreign_decl} declarations are
visible in @samp{pragma foreign_code} and @samp{pragma foreign_proc}
-declarations that specify the same foreign language and occur in in the
+declarations that specify the same foreign language and occur in the
same Mercury module.
To make the declarations for Mercury predicates or functions
@@ -5762,7 +5762,7 @@
Entities declared in @samp{pragma foreign_code} declarations are
visible in @samp{pragma foreign_proc} declarations that specify the same
-foreign language and occur in in the same Mercury module.
+foreign language and occur in the same Mercury module.
@c -----------------------------------------------------------------------
@@ -5856,7 +5856,7 @@
an assignment.
(For example, it may be @code{#define}d to a register, so you should not
try to take its address.)
-Procedures whose determinism indicates that that they cannot fail
+Procedures whose determinism indicates that they cannot fail
should not access @code{SUCCESS_INDICATOR}.
Arguments whose mode is input will have their values set by the
@@ -6030,7 +6030,7 @@
@end example
@noindent
-C# code for procedures whose determinism indicates that that they cannot fail
+C# code for procedures whose determinism indicates that they cannot fail
should not access @code{succeeded}.
Arguments whose mode is input will have their values set by the
@@ -6279,7 +6279,7 @@
@end example
@noindent
-MC++ code for procedures whose determinism indicates that that they cannot fail
+MC++ code for procedures whose determinism indicates that they cannot fail
should not access @code{succeeded}.
Arguments whose mode is input will have their values set by the
@@ -6526,7 +6526,7 @@
an assignment.
(For example, it may be @code{#define}d to a register, so you should not
try to take its address.)
-Procedures whose determinism indicates that that they cannot fail
+Procedures whose determinism indicates that they cannot fail
should not access @code{SUCCESS_INDICATOR}.
Arguments whose mode is input will have their values set by the
@@ -7097,7 +7097,7 @@
a data structure that may still be live on backtracking,
you should record whatever information is necessary to restore it
on a stack-like data structure called the ``trail''. Then, if
-a computation fails, and execution backtracks to before those
+a computation fails, and execution backtracks to before
those updates were performed, the Mercury runtime engine will
traverse the trail back to the most recent choice point,
undoing all those updates.
Index: doc/user_guide.texi
===================================================================
RCS file: /home/mercury1/repository/mercury/doc/user_guide.texi,v
retrieving revision 1.372
diff -u -r1.372 user_guide.texi
--- doc/user_guide.texi 23 Jul 2003 03:38:45 -0000 1.372
+++ doc/user_guide.texi 31 Jul 2003 08:00:51 -0000
@@ -2385,7 +2385,7 @@
if a previous option suppressed it.
@c The --assume-all-io-is-tabled option is for developers only. Specifying it
@c makes an assertion, and if the assertion is incorrect, the resulting
- at c behavior would be hard for non-developers to understand. The option is
+ at c behaviour would be hard for non-developers to understand. The option is
@c therefore deliberately not documented.
@c
@c @sp 1
@@ -3161,7 +3161,7 @@
@c @item dd [--assume-all-io-is-tabled]
@c The --assume-all-io-is-tabled option is for developers only. Specifying it
@c makes an assertion, and if the assertion is incorrect, the resulting
- at c behavior would be hard for non-developers to understand. The option is
+ at c behaviour would be hard for non-developers to understand. The option is
@c therefore deliberately not documented.
Starts declarative debugging
using the current event as the initial symptom.
@@ -3288,7 +3288,7 @@
@c @item dd_dd [--assume-all-io-is-tabled] [filename]
@c The --assume-all-io-is-tabled option is for developers only. Specifying it
@c makes an assertion, and if the assertion is incorrect, the resulting
- at c behavior would be hard for non-developers to understand. The option is
+ at c behaviour would be hard for non-developers to understand. The option is
@c therefore deliberately not documented.
Starts declarative debugging
using the current event as the initial symptom,
@@ -7020,7 +7020,7 @@
@cindex Threads, Debugging
Output information to the standard error stream about the locking and
-unlocking occuring in each module which has been compiled with the C macro
+unlocking occurring in each module which has been compiled with the C macro
symbol @samp{MR_DEBUG_THREADS} defined.
@end table
--------------------------------------------------------------------------
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