pgsql: Improve VACUUM/ANALYZE BUFFER_USAGE_LIMIT docs

From: David Rowley <drowley(at)postgresql(dot)org>
To: pgsql-committers(at)lists(dot)postgresql(dot)org
Subject: pgsql: Improve VACUUM/ANALYZE BUFFER_USAGE_LIMIT docs
Date: 2023-04-16 00:05:57
Message-ID: E1pnpu0-003HB4-Dy@gemulon.postgresql.org
Views: Raw Message | Whole Thread | Download mbox | Resend email
Thread:
Lists: pgsql-committers

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(-)

Browse pgsql-committers by date

  From Date Subject
Next Message David Rowley 2023-04-16 09:47:28 pgsql: Doc: add note about --buffer-usage-limit being v16 onwards
Previous Message Peter Eisentraut 2023-04-15 18:47:07 Re: pgsql: Add grantable MAINTAIN privilege and pg_maintain role.