1
Fork 0
mirror of https://git.savannah.gnu.org/git/guile.git synced 2025-04-30 03:40:34 +02:00

Doc fixes from Martin Grabmüller.

This commit is contained in:
Marius Vollmer 2000-12-23 17:27:04 +00:00
parent 54a33a61d9
commit ee2bf8b833
5 changed files with 39 additions and 51 deletions

View file

@ -18,28 +18,35 @@ And it allows us to start testing features earlier.
Since the CVS tree is arranged for the convenience of the developers, Since the CVS tree is arranged for the convenience of the developers,
it requires GCC and GNU Make, which together support automatic it requires GCC and GNU Make, which together support automatic
dependency management. You will also need to install autoconf, dependency management. You will also need to install autoconf,
automake, and libtool; the recommended versions are listed in README. automake, and libtool; the recommended versions are listed in HACKING.
To check out a CVS working directory: To check out a CVS working directory:
1) Install CVS version 1.9 or later on your system. 1) Install CVS version 1.9 or later on your system.
2) Log into the CVS server: 2) Log into the CVS server:
$ cvs -d :pserver:anoncvs@anoncvs.cygnus.com:/cvs/guile login
At the prompt for `CVS password:', type `anoncvs'. $ cvs -d :pserver:anoncvs@subversions.gnu.org:/cvs login
At the prompt for `CVS password:', simply press the enter key.
Once you have logged in, your password is saved in ~/.cvspass, and you Once you have logged in, your password is saved in ~/.cvspass, and you
will not need to enter it again. will not need to enter it again.
3) Check out a module: 3) Check out a module:
$ cvs -z 9 -d :pserver:anoncvs@anoncvs.cygnus.com:/cvs/guile checkout guile-core
$ cvs -z 9 -d :pserver:anoncvs@subversions.gnu.org:/cvs checkout guile-core
This should create a new directory `guile-core' in your current This should create a new directory `guile-core' in your current
directory, and populate it with the current Guile sources. directory, and populate it with the current Guile sources.
4) In the top directory of the source tree, run the command `./autogen.sh'. 4) In the top directory of the source tree, run the command `./autogen.sh'.
This builds the configure script, Makefile.in, and other derived files This builds the configure script, Makefile.in, and other derived files
used by the build system. used by the build system.
The modules available for checkout are: The modules available for checkout are:
guile-core --- The scheme interpreter itself. guile-core --- The scheme interpreter itself.
guile-doc --- Guile documentation-in-progress. guile-doc --- Guile documentation-in-progress.
guile-oops --- GOOPS Guile Object Oriented Programming System.
guile-tcltk --- An interface between Guile and Tcl/Tk. guile-tcltk --- An interface between Guile and Tcl/Tk.
guile-scsh --- An incomplete port of SCSH 0.4.4 to Guile. guile-scsh --- An incomplete port of SCSH 0.4.4 to Guile.
guile-rgx-ctax --- This has been discontinued; use Andrew Archibald's guile-rgx-ctax --- This has been discontinued; use Andrew Archibald's
@ -52,27 +59,21 @@ and efficiently:
1) Go to the top directory of the source tree. That is, your current 1) Go to the top directory of the source tree. That is, your current
directory should be the one containing `configure.in', `README', directory should be the one containing `configure.in', `README',
and so on. and so on.
2) Do the update: 2) Do the update:
$ cvs update $ cvs update
This will incorporate any changes the developers have made to Guile This will incorporate any changes the developers have made to Guile
since your last update into your source tree. since your last update into your source tree.
The EGCS Project is kindly lending us space, time, and bandwidth on
their CVS server. Thanks, folks!
Change Notification ================================================== Change Notification ==================================================
If you would like to receive mail when people commit changes to the If you would like to receive mail when people commit changes to the
Guile CVS repository, you can subscribe to guile-cvs@egcs.cygnus.com Guile CVS repository, you can subscribe to guile-cvs@gnu.org by using
by sending a message to guile-cvs-subscribe@egcs.cygnus.com. Even the Mailman mailing list interface at
better, you can get daily digests of these commit messages by sending
a message to guile-cvs-digest-subscribe@egcs.cygnus.com.
If you want to subscribe an e-mail address other than the one that <http://mail.gnu.org/mailman/listinfo/guile-cvs>
appears in your From: header, say foo@bar.com, send a mail note to
guile-cvs-subscribe-foo=bar.com@egcs.cygnus.com.
Questions ============================================================ Questions ============================================================
@ -100,12 +101,3 @@ Questions ============================================================
command will not overwrite them; instead, CVS will try to merge its command will not overwrite them; instead, CVS will try to merge its
changes with your changes, as if you had applied a patch. Rejects are changes with your changes, as if you had applied a patch. Rejects are
marked in the sources. marked in the sources.
- Why does the build process try to run autoconf, aclocal, or automake?
It shouldn't; if it does, that's a bug, I think. Those are the
tools we use to generate `configure', `aclocal.m4', and the
`Makefile.in' files from their respective sources. Ideally, you
shouldn't need to have them installed, if you don't want to change
those sources. If you do, see the section in `README' called
`Hacking It Yourself'.

26
HACKING
View file

@ -36,7 +36,7 @@ Contributing Your Changes ============================================
- If you have put together a change that meets the coding standards - If you have put together a change that meets the coding standards
described below, we encourage you to submit it to Guile. The best described below, we encourage you to submit it to Guile. The best
place to post it is guile@sourceware.cygnus.com. Please don't send it place to post it is guile-devel@gnu.org. Please don't send it
directly to me; I often don't have time to look things over. If you directly to me; I often don't have time to look things over. If you
have tested your change, then you don't need to be shy. have tested your change, then you don't need to be shy.
@ -53,14 +53,14 @@ we're just going to regenerate those files anyway.
CVS conventions ====================================================== CVS conventions ======================================================
- We use CVS to manage the Guile sources. The repository lives on - We use CVS to manage the Guile sources. The repository lives on
egcs.cygnus.com, in /cvs/guile; you will need an subversions.gnu.org, in /cvs; you will need an
account on that machine to access the repository. Also, for security account on that machine to access the repository. Also, for security
reasons, egcs presently only supports CVS connections via the SSH reasons, subversions presently only supports CVS connections via the SSH
protocol, so you must first install the SSH client. Then, you should protocol, so you must first install the SSH client. Then, you should
set your CVS_RSH environment variable to ssh, and use the following as set your CVS_RSH environment variable to ssh, and use the following as
your CVS root: your CVS root:
:ext:USER@egcs.cygnus.com:/cvs/guile :ext:USER@subversions.gnu.org:/cvs
Either set your CVSROOT environment variable to that, or give it as Either set your CVSROOT environment variable to that, or give it as
the value of the global -d option to CVS when you check out a working the value of the global -d option to CVS when you check out a working
@ -73,7 +73,6 @@ The Guile sources live in several modules:
- guile-core --- the interpreter, QuickThreads, and ice-9 - guile-core --- the interpreter, QuickThreads, and ice-9
- guile-doc --- documentation in progress. When complete, this will - guile-doc --- documentation in progress. When complete, this will
be incorporated into guile-core. be incorporated into guile-core.
- guile-oops --- The Guile Object-Oriented Programming System (talk to mdj)
- guile-tcltk --- the Guile/Tk interface - guile-tcltk --- the Guile/Tk interface
- guile-tk --- the new Guile/Tk interface, based on STk's modified Tk - guile-tk --- the new Guile/Tk interface, based on STk's modified Tk
- guile-rgx-ctax --- the Guile/Rx interface, and the ctax implementation - guile-rgx-ctax --- the Guile/Rx interface, and the ctax implementation
@ -131,12 +130,13 @@ make-stds.texi.
- The Guile tree should compile without warnings under the following - The Guile tree should compile without warnings under the following
GCC switches, which are the default in the current configure script: GCC switches, which are the default in the current configure script:
-O2 -Wall -Wpointer-arith -Wmissing-prototypes -O2 -Wall -Wpointer-arith -Wmissing-prototypes The only warnings
The only warnings which can be tolerated are those about variables which can be tolerated are those about variables being clobbered by
being clobbered by longjmp/vfork in eval.c. The variables in question longjmp/vfork in eval.c. The variables in question are critical to
are critical to the interpreter's performance; as far as I can tell, the interpreter's performance; as far as I can tell, it is
it is difficult/annoying to avoid these warnings without slowing the difficult/annoying to avoid these warnings without slowing the system
system down substantially. (If you can figure out a good fix, I'd be happy to see it.) down substantially. (If you can figure out a good fix, I'd be happy
to see it.)
Note that the warnings generated vary from one version of GCC to the Note that the warnings generated vary from one version of GCC to the
next, and from one architecture to the next (apparently). To provide next, and from one architecture to the next (apparently). To provide
@ -169,7 +169,7 @@ is our purpose to remove functionality. Don't deprecate definitions
if it is unclear when they will be removed. (This is to ensure that a if it is unclear when they will be removed. (This is to ensure that a
valid way of implementing some functionality always exists.) valid way of implementing some functionality always exists.)
When deprecating a definition, always following this procedure: When deprecating a definition, always follow this procedure:
1. Mark the definition using 1. Mark the definition using
@ -182,7 +182,7 @@ can manage without the deprecated definition.
3. Add an entry that the definition has been deprecated in NEWS 3. Add an entry that the definition has been deprecated in NEWS
4. At the top of release, there is a list of releases with reminders 4. At the top of RELEASE, there is a list of releases with reminders
about what to do at each release. Add a reminder about the removal of about what to do at each release. Add a reminder about the removal of
the deprecated defintion at the appropriate release. the deprecated defintion at the appropriate release.

View file

@ -103,6 +103,7 @@ A Guile compiled with this option provides the primitive
`malloc-stats' which returns an alist with pairs of kind and the `malloc-stats' which returns an alist with pairs of kind and the
number of objects of that kind. number of objects of that kind.
--enable-guile-debug --- Include internal debugging functions
--disable-arrays --- omit array and uniform array support --disable-arrays --- omit array and uniform array support
--disable-posix --- omit posix interfaces --disable-posix --- omit posix interfaces
--disable-networking --- omit networking interfaces --disable-networking --- omit networking interfaces

