From: Jeff Davis <jdavis@postgresql.org>
Date: Mon, 25 Mar 2024 18:51:44 +0000 (-0700)
Subject: Clarify comment for LogicalTapeSetBlocks().
X-Git-Tag: REL_17_BETA1~521
X-Git-Url: http://git.postgresql.org/gitweb/?a=commitdiff_plain;h=bc5fcaa289a92941a1c7b191c7c9311bd742e172;p=postgresql.git

Clarify comment for LogicalTapeSetBlocks().

Discussion: https://postgr.es/m/1229327.1711160246@sss.pgh.pa.us
Backpatch-through: 13
---

diff --git a/src/backend/utils/sort/logtape.c b/src/backend/utils/sort/logtape.c
index 9496ec3d3e8..44b30e86adf 100644
--- a/src/backend/utils/sort/logtape.c
+++ b/src/backend/utils/sort/logtape.c
@@ -1174,10 +1174,8 @@ LogicalTapeTell(LogicalTape *lt, int64 *blocknum, int *offset)
 }
 
 /*
- * Obtain total disk space currently used by a LogicalTapeSet, in blocks.
- *
- * This should not be called while there are open write buffers; otherwise it
- * may not account for buffered data.
+ * Obtain total disk space currently used by a LogicalTapeSet, in blocks. Does
+ * not account for open write buffer, if any.
  */
 int64
 LogicalTapeSetBlocks(LogicalTapeSet *lts)