Clean up comments to be careful about the distinction between variable-

width types and varlena types, since with the introduction of CSTRING as
a more-or-less-real type, these concepts aren't identical.  I've tried to
use varlena consistently to denote datatypes with typlen = -1, ie, they
have a length word and are potentially TOASTable; while the term variable
width covers both varlena and cstring (and, perhaps, someday other types
with other rules for computing the actual width).  No code changes in this
commit except for renaming a couple macros.

1 files changed, 16 insertions, 19 deletions

diff --git a/src/include/c.h b/src/include/c.h
index bfae5536a5..96a568712d 100644
--- a/src/include/c.h
+++ b/src/include/c.h
@@ -4,15 +4,15 @@
  *	  Fundamental C definitions.  This is included by every .c file in
  *	  PostgreSQL (via either postgres.h or postgres_fe.h, as appropriate).
  *
- *	  Note that the definitions here are not intended to be exposed to clients of
- *	  the frontend interface libraries --- so we don't worry much about polluting
- *	  the namespace with lots of stuff...
+ *	  Note that the definitions here are not intended to be exposed to clients
+ *	  of the frontend interface libraries --- so we don't worry much about
+ *	  polluting the namespace with lots of stuff...
  *
  *
  * Portions Copyright (c) 1996-2002, PostgreSQL Global Development Group
  * Portions Copyright (c) 1994, Regents of the University of California
  *
- * $Id: c.h,v 1.122 2002/08/21 17:20:58 petere Exp $
+ * $Id: c.h,v 1.123 2002/08/25 17:20:01 tgl Exp $
  *
  *-------------------------------------------------------------------------
  */
@@ -36,18 +36,19 @@
  *		8)		system-specific hacks
  *
  * NOTE: since this file is included by both frontend and backend modules, it's
- * almost certainly wrong to put an "extern" declaration here.	typedefs and macros
- * are the kind of thing that might go here.
+ * almost certainly wrong to put an "extern" declaration here.	typedefs and
+ * macros are the kind of thing that might go here.
  *
  *----------------------------------------------------------------
  */
 #ifndef C_H
 #define C_H
 
-/* We have to include stdlib.h here because it defines many of these macros
-   on some platforms, and we only want our definitions used if stdlib.h doesn't
-   have its own.  The same goes for stddef and stdarg if present.
-*/
+/*
+ * We have to include stdlib.h here because it defines many of these macros
+ * on some platforms, and we only want our definitions used if stdlib.h doesn't
+ * have its own.  The same goes for stddef and stdarg if present.
+ */
 
 #include "pg_config.h"
 #include "postgres_ext.h"
@@ -387,10 +388,11 @@ typedef struct
 /* ----------------
  *		Variable-length datatypes all share the 'struct varlena' header.
  *
- * NOTE: for TOASTable types, this is an oversimplification, since the value may be
- * compressed or moved out-of-line.  However datatype-specific routines are mostly
- * content to deal with de-TOASTed values only, and of course client-side routines
- * should never see a TOASTed value.  See postgres.h for details of the TOASTed form.
+ * NOTE: for TOASTable types, this is an oversimplification, since the value
+ * may be compressed or moved out-of-line.  However datatype-specific routines
+ * are mostly content to deal with de-TOASTed values only, and of course
+ * client-side routines should never see a TOASTed value.  See postgres.h for
+ * details of the TOASTed form.
  * ----------------
  */
 struct varlena
@@ -662,9 +664,4 @@ extern int	vsnprintf(char *str, size_t count, const char *fmt, va_list args);
 #define memmove(d, s, c)		bcopy(s, d, c)
 #endif
 
-/* ----------------
- *		end of c.h
- * ----------------
- */
-
 #endif   /* C_H */