public inbox for pgsql-docs@postgresql.org
help / color / mirror / Atom feedFrom: Maciek Sakrejda <m.sakrejda@gmail.com>
To: Shinya Kato <shinya11.kato@gmail.com>
Cc: pgsql-docs@lists.postgresql.org
Subject: Re: doc: Clarify ANALYZE VERBOSE output
Date: Sun, 5 Apr 2026 11:08:01 -0700
Message-ID: <CAOtHd0AY4LuM+-JqFyzs4mPHG8yeAwfP5yr2EZg21RVO0442BA@mail.gmail.com> (raw)
In-Reply-To: <CAOzEurTpMTUEW8kHu-zKB0EBtuPfpvyoJ--8pxKe87p24BGrpg@mail.gmail.com>
References: <CAOzEurTpMTUEW8kHu-zKB0EBtuPfpvyoJ--8pxKe87p24BGrpg@mail.gmail.com>
It makes sense to align these, but I think the existing VACUUM wording
is not great. What do you think about something like the attached?
Basically, I changed both option descriptions to just be
Prints detailed progress for each table at <literal>INFO</literal> level.
I think the idea of _progress_ is important to communicate here. The
word "report" suggests more detailed information, that comes in a
batch after the action is completed.
Thanks,
Maciek
PS: I changed the patch name because I felt the original name is
misleading with my proposed change, and I left it at v1 because
starting a different name with v2 didn't make sense, but I'm not
trying to take authorship credit: most of the work here was finding
the discrepancy.
Attachments:
[text/x-patch] v1-0001-doc-Clarify-VACUUM-VERBOSE-and-ANALYZE-VERBOSE-outpu.patch (1.7K, 2-v1-0001-doc-Clarify-VACUUM-VERBOSE-and-ANALYZE-VERBOSE-outpu.patch)
download | inline diff:
From 7753fb86bba9baee8e599b4e4a6b2e728ebd5279 Mon Sep 17 00:00:00 2001
From: Shinya Kato <shinya11.kato@gmail.com>
Date: Fri, 31 Oct 2025 16:06:42 +0900
Subject: [PATCH] doc: Clarify VACUUM VERBOSE and ANALYZE VERBOSE output
VACUUM VERBOSE and ANALYZE VERBOSE both emit detailed per-table INFO
level progress. The documentation currently calls these "reports", but
communicating progress is an important function of this feature and
the documentation should reflect that.
---
doc/src/sgml/ref/analyze.sgml | 2 +-
doc/src/sgml/ref/vacuum.sgml | 3 +--
2 files changed, 2 insertions(+), 3 deletions(-)
diff --git a/doc/src/sgml/ref/analyze.sgml b/doc/src/sgml/ref/analyze.sgml
index ec81f00fecf..d99b4f2eb6d 100644
--- a/doc/src/sgml/ref/analyze.sgml
+++ b/doc/src/sgml/ref/analyze.sgml
@@ -65,7 +65,7 @@ ANALYZE [ ( <replaceable class="parameter">option</replaceable> [, ...] ) ] [ <r
<term><literal>VERBOSE</literal></term>
<listitem>
<para>
- Enables display of progress messages at <literal>INFO</literal> level.
+ Prints detailed progress for each table at <literal>INFO</literal> level.
</para>
</listitem>
</varlistentry>
diff --git a/doc/src/sgml/ref/vacuum.sgml b/doc/src/sgml/ref/vacuum.sgml
index ac5d083d468..994da777d9a 100644
--- a/doc/src/sgml/ref/vacuum.sgml
+++ b/doc/src/sgml/ref/vacuum.sgml
@@ -115,8 +115,7 @@ VACUUM [ ( <replaceable class="parameter">option</replaceable> [, ...] ) ] [ <re
<term><literal>VERBOSE</literal></term>
<listitem>
<para>
- Prints a detailed vacuum activity report for each table
- at <literal>INFO</literal> level.
+ Prints detailed progress for each table at <literal>INFO</literal> level.
</para>
</listitem>
</varlistentry>
--
2.43.0
reply
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Reply to all the recipients using the --to and --cc options:
reply via email
To: pgsql-docs@postgresql.org
Cc: m.sakrejda@gmail.com, shinya11.kato@gmail.com, pgsql-docs@lists.postgresql.org
Subject: Re: doc: Clarify ANALYZE VERBOSE output
In-Reply-To: <CAOtHd0AY4LuM+-JqFyzs4mPHG8yeAwfP5yr2EZg21RVO0442BA@mail.gmail.com>
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
This inbox is served by agora; see mirroring instructions
for how to clone and mirror all data and code used for this inbox