pg.ddx.io pgsql-docs@postgresql.org mailing list archive
help / color / mirror / Atom feedpg_isready --dbname option is broken. So it should not be in the manual
4+ messages / 3 participants
[nested] [flat]
* pg_isready --dbname option is broken. So it should not be in the manual
@ 2023-10-26 11:46 PG Doc comments form <noreply@postgresql.org>
0 siblings, 1 reply; 4+ messages in thread
From: PG Doc comments form @ 2023-10-26 11:46 UTC (permalink / raw)
To: pgsql-docs@lists.postgresql.org; +Cc: vrms@netcologne.de
The following documentation comment has been logged on the website:
Page: https://www.postgresql.org/docs/16/app-pg-isready.html
Description:
the --dbname option in pg_isready seems not to work propperly. the tool
returns 'ok' as long as the cluster itselft is running, no matter how wrong
the bdname might be.
as this seems to be a ~10 year old misbehaviour as per the below thread I
think it should be removed from the manual.
https://www.postgresql.org/message-id/flat/52840D38.9070604%40agliodbs.com
^ permalink raw reply [nested|flat] 4+ messages in thread
* Re: pg_isready --dbname option is broken. So it should not be in the manual
@ 2023-10-26 12:20 David G. Johnston <david.g.johnston@gmail.com>
parent: PG Doc comments form <noreply@postgresql.org>
0 siblings, 1 reply; 4+ messages in thread
From: David G. Johnston @ 2023-10-26 12:20 UTC (permalink / raw)
To: vrms@netcologne.de <vrms@netcologne.de>; pgsql-docs@lists.postgresql.org <pgsql-docs@lists.postgresql.org>
On Thursday, October 26, 2023, PG Doc comments form <noreply@postgresql.org>
wrote:
> The following documentation comment has been logged on the website:
>
> Page: https://www.postgresql.org/docs/16/app-pg-isready.html
> Description:
>
> the --dbname option in pg_isready seems not to work propperly. the tool
> returns 'ok' as long as the cluster itselft is running, no matter how wrong
> the bdname might be.
>
> as this seems to be a ~10 year old misbehaviour as per the below thread I
> think it should be removed from the manual.
>
> https://www.postgresql.org/message-id/flat/52840D38.9070604%40agliodbs.com
>
Read the notes section.
David J.
^ permalink raw reply [nested|flat] 4+ messages in thread
* Re: pg_isready --dbname option is broken. So it should not be in the manual
@ 2023-10-26 12:34 Daniel Gustafsson <daniel@yesql.se>
parent: David G. Johnston <david.g.johnston@gmail.com>
0 siblings, 1 reply; 4+ messages in thread
From: Daniel Gustafsson @ 2023-10-26 12:34 UTC (permalink / raw)
To: David G. Johnston <david.g.johnston@gmail.com>; +Cc: vrms@netcologne.de <vrms@netcologne.de>; pgsql-docs@lists.postgresql.org <pgsql-docs@lists.postgresql.org>
> On 26 Oct 2023, at 14:20, David G. Johnston <david.g.johnston@gmail.com> wrote:
>
> On Thursday, October 26, 2023, PG Doc comments form <noreply@postgresql.org <mailto:noreply@postgresql.org>> wrote:
> The following documentation comment has been logged on the website:
>
> Page: https://www.postgresql.org/docs/16/app-pg-isready.html <https://www.postgresql.org/docs/16/app-pg-isready.html;
> Description:
>
> the --dbname option in pg_isready seems not to work propperly. the tool
> returns 'ok' as long as the cluster itselft is running, no matter how wrong
> the bdname might be.
>
> as this seems to be a ~10 year old misbehaviour as per the below thread I
> think it should be removed from the manual.
>
> https://www.postgresql.org/message-id/flat/52840D38.9070604%40agliodbs.com <https://www.postgresql.org/message-id/flat/52840D38.9070604%40agliodbs.com;
>
> Read the notes section.
The notes section is pretty hidden though, I can sympathize with anyone missing
it and maybe making the info a bit more visible would be good?
--
Daniel Gustafsson
^ permalink raw reply [nested|flat] 4+ messages in thread
* Re: pg_isready --dbname option is broken. So it should not be in the manual
@ 2023-10-26 12:59 David G. Johnston <david.g.johnston@gmail.com>
parent: Daniel Gustafsson <daniel@yesql.se>
0 siblings, 0 replies; 4+ messages in thread
From: David G. Johnston @ 2023-10-26 12:59 UTC (permalink / raw)
To: Daniel Gustafsson <daniel@yesql.se>; +Cc: vrms@netcologne.de <vrms@netcologne.de>; pgsql-docs@lists.postgresql.org <pgsql-docs@lists.postgresql.org>
On Thursday, October 26, 2023, Daniel Gustafsson <daniel@yesql.se> wrote:
> > On 26 Oct 2023, at 14:20, David G. Johnston <david.g.johnston@gmail.com>
> wrote:
> >
> > On Thursday, October 26, 2023, PG Doc comments form <
> noreply@postgresql.org <mailto:noreply@postgresql.org>> wrote:
> > The following documentation comment has been logged on the website:
> >
> > Page: https://www.postgresql.org/docs/16/app-pg-isready.html <
> https://www.postgresql.org/docs/16/app-pg-isready.html;
> > Description:
> >
> > the --dbname option in pg_isready seems not to work propperly. the tool
> > returns 'ok' as long as the cluster itselft is running, no matter how
> wrong
> > the bdname might be.
> >
> > as this seems to be a ~10 year old misbehaviour as per the below thread I
> > think it should be removed from the manual.
> >
> > https://www.postgresql.org/message-id/flat/52840D38.
> 9070604%40agliodbs.com <https://www.postgresql.org/
> message-id/flat/52840D38.9070604%40agliodbs.com>
> >
> > Read the notes section.
>
> The notes section is pretty hidden though, I can sympathize with anyone
> missing
> it and maybe making the info a bit more visible would be good?
>
Add a “see notes” link to those two parameters.
But we put lots of stuff like this into the notes everywhere; DBAs are
expected to look for and read them on the man pages they consume. This
doesn’t seem to fit into the description nor warrants a callout.
David J.
^ permalink raw reply [nested|flat] 4+ messages in thread
end of thread, other threads:[~2023-10-26 12:59 UTC | newest]
Thread overview: 4+ messages (download: mbox mbox.gz follow: Atom feed)
-- links below jump to the message on this page --
2023-10-26 11:46 pg_isready --dbname option is broken. So it should not be in the manual PG Doc comments form <noreply@postgresql.org>
2023-10-26 12:20 ` David G. Johnston <david.g.johnston@gmail.com>
2023-10-26 12:34 ` Daniel Gustafsson <daniel@yesql.se>
2023-10-26 12:59 ` David G. Johnston <david.g.johnston@gmail.com>
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