public inbox for [email protected]help / color / mirror / Atom feed
add free space map link in pg_freespacemap page 7+ messages / 3 participants [nested] [flat]
* add free space map link in pg_freespacemap page @ 2022-03-06 14:42 Dong Wook Lee <[email protected]> 0 siblings, 1 reply; 7+ messages in thread From: Dong Wook Lee @ 2022-03-06 14:42 UTC (permalink / raw) To: [email protected] Hi, I found that there is a link to `pg_freespacemap` in the `free space map` page but there is no link to `free space map` in the `pg_freespacemap` page. diff --git a/doc/src/sgml/pgfreespacemap.sgml b/doc/src/sgml/pgfreespacemap.sgml index 5025498249..0ab3307e9c 100644 --- a/doc/src/sgml/pgfreespacemap.sgml +++ b/doc/src/sgml/pgfreespacemap.sgml @@ -9,7 +9,7 @@ <para> The <filename>pg_freespacemap</filename> module provides a means for examining the - free space map (FSM). It provides a function called + <link linkend="storage-fsm">free space map</link> (FSM). It provides a function called <function>pg_freespace</function>, or two overloaded functions, to be precise. The functions show the value recorded in the free space map for a given page, or for all pages in the relation. so I propose a patch to fix it. --- Regards, Lee Dong Wook. Attachments: [application/octet-stream] 0001_add_link_fsm.patch (653B, 3-0001_add_link_fsm.patch) download | inline diff: diff --git a/doc/src/sgml/pgfreespacemap.sgml b/doc/src/sgml/pgfreespacemap.sgml index 5025498249..0ab3307e9c 100644 --- a/doc/src/sgml/pgfreespacemap.sgml +++ b/doc/src/sgml/pgfreespacemap.sgml @@ -9,7 +9,7 @@ <para> The <filename>pg_freespacemap</filename> module provides a means for examining the - free space map (FSM). It provides a function called + <link linkend="storage-fsm">free space map</link> (FSM). It provides a function called <function>pg_freespace</function>, or two overloaded functions, to be precise. The functions show the value recorded in the free space map for a given page, or for all pages in the relation. ^ permalink raw reply [nested|flat] 7+ messages in thread
* Re: add free space map link in pg_freespacemap page @ 2022-03-07 10:08 Laurenz Albe <[email protected]> parent: Dong Wook Lee <[email protected]> 0 siblings, 1 reply; 7+ messages in thread From: Laurenz Albe @ 2022-03-07 10:08 UTC (permalink / raw) To: Dong Wook Lee <[email protected]>; [email protected] On Sun, 2022-03-06 at 23:42 +0900, Dong Wook Lee wrote: > Hi, > I found that there is a link to `pg_freespacemap` in the `free space map` page but there is no link to `free space map` in the `pg_freespacemap` page. > > diff --git a/doc/src/sgml/pgfreespacemap.sgml b/doc/src/sgml/pgfreespacemap.sgml > index 5025498249..0ab3307e9c 100644 > --- a/doc/src/sgml/pgfreespacemap.sgml > +++ b/doc/src/sgml/pgfreespacemap.sgml > @@ -9,7 +9,7 @@ > > <para> > The <filename>pg_freespacemap</filename> module provides a means for examining the > - free space map (FSM). It provides a function called > + <link linkend="storage-fsm">free space map</link> (FSM). It provides a function called > <function>pg_freespace</function>, or two overloaded functions, to be > precise. The functions show the value recorded in the free space map for > a given page, or for all pages in the relation. > > so I propose a patch to fix it. +1 Yours, Laurenz Albe ^ permalink raw reply [nested|flat] 7+ messages in thread
* Re: add free space map link in pg_freespacemap page @ 2022-03-07 12:03 Michael Paquier <[email protected]> parent: Laurenz Albe <[email protected]> 0 siblings, 1 reply; 7+ messages in thread From: Michael Paquier @ 2022-03-07 12:03 UTC (permalink / raw) To: Laurenz Albe <[email protected]>; +Cc: Dong Wook Lee <[email protected]>; [email protected] On Mon, Mar 07, 2022 at 11:08:16AM +0100, Laurenz Albe wrote: > On Sun, 2022-03-06 at 23:42 +0900, Dong Wook Lee wrote: >> <para> >> The <filename>pg_freespacemap</filename> module provides a means for examining the >> - free space map (FSM). It provides a function called >> + <link linkend="storage-fsm">free space map</link> (FSM). It provides a function called >> <function>pg_freespace</function>, or two overloaded functions, to be >> precise. The functions show the value recorded in the free space map for >> a given page, or for all pages in the relation. >> >> so I propose a patch to fix it. > > +1 Shouldn't you use an <acronym> here? FSM is a term listed in the section dedicated to acronyms. -- Michael Attachments: [application/pgp-signature] signature.asc (833B, 2-signature.asc) download ^ permalink raw reply [nested|flat] 7+ messages in thread
* Re: add free space map link in pg_freespacemap page @ 2022-03-08 00:31 Dong Wook Lee <[email protected]> parent: Michael Paquier <[email protected]> 0 siblings, 1 reply; 7+ messages in thread From: Dong Wook Lee @ 2022-03-08 00:31 UTC (permalink / raw) To: Michael Paquier <[email protected]>; +Cc: [email protected] I don't know about it, so should I use <acronym> at FSM for all the acronyms in the section dedicated to acronyms? <para> The <filename>pg_freespacemap</filename> module provides a means for examining the - free space map (FSM). It provides a function called + <link linkend="storage-fsm">free space map</link> (<acronym>FSM</acronym>). It provides a function called <function>pg_freespace</function>, or two overloaded functions, to be precise. The functions show the value recorded in the free space map for a given page, or for all pages in the relation. @@ -36,7 +36,7 @@ <listitem> <para> Returns the amount of free space on the page of the relation, specified - by <literal>blkno</literal>, according to the FSM. + by <literal>blkno</literal>, according to the <acronym>FSM</acronym>. </para> </listitem> </varlistentry> @@ -50,7 +50,7 @@ <listitem> <para> Displays the amount of free space on each page of the relation, - according to the FSM. A set of <literal>(blkno bigint, avail int2)</literal> + according to the <acronym>FSM</acronym>. A set of <literal>(blkno bigint, avail int2)</literal> tuples is returned, one tuple for each page in the relation. </para> </listitem> 2022년 3월 7일 (월) 오후 9:03, Michael Paquier <[email protected]>님이 작성: > On Mon, Mar 07, 2022 at 11:08:16AM +0100, Laurenz Albe wrote: > > On Sun, 2022-03-06 at 23:42 +0900, Dong Wook Lee wrote: > >> <para> > >> The <filename>pg_freespacemap</filename> module provides a means for > examining the > >> - free space map (FSM). It provides a function called > >> + <link linkend="storage-fsm">free space map</link> (FSM). It provides > a function called > >> <function>pg_freespace</function>, or two overloaded functions, to be > >> precise. The functions show the value recorded in the free space map > for > >> a given page, or for all pages in the relation. > >> > >> so I propose a patch to fix it. > > > > +1 > > Shouldn't you use an <acronym> here? FSM is a term listed in the > section dedicated to acronyms. > -- > Michael > ^ permalink raw reply [nested|flat] 7+ messages in thread
* Re: add free space map link in pg_freespacemap page @ 2022-03-08 06:17 Michael Paquier <[email protected]> parent: Dong Wook Lee <[email protected]> 0 siblings, 1 reply; 7+ messages in thread From: Michael Paquier @ 2022-03-08 06:17 UTC (permalink / raw) To: Dong Wook Lee <[email protected]>; +Cc: [email protected] On Tue, Mar 08, 2022 at 09:31:49AM +0900, Dong Wook Lee wrote: > I don't know about it, so should I use <acronym> at FSM for all the > acronyms in the section dedicated to acronyms? Yes, I would do that on consistency grounds. Your idea to add a link to the section describing what a FSM is from pgfreespacemap.sgml is also a good one. While looking around, I have also noticed some inconsistencies within the contents of pageinspect and all that leads me to the patch attached. Does that look fine to you? -- Michael Attachments: [text/x-diff] fsm-vm-docs.patch (4.7K, 2-fsm-vm-docs.patch) download | inline diff: diff --git a/doc/src/sgml/pageinspect.sgml b/doc/src/sgml/pageinspect.sgml index 24b5e463ed..55513cf522 100644 --- a/doc/src/sgml/pageinspect.sgml +++ b/doc/src/sgml/pageinspect.sgml @@ -31,9 +31,11 @@ relation and returns a copy as a <type>bytea</type> value. This allows a single time-consistent copy of the block to be obtained. <replaceable>fork</replaceable> should be <literal>'main'</literal> for - the main data fork, <literal>'fsm'</literal> for the free space map, - <literal>'vm'</literal> for the visibility map, or <literal>'init'</literal> - for the initialization fork. + the main data fork, <literal>'fsm'</literal> for the + <link linkend="storage-fsm">free space map</link>, + <literal>'vm'</literal> for the + <link linkend="storage-vm">visibility map</link>, or + <literal>'init'</literal> for the initialization fork. </para> </listitem> </varlistentry> @@ -136,7 +138,7 @@ test=# SELECT page_checksum(get_raw_page('pg_class', 0), 0); <listitem> <para> <function>fsm_page_contents</function> shows the internal node structure - of an FSM page. For example: + of an <acronym>FSM</acronym> page. For example: <screen> test=# SELECT fsm_page_contents(get_raw_page('pg_class', 'fsm', 0)); </screen> @@ -147,7 +149,7 @@ test=# SELECT fsm_page_contents(get_raw_page('pg_class', 'fsm', 0)); </para> <para> See <filename>src/backend/storage/freespace/README</filename> for more - information on the structure of an FSM page. + information on the structure of an <acronym>FSM</acronym> page. </para> </listitem> </varlistentry> diff --git a/doc/src/sgml/pgfreespacemap.sgml b/doc/src/sgml/pgfreespacemap.sgml index 5025498249..1f7867d9b9 100644 --- a/doc/src/sgml/pgfreespacemap.sgml +++ b/doc/src/sgml/pgfreespacemap.sgml @@ -9,10 +9,10 @@ <para> The <filename>pg_freespacemap</filename> module provides a means for examining the - free space map (FSM). It provides a function called - <function>pg_freespace</function>, or two overloaded functions, to be - precise. The functions show the value recorded in the free space map for - a given page, or for all pages in the relation. + <link linkend="storage-fsm">free space map</link> (<acronym>FSM</acronym>). + It provides a function called <function>pg_freespace</function>, or two + overloaded functions, to be precise. The functions show the value recorded in + the free space map for a given page, or for all pages in the relation. </para> <para> @@ -36,7 +36,7 @@ <listitem> <para> Returns the amount of free space on the page of the relation, specified - by <literal>blkno</literal>, according to the FSM. + by <literal>blkno</literal>, according to the <acronym>FSM</acronym>. </para> </listitem> </varlistentry> @@ -50,7 +50,8 @@ <listitem> <para> Displays the amount of free space on each page of the relation, - according to the FSM. A set of <literal>(blkno bigint, avail int2)</literal> + according to the <acronym>FSM</acronym>. A set of + <literal>(blkno bigint, avail int2)</literal> tuples is returned, one tuple for each page in the relation. </para> </listitem> @@ -112,8 +113,8 @@ postgres=# SELECT * FROM pg_freespace('foo', 7); <para> Original version by Mark Kirkwood <email>[email protected]</email>. - Rewritten in version 8.4 to suit new FSM implementation by Heikki - Linnakangas <email>[email protected]</email> + Rewritten in version 8.4 to suit new <acronym>FSM</acronym> implementation + by Heikki Linnakangas <email>[email protected]</email> </para> </sect2> diff --git a/doc/src/sgml/storage.sgml b/doc/src/sgml/storage.sgml index 7136bbe7a3..f4b9f66589 100644 --- a/doc/src/sgml/storage.sgml +++ b/doc/src/sgml/storage.sgml @@ -603,10 +603,11 @@ tuple would otherwise be too big. <para> Each heap and index relation, except for hash indexes, has a Free Space Map -(FSM) to keep track of available space in the relation. It's stored -alongside the main relation data in a separate relation fork, named after the -filenode number of the relation, plus a <literal>_fsm</literal> suffix. For example, -if the filenode of a relation is 12345, the FSM is stored in a file called +(<acronym>FSM</acronym>) to keep track of available space in the relation. +It's stored alongside the main relation data in a separate relation fork, +named after the filenode number of the relation, plus a <literal>_fsm</literal> +suffix. For example, if the filenode of a relation is 12345, the +<acronym>FSM</acronym> is stored in a file called <filename>12345_fsm</filename>, in the same directory as the main relation file. </para> [application/pgp-signature] signature.asc (833B, 3-signature.asc) download ^ permalink raw reply [nested|flat] 7+ messages in thread
* Re: add free space map link in pg_freespacemap page @ 2022-03-08 09:34 Dong Wook Lee <[email protected]> parent: Michael Paquier <[email protected]> 0 siblings, 1 reply; 7+ messages in thread From: Dong Wook Lee @ 2022-03-08 09:34 UTC (permalink / raw) To: Michael Paquier <[email protected]>; +Cc: [email protected] Patch looks good to me. 2022년 3월 8일 (화) 오후 3:17, Michael Paquier <[email protected]>님이 작성: > On Tue, Mar 08, 2022 at 09:31:49AM +0900, Dong Wook Lee wrote: > > I don't know about it, so should I use <acronym> at FSM for all the > > acronyms in the section dedicated to acronyms? > > Yes, I would do that on consistency grounds. Your idea to add a link > to the section describing what a FSM is from pgfreespacemap.sgml is > also a good one. > > While looking around, I have also noticed some inconsistencies within > the contents of pageinspect and all that leads me to the patch > attached. Does that look fine to you? > -- > Michael > ^ permalink raw reply [nested|flat] 7+ messages in thread
* Re: add free space map link in pg_freespacemap page @ 2022-03-09 01:45 Michael Paquier <[email protected]> parent: Dong Wook Lee <[email protected]> 0 siblings, 0 replies; 7+ messages in thread From: Michael Paquier @ 2022-03-09 01:45 UTC (permalink / raw) To: Dong Wook Lee <[email protected]>; +Cc: [email protected] On Tue, Mar 08, 2022 at 06:34:34PM +0900, Dong Wook Lee wrote: > Patch looks good to me. Okay, applied then. -- Michael Attachments: [application/pgp-signature] signature.asc (833B, 2-signature.asc) download ^ permalink raw reply [nested|flat] 7+ messages in thread
end of thread, other threads:[~2022-03-09 01:45 UTC | newest] Thread overview: 7+ messages (download: mbox.gz follow: Atom feed) -- links below jump to the message on this page -- 2022-03-06 14:42 add free space map link in pg_freespacemap page Dong Wook Lee <[email protected]> 2022-03-07 10:08 ` Laurenz Albe <[email protected]> 2022-03-07 12:03 ` Michael Paquier <[email protected]> 2022-03-08 00:31 ` Dong Wook Lee <[email protected]> 2022-03-08 06:17 ` Michael Paquier <[email protected]> 2022-03-08 09:34 ` Dong Wook Lee <[email protected]> 2022-03-09 01:45 ` Michael Paquier <[email protected]>
This inbox is served by agora; see mirroring instructions for how to clone and mirror all data and code used for this inbox