+Guile Hacking Guide
+Copyright (c) 1996, 1997, 1998, 1999, 2000, 2001 Free software Foundation, Inc.
+
+ Permission is granted to anyone to make or distribute verbatim copies
+ of this document as received, in any medium, provided that the
+ copyright notice and permission notice are preserved,
+ and that the distributor grants the recipient permission
+ for further redistribution as permitted by this notice.
+
+ Permission is granted to distribute modified versions
+ of this document, or of portions of it,
+ under the above conditions, provided also that they
+ carry prominent notices stating who last changed them,
+ and that any new or changed statements about the activities
+ of the Free Software Foundation are approved by the Foundation.
+
+
+What to Hack =========================================================
+
+You can hack whatever you want, thank GNU.
+
+However, to see what others have indicated as their interest (and avoid
+potential wasteful duplication of effort), see devel/tasks.text. Note
+that this file is available only from CVS checkout and not distributed
+w/ Guile releases.
+
+It's also a good idea to join the guile-devel@gnu.org mailing list.
+See http://www.gnu.org/software/guile/mail/mail.html for more info.
+
+
Hacking It Yourself ==================================================
As distributed, Guile needs only an ANSI C compiler and a Unix system
find it helpful to have the tools we use to develop Guile. They
are the following:
-Autoconf 2.13 --- a system for automatically generating `configure'
+Autoconf 2.50 --- a system for automatically generating `configure'
scripts from templates which list the non-portable features a
program would like to use. Available in
"ftp://ftp.gnu.org/pub/gnu/autoconf"
-Automake 1.4 --- a system for automatically generating Makefiles that
+Automake 1.4-p2 --- a system for automatically generating Makefiles that
conform to the (rather Byzantine) GNU coding standards. The
nice thing is that it takes care of hairy targets like 'make
dist' and 'make distclean', and automatically generates
`guile.m4' from the top directory of the Guile core disty to
`/usr/local/share/aclocal.
-libtool 1.3.4 --- a system for managing the zillion hairy options needed
+libtool 1.4 --- a system for managing the zillion hairy options needed
on various systems to produce shared libraries. Available in
"ftp://ftp.gnu.org/pub/gnu/libtool"
+flex 2.5.4 --- a tokenizer generator. earlier versions will most
+ probably work too.
+
You are lost in a little maze of automatically generated files, all
different.
->
Contributing Your Changes ============================================
- If you have put together a change that meets the coding standards
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
have tested your change, then you don't need to be shy.
CVS conventions ======================================================
- 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
-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
set your CVS_RSH environment variable to ssh, and use the following as
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
the value of the global -d option to CVS when you check out a working
- guile-core --- the interpreter, QuickThreads, and ice-9
- guile-doc --- documentation in progress. When complete, this will
be incorporated into guile-core.
- - guile-oops --- The Guile Object-Oriented Programming System (talk to mdj)
- guile-tcltk --- the Guile/Tk interface
- guile-tk --- the new Guile/Tk interface, based on STk's modified Tk
- guile-rgx-ctax --- the Guile/Rx interface, and the ctax implementation
- The Guile tree should compile without warnings under the following
GCC switches, which are the default in the current configure script:
+
-O2 -Wall -Wpointer-arith -Wmissing-prototypes
-The only warnings which can be tolerated are those about variables
-being clobbered by longjmp/vfork in eval.c. The variables in question
-are critical to the interpreter's performance; as far as I can tell,
-it is difficult/annoying to avoid these warnings without slowing the
-system 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
next, and from one architecture to the next (apparently). To provide
entails adding a test to configure.in, and then adding #ifdefs to your
code to disable it if the system's features are missing.
+- The normal way of removing a function, macro or variable is to mark
+it as "deprecated", keep it for a while, and remove it in a later
+release. If a function or macro is marked as "deprecated" it
+indicates that people shouldn't use it in new programs, and should try
+to remove it in old. Make sure that an alternative exists unless it
+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
+valid way of implementing some functionality always exists.)
+
+When deprecating a definition, always follow this procedure:
+
+1. Mark the definition using
+
+ #if (SCM_DEBUG_DEPRECATED == 0)
+ ...
+ #endif
+
+ or, for Scheme code, wrap it using
+
+ (begin-deprecated
+ ...)
+
+2. Make the deprecated code issue a warning when it is used, by using
+ scm_c_issue_deprecation_warning (in C) or issue-deprecation-warning
+ (in Scheme).
+
+3. Write a comment at the definition explaining how a programmer can
+ manage without the deprecated definition.
+
+4. Add an entry that the definition has been deprecated in NEWS and
+ explain what do do instead.
+
+5. 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 the deprecated defintion at the appropriate release.
+
- When you make a user-visible change (i.e. one that should be
documented, and appear in NEWS, put an asterisk in column zero of the
start of the ChangeLog entry, like so:
Changes like adding this line are special:
- SCM_PROC (s_serial_map, "serial-map", 2, 0, 1, scm_map);
+ SCM_PROC (s_map_in_order, "map-in-order", 2, 0, 1, scm_map);
Since the change here is about the name itself --- we're adding a new
alias for scm_map that guarantees the order in which we process list
and I'll take care of the administrivia. Put the contributions aside
until we have the necessary papers.
+Once you accept a contribution, be sure to keep the files AUTHORS and
+THANKS uptodate.
+
- When you make substantial changes to a file, add the current year to
the list of years in the copyright notice at the top of the file.
+- When you get bug reports or patches from people, be sure to list
+them in THANKS.
+
+
+- Naming conventions. We use certain naming conventions to structure
+ the considerable number of global identifiers. All identifiers
+ should be either all lower case or all upper case. Syllables are
+ separated by underscaores `_'. All non-static identifiers should
+ start with scm_ or SCM_. Then might follow zero or more one letter
+ syllables giving the category of the identifier. The currently used
+ category identifiers are
+
+ t - type name
+
+ c,C - something with a interface suited for C use. This is used
+ to name functions that behave like Scheme primitives but
+ have a more C friendly calling convention.
+
+ i,I - internal to libguile. It is global, but not considered part
+ of the libguile API.
+
+ f - a SCM variable pointing to a Scheme function object.
+
+ F - a bit mask for a flag.
+
+ m - a macro transformer procedure
+
+ n,N - a count of something
+
+ s - a constant C string
+
+
Helpful hints ========================================================
--- cvs-1.10/src/cvs.h Mon Jul 27 04:54:11 1998
+++ cvs-1.10.ignore-hack/src/cvs.h Sun Jan 23 12:58:09 2000
@@ -516,7 +516,7 @@
-
+
extern int ign_name PROTO ((char *name));
void ign_add PROTO((char *ign, int hold));
-void ign_add_file PROTO((char *file, int hold));
free (line);
+ return 1;
}
-
+
/* Parse a line of space-separated wildcards and add them to the list. */
@@ -375,6 +376,7 @@
struct stat sb;
char *file;
char *xdir;
+ char *cvsdotignore;
-
+
/* Set SUBDIRS if we have subdirectory information in ENTRIES. */
if (entries == NULL)
@@ -397,7 +399,10 @@
if (dirp == NULL)
return;
-
+
- ign_add_file (CVSDOTIGNORE, 1);
+ cvsdotignore = getenv("CVSDOTIGNORE");
+ if (cvsdotignore == NULL || !ign_add_file (cvsdotignore, 1))
+ ign_add_file (CVSDOTIGNORE, 1);
+
wrap_add_file (CVSDOTWRAPPER, 1);
-
+
while ((dp = readdir (dirp)) != NULL)
=== patch end ===
Can only be used in the *cvs* buffer."
(save-window-excursion
- (set-buffer (find-file-noselect (expand-file-name ".cvsignore" dir)))
-+ (set-buffer (find-file-noselect
++ (set-buffer (find-file-noselect
+ (expand-file-name (or (getenv "CVSDOTIGNORE")
+ ".cvsignore")
+ dir)))
HCoop / bpt / guile.git / blobdiff