From: Bruce Momjian <bruce@momjian.us>
Date: Sat, 25 Nov 2023 03:02:07 +0000 (-0500)
Subject: doc:  gin_page_opaque_info() must be a _compressed_ GIN page
X-Git-Tag: REL_17_BETA1~1408
X-Git-Url: http://git.postgresql.org/gitweb/?a=commitdiff_plain;h=9890a855ae82d2185c6dcd98f0071a0c889cacc3;p=postgresql.git

doc:  gin_page_opaque_info() must be a _compressed_ GIN page

Reported-by: Jeff Janes

Discussion: https://postgr.es/m/CAMkU=1xvzQxTAiYNM2PWJ6snMTPh3u3Ammbwss7mvAShS2Ohww@mail.gmail.com

Author: Jeff Janes

Backpatch-through: master
---

diff --git a/doc/src/sgml/pageinspect.sgml b/doc/src/sgml/pageinspect.sgml
index 0f278662af5..27e0598f74c 100644
--- a/doc/src/sgml/pageinspect.sgml
+++ b/doc/src/sgml/pageinspect.sgml
@@ -700,7 +700,7 @@ test=# SELECT * FROM gin_page_opaque_info(get_raw_page('gin_index', 2));
     <listitem>
      <para>
       <function>gin_leafpage_items</function> returns information about
-      the data stored in a <acronym>GIN</acronym> leaf page.  For example:
+      the data stored in a compressed <acronym>GIN</acronym> leaf page.  For example:
 <screen>
 test=# SELECT first_tid, nbytes, tids[0:5] AS some_tids
         FROM gin_leafpage_items(get_raw_page('gin_test_idx', 2));