pg.ddx.io  pgsql-committers@postgresql.org mailing list archive  
help / color / mirror / Atom feed
From: David Rowley <drowley@postgresql.org>
To: pgsql-committers@lists.postgresql.org
Subject: pgsql: Improve VACUUM/ANALYZE BUFFER_USAGE_LIMIT docs
Date: Sun, 16 Apr 2023 00:05:57 +0000
Message-ID: <E1pnpu0-003HB4-Dy@gemulon.postgresql.org> (raw)

Improve VACUUM/ANALYZE BUFFER_USAGE_LIMIT docs

This addresses various deficiencies in the documentation for VACUUM and
ANALYZE's BUFFER_USEAGE_LIMIT docs.

Here we declare "size" in the syntax synopsis for VACUUM and ANALYZE's
BUFFER_USAGE_LIMIT option and then define exactly what values can be
specified for it in the section for that below.

Also, fix the incorrect ordering of vacuumdb options both in the documents
and in vacuumdb's --help output.  These should be in alphabetical order.

In passing also add the minimum/maximum range for the BUFFER_USAGE_LIMIT
option.  These will also serve as example values that can be modified and
used.

Reported-by: Peter Eisentraut
Discussion: https://postgr.es/m/16845cb1-b228-e157-f293-5892bced9253@enterprisedb.com

Branch
------
master

Details
-------
https://git.postgresql.org/pg/commitdiff/c0235013c13b0adc9e7f1998ff5700e26ecdbd1f

Modified Files
--------------
doc/src/sgml/ref/analyze.sgml  | 18 ++++++++++++++++--
doc/src/sgml/ref/vacuum.sgml   | 18 ++++++++++++++++--
doc/src/sgml/ref/vacuumdb.sgml | 26 +++++++++++++-------------
src/bin/scripts/vacuumdb.c     |  2 +-
4 files changed, 46 insertions(+), 18 deletions(-)



Message-ID: <E1pnpu0-003HB4-Dy@gemulon.postgresql.org>
Permalink:  ../E1pnpu0-003HB4-Dy@gemulon.postgresql.org/
Also on:    postgresql.org/message-id/E1pnpu0-003HB4-Dy@gemulon.postgresql.org

 · 

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-committers@postgresql.org
  Cc: drowley@postgresql.org, pgsql-committers@lists.postgresql.org
  Subject: Re: pgsql: Improve VACUUM/ANALYZE BUFFER_USAGE_LIMIT docs
  In-Reply-To: <E1pnpu0-003HB4-Dy@gemulon.postgresql.org>

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

This inbox is served by DDX for PostgreSQL; see mirroring instructions
for how to clone and mirror all data and code used for this inbox