Commit b1b38f05 authored by Benoit Perrot's avatar Benoit Perrot
Browse files

Begin documentation effort.

parent d9b399da
2003-06-29 Benot Perrot <benoit@lrde.epita.fr>
* doc/mipsy.texi, doc/fdl.texi, doc/Makefile.am,
* configure.ac:
Begin documentation effort.
2003-06-29 Benot Perrot <benoit@lrde.epita.fr>
* Makefile.am, src/Makefile.am, src/misc/Makefile.am,
......
......@@ -47,6 +47,7 @@ AC_CONFIG_FILES([
src/parse/Makefile
src/vm/Makefile
src/task/Makefile
doc/Makefile
])
# Instantiate the output files.
......
AM_MAKEINFOFLAGS = --no-split
TEXI2DVI = texi2dvi --batch
info_TEXINFOS = mipsy.texi
mipsy_TEXINFOS = fdl.texi
This diff is collapsed.
\input texinfo @c -*-texinfo-*-
@comment %**start of header
@setfilename mipsy.info
@include version.texi
@settitle Mipsy @value{VERSION}
@setchapternewpage odd
@finalout
@comment %**end of header
@c @href(URL, TITLE)
@c -----------------
@c A replacement for @uref that puts the URL in the footnotes when
@c not in HTML.
@ifhtml
@macro href{url, title}
@uref{\url\, \title\}
@end macro
@end ifhtml
@ifnothtml
@macro href{url, title}
\title\@footnote{\title\, @url{\url\}.}
@end macro
@end ifnothtml
@macro wiki
http://www.lrde.epita.fr/cgi-bin/twiki/view
@end macro
@macro mipsy
@acronym{MIPSY}
@end macro
@macro spim
@acronym{SPIM}
@end macro
@copying
This manual is for @acronym{MIPSY} (version @value{VERSION},
@value{UPDATED}), the tiny MIPS simulator.
Copyright @copyright{} 2003 Benoit Perrot.
@quotation
Permission is granted to copy, distribute and/or modify this document
under the terms of the @acronym{GNU} Free Documentation License,
Version 1.1 or any later version published by the Free Software
Foundation; with no Invariant Sections, with the Front-Cover texts
being ``A @acronym{GNU} Manual,'' and with the Back-Cover Texts as in
(a) below. A copy of the license is included in the section entitled
``@acronym{GNU} Free Documentation License.''
(a) The @acronym{FSF}'s Back-Cover Text is: ``You have freedom to copy
and modify this @acronym{GNU} Manual, like @acronym{GNU} software.
Copies published by the Free Software Foundation raise funds for
@acronym{GNU} development.''
@end quotation
@end copying
@dircategory GNU programming tools
@direntry
* mipsy: (mipsy). The Tiny MIPS Simulator.
@end direntry
@titlepage
@title mipsy
@subtitle The Tiny MIPS Simulator
@subtitle @value{UPDATED}, @acronym{MIPSY} Version @value{VERSION}
@author Benoit Perrot
@page
@vskip 0pt plus 1filll
@insertcopying
@end titlepage
@contents
@ifnottex
@node Top
@top Mipsy
@insertcopying
@end ifnottex
@mipsy{} is a MIPS simulator designed to execute simple register based
MIPS assembly code. It is a minimalist MIPS virtual machine, which
allows unlimited registers.
Its features are:
@itemize @minus
@item
sufficient support of MIPS instruction set
@item
illimited registers
@end itemize
It was written by Benoit Perrot as an @acronym{LRDE} member, so that
@acronym{EPITA} students could exercise their compiler projects after
the instruction selection but before the register allocation.
It is implemented in C++ and Python. Be aware that @mipsy{} does not need
a Python interpreter to run ; it is required to maintain @mipsy{}.
Information about @mipsy{} can be found on @href{@wiki{}/Projects/Mipsy,
@mipsy{} Home Page}, and feedback can be sent to
@href{projects@@lrde.epita.fr, @acronym{lrde}'s Projects Address}.
@acronym{LRDE} stands for @href{http://www.lrde.epita.fr, Laboratoire de
Recherche et Dévelopment de l'@acronym{EPITA}}, i.e., the Research and
Development Labof @acronym{EPITA}, the @href{http://www.epita.fr, Ecole
Pour l'Informatique et les Techniques Avancées}.
@href{FIXME:, Andrew Appel's home page} includes links to material
related to compilers theory, and some information about the
@href{FIXME:, Modern Compiler Implementation} book series.
More information on Python can be found on
@href{http://www.python.org, Python Home Page}.
@menu
* Invoking @mipsy{}::
* The @mipsy{} Language::
* Copying This Manual::
* Index::
@detailmenu
--- The Detailed Node Listing ---
The @mipsy{} Language
* The @mipsy{} supported instruction set::
* @mipsy{} features::
Copying This Manual
* GNU Free Documentation License:: License for copying this manual.
@end detailmenu
@end menu
@node Invoking @mipsy{}
@chapter Invoking @mipsy{}
To invoke @command{mipsy} run
@example
mipsy @var{options} @var{file}
@end example
@noindent
where @file{file.s} is a simple text file, and @var{options} is any
combination of the following options:
@table @code
@item -?
@itemx --help
Display a help message and exit successfully.
@item -V
@itemx --version
Display the version number and exit successfully.
@item FIXME:
Document the rest of it.
@end table
@node The @mipsy{} Language
@chapter The @mipsy{} Language
@mipsy{} supports a minimal MIPS instruction set and unlimited
registers.
@menu
* The @mipsy{} supported instruction set::
* @mipsy{} features::
@end menu
@node The @mipsy{} supported instruction set
@section The @mipsy{} supported instruction set
@node @mipsy{} features
@section @mipsy{} features
@node Copying This Manual
@appendix Copying This Manual
@menu
* GNU Free Documentation License:: License for copying this manual.
@end menu
@include fdl.texi
@node Index
@unnumbered Index
@printindex cp
@bye
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment