summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--6/main.c2
-rw-r--r--Makefile3
-rw-r--r--doc/Makefile14
-rw-r--r--doc/mc.12
-rw-r--r--doc/muse.14
-rw-r--r--doc/myrbuild.166
6 files changed, 86 insertions, 5 deletions
diff --git a/6/main.c b/6/main.c
index 40482f4..e3147e4 100644
--- a/6/main.c
+++ b/6/main.c
@@ -97,7 +97,7 @@ int main(int argc, char **argv)
if (debugopt['T'])
dump(file, stdout);
infer(file);
- /* after all processing */
+ /* after all type inference */
if (debugopt['t'])
dump(file, stdout);
diff --git a/Makefile b/Makefile
index 1443c48..b2cf441 100644
--- a/Makefile
+++ b/Makefile
@@ -3,7 +3,8 @@ SUB = parse \
6 \
muse \
myrbuild \
- libstd
+ libstd \
+ doc
include mk/c.mk
include config.mk
diff --git a/doc/Makefile b/doc/Makefile
new file mode 100644
index 0000000..e173db5
--- /dev/null
+++ b/doc/Makefile
@@ -0,0 +1,14 @@
+MAN=mc.1 \
+ muse.1 \
+ myrbuild.1 \
+
+include ../config.mk
+
+all:
+
+install:
+ @echo install $(MAN) $(INST_ROOT)/share/man/man1; \
+ mkdir -p $(INST_ROOT)/share/man/man1; \
+ install $(MAN) $(INST_ROOT)/share/man/man1; \
+
+
diff --git a/doc/mc.1 b/doc/mc.1
index 551d85d..471d013 100644
--- a/doc/mc.1
+++ b/doc/mc.1
@@ -63,7 +63,7 @@ Generate assembly code instead of an object file.
.SH FILES
The source code for this compiler is available from
-.B git://git.eigenstate.org/git/ori/mc2.git
+.B git://git.eigenstate.org/git/ori/mc.git
.SH SEE ALSO
.IR muse(1)
diff --git a/doc/muse.1 b/doc/muse.1
index c96a599..d56d072 100644
--- a/doc/muse.1
+++ b/doc/muse.1
@@ -69,9 +69,9 @@ Print a summary of the symbols exported from the usefile that is specified.
.SH FILES
The source for muse is available from
-.B git://git.eigenstate.org/git/ori/mc2.git
+.B git://git.eigenstate.org/git/ori/mc.git
and lives in the
-.I util/
+.I muse/
directory within the source tree.
.SH SEE ALSO
diff --git a/doc/myrbuild.1 b/doc/myrbuild.1
new file mode 100644
index 0000000..7eb2693
--- /dev/null
+++ b/doc/myrbuild.1
@@ -0,0 +1,66 @@
+.TH MUSE 1
+.SH NAME
+myrbuild
+.SH SYNOPSIS
+.B myrbuild
+.I -[hblI]
+.I [file...]
+.br
+.SH DESCRIPTION
+.PP
+The 'myrbuild' tool takes as input a list of Myrddin or assembly sources,
+and compiles them in the correct dependency order into either a library or
+an executable. If the source files are myrddin sources, then the appropriate
+usefiles will be created as well. It expects Myrddin source to be in '.myr'
+files.
+
+.PP
+Myrbuild will default to building for the current architecture.
+
+.PP
+The myrbuild options are:
+
+.TP
+.B -h
+Print a summary of the available options.
+
+.TP
+.B -b name
+Compile source into a binary named 'name'. If neither this option nor
+the '-l' option are given, myrbuild will create a binary called 'a.out'.
+
+.TP
+.B -l 'name'
+Compile source given into a library called 'lib<name>.a', and a matching
+usefile called 'name'. Only static libraries are currently supported.
+
+.TP
+.B -I path
+Add 'path' to the search path for unquoted use statments. This option
+does not affect the search path for local usefiles, which are always
+searched relative to the compiler's current working directory. Without
+any options, the search path defaults to /usr/include/myr.
+
+.SH EXAMPLE
+.EX
+ myrbuild -b foo foo.myr
+ myrbuild -l foo bar.myr baz.myr
+ muse -mo library foo.use bar.use
+.EE
+
+.SH FILES
+The source for muse is available from
+.B git://git.eigenstate.org/git/ori/mc.git
+and lives in the
+.I myrbuild/
+directory within the source tree.
+
+.SH SEE ALSO
+.IR mc(1)
+.IR muse(1)
+.IR ld(1)
+.IR as(1)
+
+.SH BUGS
+.PP
+None known.