1
Fork 0
mirror of https://git.savannah.gnu.org/git/guile.git synced 2025-05-02 21:10:27 +02:00

* Fix doc snapshot build problems by avoiding use of ../AUTHORS file.

* Use TEXINFO_TEX to avoid shipping multiple copies of texinfo.tex.
This commit is contained in:
Neil Jerram 2001-08-27 21:25:44 +00:00
parent fada26b27e
commit b45898cae3
16 changed files with 157 additions and 21 deletions

View file

View file

@ -1,3 +1,11 @@
2001-08-27 Neil Jerram <neil@ossau.uklinux.net>
* mltext.texi (Guile Character Properties): Fix `hexidecimal'
spelling errors (merge from stable branch).
* AUTHORS: Removed. Authorship information for each manual is now
in the top-level Texinfo file for that manual.
2001-08-24 Neil Jerram <neil@ossau.uklinux.net> 2001-08-24 Neil Jerram <neil@ossau.uklinux.net>
* Makefile.am: Split documentation into per-manual subdirectories. * Makefile.am: Split documentation into per-manual subdirectories.

14
doc/goops/ChangeLog Normal file
View file

@ -0,0 +1,14 @@
2001-08-27 Neil Jerram <neil@ossau.uklinux.net>
* Makefile.am (goops_TEXINFOS): Remove ../AUTHORS.
(TEXINFO_TEX): Added; avoids shipping multiple copies of
texinfo.tex in a single distribution.
* goops.texi: Incorporate text previously in separate AUTHORS
file.
2001-08-27 Neil Jerram <neil@ossau.uklinux.net>
The change log for files in this directory continues backwards
from 2001-08-27 in ../ChangeLog, as all the Guile documentation
prior to this date was contained in a single directory.

View file

@ -23,7 +23,9 @@ AUTOMAKE_OPTIONS = gnu
info_TEXINFOS = goops.texi info_TEXINFOS = goops.texi
goops_TEXINFOS = goops-tutorial.texi hierarchy.eps hierarchy.txt ../AUTHORS goops_TEXINFOS = goops-tutorial.texi hierarchy.eps hierarchy.txt
TEXINFO_TEX = ../ref/texinfo.tex
# Optionally support building an HTML version of the manual. # Optionally support building an HTML version of the manual.

View file

@ -40,7 +40,22 @@ are preserved on all copies.
@titlepage @titlepage
@title Goops Manual @title Goops Manual
@subtitle For use with GOOPS @value{VERSION} @subtitle For use with GOOPS @value{VERSION}
@include ../AUTHORS
@c AUTHORS
@c The GOOPS tutorial was written by Christian Lynbech and Mikael
@c Djurfeldt, who also wrote GOOPS itself. The GOOPS reference manual
@c and MOP documentation were written by Neil Jerram and reviewed by
@c Mikael Djurfeldt.
@author Christian Lynbech
@author @email{chl@@tbit.dk}
@author
@author Mikael Djurfeldt
@author @email{djurfeldt@@nada.kth.se}
@author
@author Neil Jerram
@author @email{neil@@ossau.uklinux.net}
@c The following two commands @c The following two commands
@c start the copyright page. @c start the copyright page.

View file

@ -53,7 +53,7 @@ Return non-zero iff @var{c} is a whitespace character.
@end deftypefn @end deftypefn
@deftypefn {Libguile Function} int scm_mb_isxdigit (scm_mb_char_t @var{c}) @deftypefn {Libguile Function} int scm_mb_isxdigit (scm_mb_char_t @var{c})
Return non-zero iff @var{c} is a hexidecimal digit. Return non-zero iff @var{c} is a hexadecimal digit.
@end deftypefn @end deftypefn
@deftypefn {Libguile Function} int scm_mb_isdefined (scm_mb_char_t @var{c}) @deftypefn {Libguile Function} int scm_mb_isdefined (scm_mb_char_t @var{c})
@ -69,7 +69,7 @@ unchanged.
@end deftypefn @end deftypefn
@deftypefn {Libguile Function} in scm_mb_digit_value (scm_mb_char_t @var{c}) @deftypefn {Libguile Function} in scm_mb_digit_value (scm_mb_char_t @var{c})
If @var{c} is a hexidecimal digit (according to If @var{c} is a hexadecimal digit (according to
@code{scm_mb_isxdigit}), then return its numeric value. Otherwise @code{scm_mb_isxdigit}), then return its numeric value. Otherwise
return -1. return -1.
@end deftypefn @end deftypefn

10
doc/r5rs/ChangeLog Normal file
View file

@ -0,0 +1,10 @@
2001-08-27 Neil Jerram <neil@ossau.uklinux.net>
* Makefile.am (TEXINFO_TEX): Added; avoids shipping multiple copies of
texinfo.tex in a single distribution.
2001-08-27 Neil Jerram <neil@ossau.uklinux.net>
The change log for files in this directory continues backwards
from 2001-08-27 in ../ChangeLog, as all the Guile documentation
prior to this date was contained in a single directory.

View file

@ -22,3 +22,5 @@
AUTOMAKE_OPTIONS = gnu AUTOMAKE_OPTIONS = gnu
info_TEXINFOS = r5rs.texi info_TEXINFOS = r5rs.texi
TEXINFO_TEX = ../ref/texinfo.tex

14
doc/ref/ChangeLog Normal file
View file

@ -0,0 +1,14 @@
2001-08-27 Neil Jerram <neil@ossau.uklinux.net>
* intro.texi: Merged wording fixes from stable CVS branch.
* Makefile.am (guile_TEXINFOS): Remove ../AUTHORS.
* guile.texi: Incorporate text previously in separate AUTHORS
file.
2001-08-27 Neil Jerram <neil@ossau.uklinux.net>
The change log for files in this directory continues backwards
from 2001-08-27 in ../ChangeLog, as all the Guile documentation
prior to this date was contained in a single directory.

View file

@ -32,8 +32,7 @@ guile_TEXINFOS = preface.texi intro.texi scheme-intro.texi \
scheme-reading.texi scheme-indices.texi slib.texi posix.texi \ scheme-reading.texi scheme-indices.texi slib.texi posix.texi \
expect.texi scsh.texi tcltk.texi scripts.texi gh.texi scm.texi \ expect.texi scsh.texi tcltk.texi scripts.texi gh.texi scm.texi \
appendices.texi indices.texi script-getopt.texi data-rep.texi \ appendices.texi indices.texi script-getopt.texi data-rep.texi \
extend.texi repl-modules.texi srfi-modules.texi misc-modules.texi \ extend.texi repl-modules.texi srfi-modules.texi misc-modules.texi
../AUTHORS
# Optionally support building an HTML version of the reference manual. # Optionally support building an HTML version of the reference manual.

View file

@ -80,9 +80,60 @@ by the Free Software Foundation.
@sp 10 @sp 10
@comment The title is printed in a large font. @comment The title is printed in a large font.
@title Guile Reference Manual @title Guile Reference Manual
@subtitle $Id: guile.texi,v 1.2 2001-08-24 10:16:15 ossau Exp $ @subtitle $Id: guile.texi,v 1.3 2001-08-27 21:25:44 ossau Exp $
@subtitle For use with Guile @value{VERSION} @subtitle For use with Guile @value{VERSION}
@include ../AUTHORS
@c AUTHORS
@c The Guile reference and tutorial manuals were written and edited
@c largely by Mark Galassi and Jim Blandy. In particular, Jim wrote the
@c original tutorial on Guile's data representation and the C API for
@c accessing Guile objects.
@c Significant portions were contributed by Gary Houston (contributions
@c to posix system calls and networking, expect, I/O internals and
@c extensions, slib installation, error handling) and Tim Pierce
@c (sections on script interpreter triggers, alists, function tracing).
@c Tom Lord contributed a great deal of material with early Guile
@c snapshots; although most of this text has been rewritten, all of it
@c was important, and some of the structure remains.
@c Aubrey Jaffer wrote the SCM Scheme implementation and manual upon
@c which the Guile program and manual are based. Some portions of the
@c SCM and SLIB manuals have been included here verbatim.
@c Since Guile 1.4, Neil Jerram has been maintaining and improving the
@c reference manual. Among other contributions, he wrote the Basic
@c Ideas chapter, developed the tools for keeping the manual in sync
@c with snarfed libguile docstrings, and reorganized the structure so as
@c to accommodate docstrings for all Guile's primitives.
@c Martin Grabmueller has made substantial contributions throughout the
@c reference manual in preparation for the Guile 1.6 release, including
@c filling out a lot of the documentation of Scheme data types, control
@c mechanisms and procedures. In addition, he wrote the documentation
@c for Guile's SRFI modules and modules associated with the Guile REPL.
@author Mark Galassi
@author Cygnus Solution and Los Alamos National Laboratory
@author @email{rosalia@@cygnus.com}
@author
@author Jim Blandy
@author Free Software Foundation and MIT AI Lab
@author @email{jimb@@red-bean.com}
@author
@author Gary Houston
@author @email{ghouston@@arglist.com}
@author
@author Tim Pierce
@author @email{twp@@skepsis.com}
@author
@author Neil Jerram
@author @email{neil@@ossau.uklinux.net}
@author
@author Martin Grabmueller
@author @email{mgrabmue@@cs.tu-berlin.de}
@c The following two commands start the copyright page. @c The following two commands start the copyright page.
@page @page

View file

@ -1,4 +1,4 @@
@c $Id: intro.texi,v 1.1 2001-08-24 09:40:29 ossau Exp $ @c $Id: intro.texi,v 1.2 2001-08-27 21:25:44 ossau Exp $
@page @page
@node What is Guile? @node What is Guile?
@ -359,7 +359,7 @@ manual. Once you've compiled your source files, you need to link them
against the Guile object code library, @code{libguile}. against the Guile object code library, @code{libguile}.
On most systems, you should not need to do tell the compiler and linker On most systems, you should not need to do tell the compiler and linker
explicitely where they can find @file{libguile.h} and @file{libguile}. explicitly where they can find @file{libguile.h} and @file{libguile}.
When Guile has been installed in a peculiar way, or when you are on a When Guile has been installed in a peculiar way, or when you are on a
peculiar system, things might not be so easy and you might need to pass peculiar system, things might not be so easy and you might need to pass
additional @code{-I} or @code{-L} options to the compiler. Guile additional @code{-I} or @code{-L} options to the compiler. Guile
@ -410,7 +410,7 @@ Why must the caller do all the real work from @var{main_func}? Guile's
garbage collector scans the stack to find all local variables that garbage collector scans the stack to find all local variables that
reference Scheme objects. To do this, it needs to know the bounds of reference Scheme objects. To do this, it needs to know the bounds of
the stack that might contain such references. Because there is no the stack that might contain such references. Because there is no
protable way in C to find the base of the stack, @code{scm_boot_guile} portable way in C to find the base of the stack, @code{scm_boot_guile}
assumes that all references are above its own stack frame. If you try assumes that all references are above its own stack frame. If you try
to manipulate Scheme objects after this function returns, it's the luck to manipulate Scheme objects after this function returns, it's the luck
of the draw whether Guile's storage manager will be able to find the of the draw whether Guile's storage manager will be able to find the
@ -632,7 +632,7 @@ available to Scheme. First we need to write the appropriate glue code
to convert the arguments and return values of the functions from Scheme to convert the arguments and return values of the functions from Scheme
to C and back. Additionally, we need a function that will add them to to C and back. Additionally, we need a function that will add them to
the set of Guile primitives. Because this is just an example, we will the set of Guile primitives. Because this is just an example, we will
only implement this for the @code{j0} function, tho. only implement this for the @code{j0} function.
Consider the following file @file{bessel.c}. Consider the following file @file{bessel.c}.
@ -729,7 +729,7 @@ guile -c '(write %load-path) (newline)'
Suppose you want to use the procedures and variables exported by the Suppose you want to use the procedures and variables exported by the
module @code{(ice-9 popen)}, which provides the means for communicating module @code{(ice-9 popen)}, which provides the means for communicating
with other processes over pipes. Add the following line to your with other processes over pipes. Add the following line to your
currently running Guile REPL or the top of you script file. currently running Guile REPL or the top of your script file.
@lisp @lisp
(use-modules (ice-9 popen)) (use-modules (ice-9 popen))
@ -840,7 +840,7 @@ is the current one. Thus, the call to @code{scm_c_define_gsubr} will
put the new definition for @code{j0} into it, just as we want it. put the new definition for @code{j0} into it, just as we want it.
The definitions made in the C code are not automatically exported from The definitions made in the C code are not automatically exported from
a module. You need to explicitely list the ones you want to export in a module. You need to explicitly list the ones you want to export in
@code{export} statements or with the @code{:export} option of @code{export} statements or with the @code{:export} option of
@code{define-module}. @code{define-module}.
@ -961,7 +961,7 @@ Of course, if the bug is that Guile gets a fatal signal, then one can't
miss it. But if the bug is incorrect results, the maintainer might fail miss it. But if the bug is incorrect results, the maintainer might fail
to notice what is wrong. Why leave it to chance? to notice what is wrong. Why leave it to chance?
If the manifestation of the bug is an Guile error message, it is If the manifestation of the bug is a Guile error message, it is
important to report the precise text of the error message, and a important to report the precise text of the error message, and a
backtrace showing how the Scheme program arrived at the error. backtrace showing how the Scheme program arrived at the error.
@ -978,7 +978,7 @@ programs that you must load into Guile in order to cause the problem to
occur. occur.
@item @item
If the problem does depend on an init file or other Lisp programs that If the problem does depend on an init file or other Scheme programs that
are not part of the standard Guile distribution, then you should make are not part of the standard Guile distribution, then you should make
sure it is not a bug in those programs by complaining to their sure it is not a bug in those programs by complaining to their
maintainers first. After they verify that they are using Guile in a way maintainers first. After they verify that they are using Guile in a way
@ -988,7 +988,7 @@ that is supposed to work, they should report the bug.
If you wish to mention something in the Guile source, show the line of If you wish to mention something in the Guile source, show the line of
code with a few lines of context. Don't just give a line number. code with a few lines of context. Don't just give a line number.
The line numbers in the development sources don't match those in your The line numbers in the development sources might not match those in your
sources. It would take extra work for the maintainers to determine what sources. It would take extra work for the maintainers to determine what
code is in your version at a given line number, and we could not be code is in your version at a given line number, and we could not be
certain. certain.
@ -1001,8 +1001,7 @@ very long, and using GDB is easy. You can find the GDB distribution,
including the GDB manual in online form, in most of the same places you including the GDB manual in online form, in most of the same places you
can find the Guile distribution. To run Guile under GDB, you should can find the Guile distribution. To run Guile under GDB, you should
switch to the @file{libguile} subdirectory in which Guile was compiled, then switch to the @file{libguile} subdirectory in which Guile was compiled, then
do @code{gdb .libs/guile}. do @code{gdb guile} or @code{gdb .libs/guile} (if using GNU Libtool).
@c fixme: libguile/.libs is for libtool-enabled systems -- what about rest?
However, you need to think when you collect the additional information However, you need to think when you collect the additional information
if you want it to show what causes the bug. if you want it to show what causes the bug.

5
doc/sources/ChangeLog Normal file
View file

@ -0,0 +1,5 @@
2001-08-27 Neil Jerram <neil@ossau.uklinux.net>
The change log for files in this directory continues backwards
from 2001-08-27 in ../ChangeLog, as all the Guile documentation
prior to this date was contained in a single directory.

14
doc/tutorial/ChangeLog Normal file
View file

@ -0,0 +1,14 @@
2001-08-27 Neil Jerram <neil@ossau.uklinux.net>
* Makefile.am (guile_tut_TEXINFOS): Removed.
(TEXINFO_TEX): Added; avoids shipping multiple copies of
texinfo.tex in a single distribution.
* guile-tut.texi: Incorporate text previously in separate AUTHORS
file.
2001-08-27 Neil Jerram <neil@ossau.uklinux.net>
The change log for files in this directory continues backwards
from 2001-08-27 in ../ChangeLog, as all the Guile documentation
prior to this date was contained in a single directory.

View file

@ -23,7 +23,7 @@ AUTOMAKE_OPTIONS = gnu
info_TEXINFOS = guile-tut.texi info_TEXINFOS = guile-tut.texi
guile_tut_TEXINFOS = ../AUTHORS TEXINFO_TEX = ../ref/texinfo.tex
# Optionally support building an HTML version of the reference manual. # Optionally support building an HTML version of the reference manual.

View file

@ -27,7 +27,10 @@
@title Guile Tutorial @title Guile Tutorial
@subtitle For use with Guile @value{VERSION} @subtitle For use with Guile @value{VERSION}
@subtitle Last updated @value{UPDATED} @subtitle Last updated @value{UPDATED}
@include ../AUTHORS
@author Mark Galassi
@author Cygnus Solutions and Los Alamos National Laboratory
@author @email{rosalia@@nis.lanl.gov}
@page @page
@vskip 0pt plus 1filll @vskip 0pt plus 1filll