From: Rhys Weatherley <rweather@southern-storm.com.au>
Date: Thu, 5 Aug 2004 00:07:25 +0000 (+0000)
Subject: Documentation updates.
X-Git-Tag: r.0.0.4~2
X-Git-Url: https://git.unchartedbackwaters.co.uk/w/?a=commitdiff_plain;h=2cf88e3937d7e65c87617e6690914b4f0fe427d8;p=francis%2Flibjit.git

Documentation updates.
---

diff --git a/ChangeLog b/ChangeLog
index 9fcb13e..becc552 100644
--- 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 f37b4d6..d20680c 100644
--- 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
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 537c023..067affe 100644
--- 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 78bc1fa..570c8bc 100644
--- 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 94eedd4..e4f8bd4 100644
--- 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)