Fix bug in VACUUM and ANALYZE docs

From: Ryoga Yoshida <bt23yoshidar(at)oss(dot)nttdata(dot)com>
To: pgsql-hackers(at)lists(dot)postgresql(dot)org
Subject: Fix bug in VACUUM and ANALYZE docs
Date: 2023-09-19 08:59:11
Message-ID: 9374034cb91b647b55a774a8980b0228@oss.nttdata.com
Views: Raw Message | Whole Thread | Download mbox | Resend email
Thread:
Lists: pgsql-hackers

Hi,

Issue1:
VACUUM and ANALYZE docs explain that the parameter of BUFFER_USAGE_LIMIT
is optional as follows. But this is not true. The argument, size, is
required for BUFFER_USAGE_LIMIT. So the docs should be fixed this issue.
BUFFER_USAGE_LIMIT [ size ]
https://www.postgresql.org/docs/devel/sql-vacuum.html
https://www.postgresql.org/docs/devel/sql-analyze.html

Issue2:
Sizes may also be specified as a string containing the numerical size
followed by any one of the following memory units: kB (kilobytes), MB
(megabytes), GB (gigabytes), or TB (terabytes).
VACUUM and ANALYZE docs explain that the argument of BUFFER_USAGE_LIMIT
accepts the units like kB (kilobytes), MB (megabytes), GB (gigabytes),
or TB (terabytes). But it also actually accepts B(bytes) as an unit. So
the docs should include "B(bytes)" as an unit that the argument of
BUFFER_USAGE_LIMIT can accept.

You can see the patch in the attached file.

Ryoga Yoshida

Attachment Content-Type Size
v1-0001-Fix-bug-in-VACUUM-and-ANALYZE-docs.patch text/x-diff 2.5 KB

Responses

Browse pgsql-hackers by date

  From Date Subject
Next Message Heikki Linnakangas 2023-09-19 09:06:57 Re: Sync scan & regression tests
Previous Message Heikki Linnakangas 2023-09-19 08:57:58 Re: Fix GIST readme on LSN vs NSN