diff src/alloc.c @ 3355:721daee0fcd8

[xemacs-hg @ 2006-04-23 20:12:25 by aidan] Take on board feedback from Stephen on my last changes.
author aidan
date Sun, 23 Apr 2006 20:12:31 +0000
parents 1043bbfa24cf
children fd2936bbfc5f
line wrap: on
line diff
--- a/src/alloc.c	Sun Apr 23 16:11:34 2006 +0000
+++ b/src/alloc.c	Sun Apr 23 20:12:31 2006 +0000
@@ -1255,7 +1255,16 @@
 				     Lisp_Cons);
 
 DEFUN ("cons", Fcons, 2, 2, 0, /*
-Create a new cons, give it CAR and CDR as components, and return it.
+Create a new cons cell, give it CAR and CDR as components, and return it.
+
+A cons cell is a Lisp object (an area in memory) made up of two pointers
+called the CAR and the CDR.  Each of these pointers can point to any other
+Lisp object.  The common Lisp data type, the list, is a specially-structured
+series of cons cells.
+
+The pointers are accessed from Lisp with `car' and `cdr', and mutated with
+`setcar' and `setcdr' respectively.  For historical reasons, the aliases
+`rplaca' and `rplacd' (for `setcar' and `setcdr') are supported.
 */
        (car, cdr))
 {