20
README
View file

@ -158,14 +158,10 @@ CVS, and by nightly snapshots, accessible via FTP. See the files
`ANON-CVS' and `SNAPSHOTS' for details. `ANON-CVS' and `SNAPSHOTS' for details.
If you would like to receive mail when people commit changes to the If you would like to receive mail when people commit changes to the
Guile CVS repository, you can subscribe to guile-cvs@sourceware.cygnus.com Guile CVS repository, you can subscribe to guile-cvs@gnu.org by the
by sending a message to guile-cvs-subscribe@sourceware.cygnus.com. Even Mailman mailing list interface at
better, you can get daily digests of these commit messages by sending
a message to guile-cvs-digest-subscribe@sourceware.cygnus.com.
If you want to subscribe an e-mail address other than the one that <http://mail.gnu.org/mailman/listinfo/guile-cvs>
appears in your From: header, say foo@bar.com, send a mail note to
guile-cvs-subscribe-foo=bar.com@sourceware.cygnus.com.
Obtaining Guile ====================================================== Obtaining Guile ======================================================
@ -174,8 +170,8 @@ The latest official Guile release is available via anonymous FTP from
ftp://ftp.gnu.org/pub/gnu/guile/guile-1.4.tar.gz ftp://ftp.gnu.org/pub/gnu/guile/guile-1.4.tar.gz
The mailing list `guile@sourceware.cygnus.com' carries discussions, The mailing list `guile-user@gnu.org' carries discussions, questions,
questions, and often answers, about Guile. To subscribe, send mail to and often answers, about Guile. To subscribe, use the Mailman mailing
guile-subscribe@sourceware.cygnus.com. Of course, please send bug list interface at <http://mail.gnu.org/mailman/listinfo/guile-user>
reports (and fixes!) to bug-guile@gnu.org. Note that one address is Of course, please send bug reports (and fixes!) to bug-guile@gnu.org.
@sourceware.cygnus.com, and the other is at @gnu.org.

View file

@ -24,8 +24,7 @@ Via the web, that's:
For getit, that's: For getit, that's:
ftp.red-bean.com:/pub/guile/snapshots/guile-core-snap.tar.gz ftp.red-bean.com:/pub/guile/snapshots/guile-core-snap.tar.gz
The snapshot FTP site is mirrored at the following locations: The snapshot FTP site is mirrored at the following location:
Austria: ftp://ftp.aec.at/pub/guile
Japan: ftp://ftp.jaist.ac.jp/pub/lang/scheme/guile Japan: ftp://ftp.jaist.ac.jp/pub/lang/scheme/guile