Date: Thu, 17 Oct 2024 16:59:54 -0500
From: Nathan Bossart <nathandbossart@gmail.com>
To: Seino Yuki <seinoyu@oss.nttdata.com>
Cc: Fujii Masao <masao.fujii@oss.nttdata.com>,
	Michael Paquier <michael@paquier.xyz>, pgsql-hackers@postgresql.org
Subject: Re: Doc: shared_memory_size_in_huge_pages with the "SHOW" command.
Message-ID: <ZxGI2pYl9cI9wAKB@nathan>
References: <420584fd274f9ec4f337da55ffb3b790@oss.nttdata.com>
 <Zw8JdU_LzvuFZ-AG@paquier.xyz>
 <Zw8WLvyjsbz64NOD@nathan>
 <Zw9MmGecS9QHF4qh@paquier.xyz>
 <755f74a1-d50a-4411-aed2-d8cf09764865@oss.nttdata.com>
 <Zw_RS35LpJfRJlub@nathan>
 <5bdb7847bf2bdefc84b11cc89cbd5aba@oss.nttdata.com>
MIME-Version: 1.0
Content-Type: multipart/mixed; boundary="lUHZUC13nOf461/L"
Content-Disposition: inline
In-Reply-To: <5bdb7847bf2bdefc84b11cc89cbd5aba@oss.nttdata.com>
Archived-At: <https://www.postgresql.org/message-id/ZxGI2pYl9cI9wAKB%40nathan>
Precedence: bulk


--lUHZUC13nOf461/L
Content-Type: text/plain; charset=us-ascii
Content-Disposition: inline

On Thu, Oct 17, 2024 at 02:07:32PM +0900, Seino Yuki wrote:
> I've fixed the patch and will register it in the CF.

Thanks.  Here is what I have staged for commit.

-- 
nathan

--lUHZUC13nOf461/L
Content-Type: text/plain; charset=us-ascii
Content-Disposition: attachment;
	filename="v3-0001-Adjust-documentation-for-configuring-Linux-huge-p.patch"

From 8aff8ec54a6588614f952693f509b75bf240851c Mon Sep 17 00:00:00 2001
From: Nathan Bossart <nathan@postgresql.org>
Date: Thu, 17 Oct 2024 16:56:52 -0500
Subject: [PATCH v3 1/1] Adjust documentation for configuring Linux huge pages.

The present wording about viewing shared_memory_size_in_huge_pages
seems to suggest that the parameter cannot be viewed after startup
at all, whereas the intent is to make it clear that you can't use
"postgres -C" to view this GUC while the server is running.  This
commit rephrases this section to remove the ambiguity.

Author: Seino Yuki
Reviewed-by: Michael Paquier, David G. Johnston, Fujii Masao
Discussion: https://postgr.es/m/420584fd274f9ec4f337da55ffb3b790%40oss.nttdata.com
Backpatch-through: 15
---
 doc/src/sgml/runtime.sgml | 9 ++++-----
 1 file changed, 4 insertions(+), 5 deletions(-)

diff --git a/doc/src/sgml/runtime.sgml b/doc/src/sgml/runtime.sgml
index 2c4d5ef640..a47fa67b38 100644
--- a/doc/src/sgml/runtime.sgml
+++ b/doc/src/sgml/runtime.sgml
@@ -1429,11 +1429,10 @@ export PG_OOM_ADJUST_VALUE=0
     with <varname>CONFIG_HUGETLBFS=y</varname> and
     <varname>CONFIG_HUGETLB_PAGE=y</varname>. You will also have to configure
     the operating system to provide enough huge pages of the desired size.
-    To determine the number of huge pages needed, use the
-    <command>postgres</command> command to see the value of
-    <xref linkend="guc-shared-memory-size-in-huge-pages"/>.  Note that the
-    server must be shut down to view this runtime-computed parameter.
-    This might look like:
+    The runtime-computed parameter
+    <xref linkend="guc-shared-memory-size-in-huge-pages"/> reports the number
+    of huge pages required.  This parameter can be viewed before starting the
+    server with a <command>postgres</command> command like:
 <programlisting>
 $ <userinput>postgres -D $PGDATA -C shared_memory_size_in_huge_pages</userinput>
 3170
-- 
2.39.5 (Apple Git-154)


--lUHZUC13nOf461/L--