summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorNayuki Minase <nayuki@eigenstate.org>2012-08-26 15:18:41 +0000
committerNayuki Minase <nayuki@eigenstate.org>2012-08-26 15:18:41 +0000
commitb3848a1e4f66defca7095bedd8dc5c4ba539f59d (patch)
tree87e9b59687800d87976e976dd225657cab6e7a15 /doc
parent67c2baf190fa4d1b82c308ceb807076b71b4b866 (diff)
downloadmc-b3848a1e4f66defca7095bedd8dc5c4ba539f59d.tar.gz
Tweak wording in manpage docs.
Diffstat (limited to 'doc')
-rw-r--r--doc/mc.116
-rw-r--r--doc/muse.115
2 files changed, 15 insertions, 16 deletions
diff --git a/doc/mc.1 b/doc/mc.1
index 5178092..551d85d 100644
--- a/doc/mc.1
+++ b/doc/mc.1
@@ -32,12 +32,12 @@ The compiler options are:
.TP
.B -d [flTri]
-Prints debugging dumps. Additional options may be given to give more
+Print debugging dumps. Additional options may be given to give more
debugging information for specific intermediate states of the compilation.
.TP
.B -h
-Prints a summary of the available options.
+Print a summary of the available options.
.TP
.B -I path
@@ -48,11 +48,11 @@ any options, the search path defaults to /usr/include/myr.
.TP
.B -o output-file
-Specifies that the generated code should be placed in
+Specify that the generated code should be placed in
.TP
.B -S
-Generate assembly instead of an object file.
+Generate assembly code instead of an object file.
.SH EXAMPLE
.EX
@@ -62,7 +62,7 @@ Generate assembly instead of an object file.
.EE
.SH FILES
-The source for this compiler is available from
+The source code for this compiler is available from
.B git://git.eigenstate.org/git/ori/mc2.git
.SH SEE ALSO
@@ -78,7 +78,7 @@ constructs in spite of their desirability.
There are virtually no optimizations done, and the generated source is
often very poorly performing.
.PP
-The current calling convention is stack, and not register, based, even
-on architectures where it should be register based.
+The current calling convention is stack-based and not register-based, even
+on architectures where it should be register-based.
.PP
-The calling convention is not C compatible.
+The calling convention is not compatible with C.
diff --git a/doc/muse.1 b/doc/muse.1
index a7a3de2..c96a599 100644
--- a/doc/muse.1
+++ b/doc/muse.1
@@ -17,9 +17,9 @@ It can also merge together a number of usefiles into one larger usefile
including all of the exported symbols. If an output file name is not given,
and we are not merging usefiles, then an input file named
.I filename.myr
-will have a usefile named
+will generate a usefile named
.I filename.use
-generated.
+\&.
If the filename does not end with the suffix
.I .myr
@@ -28,22 +28,21 @@ then the suffix
will simply be appended to it.
.PP
-The muse program is architecture independent, and a usefile generated
-on one architecture will work with another. However, the format of the
+The output of muse is architecture-independent. However, the format of the
generated file is not stable, and is not guaranteed to work across
-compiler versions.
+different compiler versions.
.PP
The muse options are:
.TP
.B -d [flTri]
-Prints debugging dumps. Additional options may be given to give more
+Print debugging dumps. Additional options may be given to give more
debugging information for specific intermediate states of the compilation.
.TP
.B -h
-Prints a summary of the available options.
+Print a summary of the available options.
.TP
.B -I path
@@ -54,7 +53,7 @@ any options, the search path defaults to /usr/include/myr.
.TP
.B -o output-file
-Specifies that the generated usefile should be named
+Specify that the generated usefile should be named
.I output-file
.TP