Re: Fix bug in VACUUM and ANALYZE docs

From: Shinya Kato <Shinya11(dot)Kato(at)oss(dot)nttdata(dot)com>
To: Ryoga Yoshida <bt23yoshidar(at)oss(dot)nttdata(dot)com>
Cc: pgsql-hackers(at)lists(dot)postgresql(dot)org
Subject: Re: Fix bug in VACUUM and ANALYZE docs
Date: 2023-09-20 00:43:15
Message-ID: 9cece9c906c15fc54ee1bcb27ada5b49@oss.nttdata.com
Views: Raw Message | Whole Thread | Download mbox | Resend email
Thread:
Lists: pgsql-hackers

On 2023-09-19 17:59, Ryoga Yoshida wrote:
> 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.

Thanks for the patch.
You're right. It looks good to me.

--
Regards,
Shinya Kato
NTT DATA GROUP CORPORATION

In response to

Responses

Browse pgsql-hackers by date

  From Date Subject
Next Message Peter Smith 2023-09-20 01:42:12 Re: Move global variables of pgoutput to plugin private scope.
Previous Message Michael Paquier 2023-09-20 00:38:56 Re: pg_upgrade and logical replication