pg.ddx.io pgsql-hackers@postgresql.org mailing list archive
help / color / mirror / Atom feedSmall doc fix for pageinspect
3+ messages / 2 participants
[nested] [flat]
* Small doc fix for pageinspect
@ 2019-03-07 20:00 Laurenz Albe <laurenz.albe@cybertec.at>
2019-03-08 06:13 ` Re: Small doc fix for pageinspect Michael Paquier <michael@paquier.xyz>
0 siblings, 1 reply; 3+ messages in thread
From: Laurenz Albe @ 2019-03-07 20:00 UTC (permalink / raw)
To: pgsql-hackers
I noticed today that the signature for two functions is wrong
in the documentation:
- "heap_page_item_attrs" has the argument order and return type wrong
and is lacking types
- "tuple_data_split" is lacking the type for "rel_oid"
Patch attached.
This should be backpatched down to 9.6 where the functions have been added.
Yours,
Laurenz Albe
Attachments:
[text/x-patch] 0001-Fix-documentation-of-pageinspect-function-signatures.patch (1.4K, ../../8f9ab7b16daf623e87eeef5203a4ffc0dece8dfd.camel@cybertec.at/2-0001-Fix-documentation-of-pageinspect-function-signatures.patch)
download | inline diff:
From 4e9655a24a8f86b020c50431eba2376f624a3def Mon Sep 17 00:00:00 2001
From: Laurenz Albe <laurenz.albe@cybertec.at>
Date: Thu, 7 Mar 2019 20:50:05 +0100
Subject: [PATCH] Fix documentation of pageinspect function signatures
---
doc/src/sgml/pageinspect.sgml | 4 ++--
1 file changed, 2 insertions(+), 2 deletions(-)
diff --git a/doc/src/sgml/pageinspect.sgml b/doc/src/sgml/pageinspect.sgml
index 9cbe34c9d9..eac67352ec 100644
--- a/doc/src/sgml/pageinspect.sgml
+++ b/doc/src/sgml/pageinspect.sgml
@@ -156,7 +156,7 @@ test=# SELECT * FROM heap_page_items(get_raw_page('pg_class', 0));
<varlistentry>
<term>
- <function>tuple_data_split(rel_oid, t_data bytea, t_infomask integer, t_infomask2 integer, t_bits text [, do_detoast bool]) returns bytea[]</function>
+ <function>tuple_data_split(rel_oid oid, t_data bytea, t_infomask integer, t_infomask2 integer, t_bits text [, do_detoast bool]) returns bytea[]</function>
<indexterm>
<primary>tuple_data_split</primary>
</indexterm>
@@ -181,7 +181,7 @@ test=# SELECT tuple_data_split('pg_class'::regclass, t_data, t_infomask, t_infom
<varlistentry>
<term>
- <function>heap_page_item_attrs(rel_oid, t_data bytea, [, do_detoast bool]) returns bytea[]</function>
+ <function>heap_page_item_attrs(t_data bytea, rel_oid regclass, [, do_detoast bool]) returns setof record</function>
<indexterm>
<primary>heap_page_item_attrs</primary>
</indexterm>
--
2.20.1
^ permalink raw reply [nested|flat] 3+ messages in thread
* Re: Small doc fix for pageinspect
2019-03-07 20:00 Small doc fix for pageinspect Laurenz Albe <laurenz.albe@cybertec.at>
@ 2019-03-08 06:13 ` Michael Paquier <michael@paquier.xyz>
2019-03-08 09:15 ` Re: Small doc fix for pageinspect Laurenz Albe <laurenz.albe@cybertec.at>
0 siblings, 1 reply; 3+ messages in thread
From: Michael Paquier @ 2019-03-08 06:13 UTC (permalink / raw)
To: Laurenz Albe <laurenz.albe@cybertec.at>; +Cc: pgsql-hackers
On Thu, Mar 07, 2019 at 09:00:24PM +0100, Laurenz Albe wrote:
> This should be backpatched down to 9.6 where the functions have been
> added.
Thanks, applied. The second argument name of heap_page_item_attrs is
actually "page", and not "t_data", so both your patch and the docs
were wrong on this point.
--
Michael
Attachments:
[application/pgp-signature] signature.asc (832B, ../../20190308061300.GH4099@paquier.xyz/2-signature.asc)
download
^ permalink raw reply [nested|flat] 3+ messages in thread
* Re: Small doc fix for pageinspect
2019-03-07 20:00 Small doc fix for pageinspect Laurenz Albe <laurenz.albe@cybertec.at>
2019-03-08 06:13 ` Re: Small doc fix for pageinspect Michael Paquier <michael@paquier.xyz>
@ 2019-03-08 09:15 ` Laurenz Albe <laurenz.albe@cybertec.at>
0 siblings, 0 replies; 3+ messages in thread
From: Laurenz Albe @ 2019-03-08 09:15 UTC (permalink / raw)
To: Michael Paquier <michael@paquier.xyz>; +Cc: pgsql-hackers
Michael Paquier wrote:
> On Thu, Mar 07, 2019 at 09:00:24PM +0100, Laurenz Albe wrote:
> > This should be backpatched down to 9.6 where the functions have been
> > added.
>
> Thanks, applied. The second argument name of heap_page_item_attrs is
> actually "page", and not "t_data", so both your patch and the docs
> were wrong on this point.
Thanks, and pardon the sloppiness.
Yours,
Laurenz Albe
^ permalink raw reply [nested|flat] 3+ messages in thread
end of thread, other threads:[~2019-03-08 09:15 UTC | newest]
Thread overview: 3+ messages (download: mbox mbox.gz follow: Atom feed)
-- links below jump to the message on this page --
2019-03-07 20:00 Small doc fix for pageinspect Laurenz Albe <laurenz.albe@cybertec.at>
2019-03-08 06:13 ` Michael Paquier <michael@paquier.xyz>
2019-03-08 09:15 ` Laurenz Albe <laurenz.albe@cybertec.at>
This inbox is served by DDX for PostgreSQL; see mirroring instructions
for how to clone and mirror all data and code used for this inbox