Document that NAMEDATALEN must be a multiple of sizeof(int).

tglsfdc · tglsfdc · commit 1e4f34f3099c · 2002-04-30T19:53:03.000Z
diff --git a/src/include/c.h b/src/include/c.h
@@ -12,7 +12,7 @@
  * Portions Copyright (c) 1996-2001, PostgreSQL Global Development Group
  * Portions Copyright (c) 1994, Regents of the University of California
  *
- * $Id: c.h,v 1.119 2002/04/25 02:56:56 tgl Exp $
+ * $Id: c.h,v 1.120 2002/04/30 19:53:03 tgl Exp $
  *
  *-------------------------------------------------------------------------
  */
@@ -420,7 +420,9 @@ typedef Oid oidvector[INDEX_MAX_KEYS];
 /*
  * We want NameData to have length NAMEDATALEN and int alignment,
  * because that's how the data type 'name' is defined in pg_type.
- * Use a union to make sure the compiler agrees.
+ * Use a union to make sure the compiler agrees.  Note that NAMEDATALEN
+ * must be a multiple of sizeof(int), else sizeof(NameData) will probably
+ * not come out equal to NAMEDATALEN.
  */
 typedef union nameData
 {
diff --git a/src/include/postgres_ext.h b/src/include/postgres_ext.h
@@ -15,7 +15,7 @@
  *	use header files that are otherwise internal to Postgres to interface
  *	with the backend.
  *
- * $Id: postgres_ext.h,v 1.9 2001/10/28 06:25:59 momjian Exp $
+ * $Id: postgres_ext.h,v 1.10 2002/04/30 19:53:03 tgl Exp $
  *
  *-------------------------------------------------------------------------
  */
@@ -36,7 +36,8 @@ typedef unsigned int Oid;
 
 /*
  * NAMEDATALEN is the max length for system identifiers (e.g. table names,
- * attribute names, function names, etc.)
+ * attribute names, function names, etc).  It must be a multiple of
+ * sizeof(int) (typically 4).
  *
  * NOTE that databases with different NAMEDATALEN's cannot interoperate!
  */

Original file line number	Diff line number	Diff line change
`@@ -12,7 +12,7 @@`
`12`	`12`	`* Portions Copyright (c) 1996-2001, PostgreSQL Global Development Group`
`13`	`13`	`* Portions Copyright (c) 1994, Regents of the University of California`
`14`	`14`	`*`
`15`		`- * $Id: c.h,v 1.119 2002/04/25 02:56:56 tgl Exp $`
	`15`	`+ * $Id: c.h,v 1.120 2002/04/30 19:53:03 tgl Exp $`
`16`	`16`	`*`
`17`	`17`	`*-------------------------------------------------------------------------`
`18`	`18`	`*/`
`@@ -420,7 +420,9 @@ typedef Oid oidvector[INDEX_MAX_KEYS];`
`420`	`420`	`/*`
`421`	`421`	`* We want NameData to have length NAMEDATALEN and int alignment,`
`422`	`422`	`* because that's how the data type 'name' is defined in pg_type.`
`423`		`- * Use a union to make sure the compiler agrees.`
	`423`	`+ * Use a union to make sure the compiler agrees. Note that NAMEDATALEN`
	`424`	`+ * must be a multiple of sizeof(int), else sizeof(NameData) will probably`
	`425`	`+ * not come out equal to NAMEDATALEN.`
`424`	`426`	`*/`
`425`	`427`	`typedef union nameData`
`426`	`428`	`{`
Original file line number	Diff line number	Diff line change
`@@ -15,7 +15,7 @@`
`15`	`15`	`* use header files that are otherwise internal to Postgres to interface`
`16`	`16`	`* with the backend.`
`17`	`17`	`*`
`18`		`- * $Id: postgres_ext.h,v 1.9 2001/10/28 06:25:59 momjian Exp $`
	`18`	`+ * $Id: postgres_ext.h,v 1.10 2002/04/30 19:53:03 tgl Exp $`
`19`	`19`	`*`
`20`	`20`	`*-------------------------------------------------------------------------`
`21`	`21`	`*/`
`@@ -36,7 +36,8 @@ typedef unsigned int Oid;`
`36`	`36`
`37`	`37`	`/*`
`38`	`38`	`* NAMEDATALEN is the max length for system identifiers (e.g. table names,`
`39`		`- * attribute names, function names, etc.)`
	`39`	`+ * attribute names, function names, etc). It must be a multiple of`
	`40`	`+ * sizeof(int) (typically 4).`
`40`	`41`	`*`
`41`	`42`	`* NOTE that databases with different NAMEDATALEN's cannot interoperate!`
`42`	`43`	`*/`