Re: add free space map link in pg_freespacemap page - Mailing list pgsql-docs

From Dong Wook Lee
Subject Re: add free space map link in pg_freespacemap page
Date
Msg-id CAAcByaKeBsP=k-zp_JHcS8mc2+-0TC72kb7XXWqqQoCh9VEdoA@mail.gmail.com
Whole thread Raw
In response to Re: add free space map link in pg_freespacemap page  (Michael Paquier <michael@paquier.xyz>)
Responses Re: add free space map link in pg_freespacemap page  (Michael Paquier <michael@paquier.xyz>)
List pgsql-docs
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

pgsql-docs by date:

Previous
From: Michael Paquier
Date:
Subject: Re: add free space map link in pg_freespacemap page
Next
From: Michael Paquier
Date:
Subject: Re: add free space map link in pg_freespacemap page