Horton

Thread

Commits

  1. doc: Improve references to term "FSM" in pageinspect and pgfreespacemap

  1. add free space map link in pg_freespacemap page

    Dong Wook Lee <sh95119@gmail.com> — 2022-03-06T14:42:53Z

    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.

  2. Re: add free space map link in pg_freespacemap page

    Laurenz Albe <laurenz.albe@cybertec.at> — 2022-03-07T10:08:16Z

    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

  3. Re: add free space map link in pg_freespacemap page

    Michael Paquier <michael@paquier.xyz> — 2022-03-07T12:03:23Z

    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

  4. Re: add free space map link in pg_freespacemap page

    Dong Wook Lee <sh95119@gmail.com> — 2022-03-08T00:31:49Z

    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 <michael@paquier.xyz>님이 작성:

> 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
>

  5. Re: add free space map link in pg_freespacemap page

    Michael Paquier <michael@paquier.xyz> — 2022-03-08T06:17:00Z

    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

  6. Re: add free space map link in pg_freespacemap page

    Dong Wook Lee <sh95119@gmail.com> — 2022-03-08T09:34:34Z

    Patch looks good to me.
2022년 3월 8일 (화) 오후 3:17, Michael Paquier <michael@paquier.xyz>님이 작성:

> 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
>

  7. Re: add free space map link in pg_freespacemap page

    Michael Paquier <michael@paquier.xyz> — 2022-03-09T01:45:18Z

    On Tue, Mar 08, 2022 at 06:34:34PM +0900, Dong Wook Lee wrote:
> Patch looks good to me.

Okay, applied then.
--
Michael