mirror/guile
mirror/guile
1
Fork 0
mirror of https://git.savannah.gnu.org/git/guile.git synced 2025-06-13 23:20:32 +02:00
Code Activity

(Using Guile Modules): Review; remove reviewme comment.

Browse source 
Expand `GUILE_LOAD_PATH' blurb; add small example.
(Reporting Bugs): Review; remove reviewme comment.
Reword some phrases; add texi markup.
Add suggestion to include `guile-config info' output.
Update gdb invocation; add fixme question.
This commit is contained in:
Thien-Thi Nguyen 2001-05-06 01:49:56 +00:00
parent 26c1d5495b
commit 5134bfa751
1 changed files with 35 additions and 36 deletions
Download patch file Download diff file Expand all files Collapse all files

49
doc/intro.texi
View file

@ -1,4 +1,4 @@
@c $Id: intro.texi,v 1.6 2001-04-20 07:31:25 mgrabmue Exp $ @c $Id: intro.texi,v 1.7 2001-05-06 01:49:56 ttn Exp $
@page @page
@node What is Guile? @node What is Guile?
@ -708,18 +708,20 @@ provide reasonable backwards compatability.)
@node Using Guile Modules @node Using Guile Modules
@subsection Using Existing Modules @subsection Using Existing Modules
@c FIXME::martin: Review me!
@c FIXME::martin: More? Or leave the rest to the module chapter?
Guile comes with a lot of useful modules, for example for string Guile comes with a lot of useful modules, for example for string
processing or command line parsing. Additionally, there exist many processing or command line parsing. Additionally, there exist many
Guile modules written by other Guile hackers, but which have to be Guile modules written by other Guile hackers, but which have to be
installed manually. installed manually.
Existing modules have to be placed in places where Guile looks for them Existing modules have to be placed in places where Guile looks for them
by default or in directories in the environment variable by default or in colon-separated directories in the environment variable
@code{GUILE_LOAD_PATH}. @code{GUILE_LOAD_PATH}. When this variable is set, those directories
are searched first, then the the default. The following command
shows the complete list of directories searched:
@smallexample
guile -c '(for-each write-line %load-path)'
@end smallexample
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
@ -831,18 +833,13 @@ for example as @file{/usr/local/share/guile/math/bessel.scm}.
@node Reporting Bugs @node Reporting Bugs
@chapter Reporting Bugs @chapter Reporting Bugs
@c FIXME::martin: Review me!
@c FIXME::martin: A lot of this was taken from the Emacs reference
@c manual and adapted. I guess that is okay?
Any problems with the installation should be reported to Any problems with the installation should be reported to
@email{bug-guile@@gnu.org}. @email{bug-guile@@gnu.org}.
Whenever you have found a bug in Guile you are encouraged to report it Whenever you have found a bug in Guile you are encouraged to report it
to the Guile developers, so they can fix it. They may probably have to the Guile developers, so they can fix it. They may also be able to
also advice what to do to work around a bug when it is not possible for suggest workarounds when it is not possible for you to apply the bugfix
you to apply the bugfix or install a new version of Guile yourself. or install a new version of Guile yourself.
Before sending in bug reports, please check with the following list that Before sending in bug reports, please check with the following list that
you really have found a bug. you really have found a bug.
@ -865,7 +862,6 @@ When calculations produce wrong results, it is a bug.
When Guile signals an error for valid Scheme programs, it is a bug. When Guile signals an error for valid Scheme programs, it is a bug.
@item @item
@c FIXME::martin: Too strict?
When Guile does not signal an error for invalid Scheme programs, it may When Guile does not signal an error for invalid Scheme programs, it may
be a bug, unless this is explicitly documented. be a bug, unless this is explicitly documented.
@ -877,7 +873,7 @@ to you even after re--reading the section, it is a bug.
When you write a bug report, please make sure to include as much of the When you write a bug report, please make sure to include as much of the
information described below in the report. If you can't figure out some information described below in the report. If you can't figure out some
of the items, it is not a problem, but the more information we get, the of the items, it is not a problem, but the more information we get, the
better are chances we can diagnose and fix the bug. more likely we can diagnose and fix the bug.
@itemize @bullet @itemize @bullet
@item @item
@ -907,7 +903,8 @@ Linux tortoise 2.2.17 #1 Thu Dec 21 17:29:05 CET 2000 i586 unknown
@item @item
The operands given to the @file{configure} command when Guile was The operands given to the @file{configure} command when Guile was
installed. installed. It's often useful to augment this with the output of the
command @code{guile-config info}.
@item @item
A complete list of any modifications you have made to the Guile source. A complete list of any modifications you have made to the Guile source.
@ -953,12 +950,13 @@ This can be done using the procedure @code{backtrace} in the REPL.
@item @item
Check whether any programs you have loaded into Guile, including your Check whether any programs you have loaded into Guile, including your
`.guile' file, set any variables that may affect the functioning of @file{.guile} file, set any variables that may affect the functioning of
Guile. Also, see whether the problem happens in a freshly started Guile Guile. Also, see whether the problem happens in a freshly started Guile
without loading your `.guile file (start Guile with the `-q' switch to without loading your @file{.guile} file (start Guile with the @code{-q}
prevent loading the init file). If the problem does _not_ occur then, switch to prevent loading the init file). If the problem does
you must report the precise contents of any programs that you must load @emph{not} occur then, you must report the precise contents of any
into Guile in order to cause the problem to occur. programs that you must load into Guile in order to cause the problem to
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 Lisp programs that
@ -983,8 +981,9 @@ If you don't know how to use GDB, please read the GDB manual--it is not
very long, and using GDB is easy. You can find the GDB distribution, 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 `libguile' subdirectory in which Guile was compiled, then switch to the @file{libguile} subdirectory in which Guile was compiled, then
do `gdb guile'. do @code{gdb .libs/guile}.
@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.