Documentation updates.

diff --git a/ChangeLog b/ChangeLog
index 9fcb13ed26f1179b26cbb5abc5e870f86679b5ed..becc5524bce6f1f05cbe12b96617d9aa814ea1ff 100644 (file)
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,4 +1,9 @@
 
+2004-08-05  Rhys Weatherley  <rweather@southern-storm.com.au>
+
+       * doc/Makefile.am, doc/README, doc/libjit.texi,
+       jit/jit-dump.c, jit/jit-insn.c: documentation updates.
+
 2004-08-04  Rhys Weatherley  <rweather@southern-storm.com.au>
 
        * jit/jit-opcode.c: fix the operand types for "call_vtable_ptr".

diff --git a/doc/Makefile.am b/doc/Makefile.am
index f37b4d69fe4a466e3072760f2f10865ab1ced561..d20680c9730e21faf8c3f969d4603c117ddccfa6 100644 (file)
--- a/doc/Makefile.am
+++ b/doc/Makefile.am
@@ -8,6 +8,7 @@ libjit_TEXINFOS = \
        $(srcdir)/libjitext-apply.texi \
        $(srcdir)/libjitext-block.texi \
        $(srcdir)/libjitext-context.texi \
+       $(srcdir)/libjitext-dump.texi \
        $(srcdir)/libjitext-dynlib.texi \
        $(srcdir)/libjitext-elf-read.texi \
        $(srcdir)/libjitext-except.texi \
@@ -40,6 +41,9 @@ $(srcdir)/libjitext-block.texi: $(top_srcdir)/jit/jit-block.c
 $(srcdir)/libjitext-context.texi: $(top_srcdir)/jit/jit-context.c
        $(SHELL) $(srcdir)/extract-docs.sh $< >$@
 
+$(srcdir)/libjitext-dump.texi: $(top_srcdir)/jit/jit-dump.c
+       $(SHELL) $(srcdir)/extract-docs.sh $< >$@
+
 $(srcdir)/libjitext-dynlib.texi: $(top_srcdir)/jitdynamic/jit-dynlib.c
        $(SHELL) $(srcdir)/extract-docs.sh $< >$@
 

diff --git a/doc/README b/doc/README
new file mode 100644 (file)
index 0000000..395f135
--- /dev/null
+++ b/doc/README
@@ -0,0 +1,17 @@
+
+To generate HTML documentation, use the following command in the
+"libjit/doc" directory:
+
+       mkdir outdir
+       ./mkhtml.sh outdir
+
+where "outdir" is the name of the directory to place the generated
+HTML files in.
+
+To generate PDF documentation, use the following command in the
+"libjit/doc" directory:
+
+       ./mkpdf.sh
+
+This will generate "libjit.pdf".  You will need to have PDFTeX installed
+to do this.

diff --git a/doc/libjit.texi b/doc/libjit.texi
index 537c0233a19df7b013caaa6a4c822a6869aca87b..067affe308e78e15efdb724899968cdf56d1136d 100644 (file)
--- a/doc/libjit.texi
+++ b/doc/libjit.texi
@@ -47,6 +47,7 @@ Copyright @copyright{} 2004 Southern Storm Software, Pty Ltd
 * Exceptions::              Handling exceptions
 * ELF Binaries::            Manipulating ELF binaries
 * Utility Routines::        Miscellaneous utility routines
+* Debugging Routines::      Debugging routines
 * C++ Interface::           Using libjit from C++
 * Porting::                 Porting libjit to new architectures
 * Why GPL?::                Why we use GPL and not LGPL for libjit
@@ -1029,7 +1030,7 @@ field with a @code{pointer to procedure/function} type.
 
 @c -----------------------------------------------------------------------
 
-@node Utility Routines, C++ Interface, ELF Binaries, Top
+@node Utility Routines, Debugging Routines, ELF Binaries, Top
 @chapter Miscellaneous utility routines
 @cindex Utility routines
 @cindex jit-util.h
@@ -1048,7 +1049,15 @@ that it itself uses internally, but which may also be useful to front ends.
 
 @c -----------------------------------------------------------------------
 
-@node C++ Interface, C++ Contexts, Utility Routines, Top
+@node Debugging Routines, C++ Interface, Utility Routines, Top
+@chapter Debugging routines
+@cindex Debugging routines
+
+@include libjitext-dump.texi
+
+@c -----------------------------------------------------------------------
+
+@node C++ Interface, C++ Contexts, Debugging Routines, Top
 @chapter Using libjit from C++
 @cindex Using libjit from C++
 

diff --git a/jit/jit-dump.c b/jit/jit-dump.c
index 78bc1fa2568bac756aafb0ff1b3677864dad04ed..570c8bc502451d903997e12635b8f6cb6c1d393d 100644 (file)
--- a/jit/jit-dump.c
+++ b/jit/jit-dump.c
@@ -33,6 +33,12 @@
        #include "jit-interp.h"
 #endif
 
+/*@
+
+@cindex jit-dump.h
+
+@*/
+
 /*@
  * @deftypefun void jit_dump_type ({FILE *} stream, jit_type_t type)
  * Dump the name of a type to a stdio stream.

diff --git a/jit/jit-insn.c b/jit/jit-insn.c
index 94eedd4c6a1ef825f457f0863cbdf1ffa498d09b..e4f8bd48473aac48fc898fcbe8986dff55bbf42e 100644 (file)
--- a/jit/jit-insn.c
+++ b/jit/jit-insn.c
@@ -1421,7 +1421,9 @@ jit_value_t jit_insn_load_small(jit_function_t func, jit_value_t value)
 /*@
  * @deftypefun void jit_insn_store (jit_function_t func, jit_value_t dest, jit_value_t value)
  * Store the contents of @code{value} at the location referred to by
- * @code{dest}.
+ * @code{dest}.  The @code{dest} should be a @code{jit_value_t} representing a
+ * local variable or temporary.  Use @code{jit_insn_store_relative} to store
+ * to a location referred to by a pointer.
  * @end deftypefun
 @*/
 int jit_insn_store(jit_function_t func, jit_value_t dest, jit_value_t value)