doc: Correct description of values used in FSM for indexes
authorMichael Paquier <[email protected]>
Thu, 27 Mar 2025 01:20:45 +0000 (10:20 +0900)
committerMichael Paquier <[email protected]>
Thu, 27 Mar 2025 01:20:45 +0000 (10:20 +0900)
The implementation of FSM for indexes is simpler than heap, where 0 is
used to track if a page is in-use and (BLCKSZ - 1) if a page is free.
One comment in indexfsm.c and one description in the documentation of
pg_freespacemap were incorrect about that.

Author: Alex Friedman <[email protected]>
Discussion: https://postgr.es/m/71eef655-c192-453f-ac45-2772fec2cb04@gmail.com
Backpatch-through: 13

doc/src/sgml/pgfreespacemap.sgml
src/backend/storage/freespace/indexfsm.c

index 829ad60f32fdc7b124439263566fa73406114159..3774a9f8c6b29eea7d6c1598b9ac6fce272d87de 100644 (file)
@@ -67,7 +67,7 @@
   <para>
    For indexes, what is tracked is entirely-unused pages, rather than free
    space within pages.  Therefore, the values are not meaningful, just
-   whether a page is full or empty.
+   whether a page is in-use or empty.
   </para>
  </sect2>
 
index 35fb41ea7d604a9e3856d142a4ad7d1219364357..ea0557801c1de3fa058dfe165482dd47fca080df 100644 (file)
@@ -16,7 +16,7 @@
  * This is similar to the FSM used for heap, in freespace.c, but instead
  * of tracking the amount of free space on pages, we only track whether
  * pages are completely free or in-use. We use the same FSM implementation
- * as for heaps, using BLCKSZ - 1 to denote used pages, and 0 for unused.
+ * as for heaps, using 0 to denote used pages, and (BLCKSZ - 1) for unused.
  *
  *-------------------------------------------------------------------------
  */