From: Tom Lane <tgl@sss.pgh.pa.us>
To: ray.brinzer@gmail.com
cc: pgsql-docs@lists.postgresql.org
Subject: Re: Example code bug: destination->data
In-reply-to: <166786713708.652.15395196776183543224@wrigleys.postgresql.org>
References: <166786713708.652.15395196776183543224@wrigleys.postgresql.org>
Comments: In-reply-to PG Doc comments form <noreply@postgresql.org>
	message dated "Tue, 08 Nov 2022 00:25:37 +0000"
MIME-Version: 1.0
Content-Type: text/plain; charset="UTF-8"
Content-ID: <3868102.1667945245.1@sss.pgh.pa.us>
Content-Transfer-Encoding: 8bit
Date: Tue, 08 Nov 2022 17:07:25 -0500
Message-ID: <3868103.1667945245@sss.pgh.pa.us>
Archived-At: 
 <https://www.postgresql.org/message-id/3868103.1667945245%40sss.pgh.pa.us>
Precedence: bulk

PG Doc comments form <noreply@postgresql.org> writes:
> 38.10.2. Base Types in C-Language Functions

> In the last example of the section, this line appears:
> memcpy(destination->data, buffer, 40);
> For me, this gave the following error:
> error: ‘text’ {aka ‘struct varlena’} has no member named ‘data’

> After tracking down the struct definition, I got the example working with: 
> destination->vl_dat instead.  I assume this is correct, and that the member
> name changed somewhere along the way.

Hmm.  It's correct by reference to the sample definition of struct
text just above ... but you're right that that has relatively little
to do with the definition we actually use nowadays.

However, referencing vl_dat[] isn't considered good style either
--- AFAICS there are exactly zero direct uses of that name.
The style actually used in the code is to rely on VARDATA() or
VARDATA_ANY(), as in the concat_text() example further down.

Maybe the best fix is to leave the example as it stands but add
a note that this is an oversimplified example?

			regards, tom lane