Commit0efecb5

committed

Doc: update pg_list.h header comments to include XidLists.

I realize that the XidList infrastructure is rather incomplete,but failing to mention it in adjacent comments takes that a bittoo far.

1 parent935277b commit0efecb5Copy full SHA for 0efecb5

File tree

-4

lines changed

-4

lines changed

Lines changed: 6 additions & 4 deletions

Original file line number	Diff line number	Diff line change
`@@ -15,16 +15,18 @@`
`15`	`15`	`* Non-empty lists have a header, which will not be relocated as long as the`
`16`	`16`	`* list remains non-empty, and an expansible data array.`
`17`	`17`	`*`
`18`		`- * We supportthree types of lists:`
	`18`	`+ * We supportfour types of lists:`
`19`	`19`	`*`
`20`	`20`	`*T_List: lists of pointers`
`21`	`21`	`*(in practice usually pointers to Nodes, but not always;`
`22`	`22`	`declared as "void " to minimize casting annoyances)`
`23`	`23`	`*T_IntList: lists of integers`
`24`	`24`	`*T_OidList: lists of Oids`
	`25`	`+ *T_XidList: lists of TransactionIds`
	`26`	`+ *(the XidList infrastructure is less complete than the other cases)`
`25`	`27`	`*`
`26`		`- * (At the moment, intsandOids are the same size, but they may not`
`27`		`- * always be so;try tobe careful tomaintain thedistinction.)`
	`28`	`+ * (At the moment, ints, Oids,andXIDs are the same size, but they may not`
	`29`	`+ * always be so; be careful touse theappropriate list type for your data.)`
`28`	`30`	`*`
`29`	`31`	`*`
`30`	`32`	`* Portions Copyright (c) 1996-2022, PostgreSQL Global Development Group`
`@@ -50,7 +52,7 @@ typedef union ListCell`
`50`	`52`
`51`	`53`	`typedefstructList`
`52`	`54`	`{`
`53`		`-NodeTagtype;/* T_List, T_IntList, orT_OidList */`
	`55`	`+NodeTagtype;/* T_List, T_IntList,T_OidList,orT_XidList */`
`54`	`56`	`intlength;/* number of elements currently present */`
`55`	`57`	`intmax_length;/* allocated length of elements[] */`
`56`	`58`	`ListCellelements;/ re-allocatable array of cells */`

Comments

(0)