guile/guile-core HACKING

[Marius Vollmer]

CVSROOT:        /cvs
Module name:    guile
Changes by:     Marius Vollmer <address@hidden> 01/07/03 10:41:12

Modified files:
        guile-core     : HACKING 

Log message:
        More naming conventions.

CVSWeb URLs:
http://savannah.gnu.org/cgi-bin/viewcvs/guile/guile-core/HACKING.diff?cvsroot=OldCVS&tr1=1.52&tr2=1.53&r1=text&r2=text

Patches:
Index: guile/guile-core/HACKING
diff -u guile/guile-core/HACKING:1.52 guile/guile-core/HACKING:1.53
--- guile/guile-core/HACKING:1.52       Wed Jun 27 10:28:45 2001
+++ guile/guile-core/HACKING    Tue Jul  3 10:41:12 2001
@@ -292,14 +292,15 @@
 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
+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 underscores `_'.
+All non-static identifiers should start with scm_ or SCM_.  Then might
+follow zero or more 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
@@ -319,6 +320,20 @@
 
     s   - a constant C string
 
+    k   - a SCM variable pointing to a keyword.
+
+  sym   - a SCM variable pointing to a symbol.
+
+  var   - a SCM variable pointing to a variable object.
+
+The follwing syllables also have a technical meaning:
+
+  str   - this denotes a zero terminated C string
+
+  mem   - a C string with an explicit count
+
+
+See also the file `devel/names.text'.
 
 
 Helpful hints ========================================================