Improve VACUUM/ANALYZE BUFFER_USAGE_LIMIT docs
authorDavid Rowley <drowley@postgresql.org>
Sun, 16 Apr 2023 00:05:34 +0000 (12:05 +1200)
committerDavid Rowley <drowley@postgresql.org>
Sun, 16 Apr 2023 00:05:34 +0000 (12:05 +1200)
commitc0235013c13b0adc9e7f1998ff5700e26ecdbd1f
tree998ba080dcd9c6c6e000038f4094fcea39f2641f
parent064eb89e83ea0f59426c92906329f1e6c423dfa4
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
doc/src/sgml/ref/analyze.sgml
doc/src/sgml/ref/vacuum.sgml
doc/src/sgml/ref/vacuumdb.sgml
src/bin/scripts/vacuumdb.c