From ea499f3d28c657a044f0a948e6b77ac56f28a8f6 Mon Sep 17 00:00:00 2001 From: Daniel Gustafsson Date: Mon, 16 Aug 2021 13:38:01 +0200 Subject: [PATCH] Clarify initdb --sync-only help message and docs The initdb help message for --sync-only was a bit terse, and not really self-explanatory. Make it clearer that initdb --sync-only will exit after syncing, and expand the docs with a note on when the option can be useful. Also align the help output with others that exit immediately. Author: Nathan Bossart, Gurjeet Singh Discussion: https://postgr.es/m/CABwTF4U6hbNNE1bv=LxQdJybmUdZ5NJQ9rKY9tN82NXM8QH+iQ@mail.gmail.com --- doc/src/sgml/ref/initdb.sgml | 3 +++ src/bin/initdb/initdb.c | 2 +- 2 files changed, 4 insertions(+), 1 deletion(-) diff --git a/doc/src/sgml/ref/initdb.sgml b/doc/src/sgml/ref/initdb.sgml index e62742850a..3d88838712 100644 --- a/doc/src/sgml/ref/initdb.sgml +++ b/doc/src/sgml/ref/initdb.sgml @@ -306,6 +306,9 @@ PostgreSQL documentation Safely write all database files to disk and exit. This does not perform any of the normal initdb operations. + Generally, this option is useful for ensuring reliable recovery after + changing from off to + on. diff --git a/src/bin/initdb/initdb.c b/src/bin/initdb/initdb.c index 5e84c7bb20..f05cddf0e0 100644 --- a/src/bin/initdb/initdb.c +++ b/src/bin/initdb/initdb.c @@ -2200,7 +2200,7 @@ usage(const char *progname) printf(_(" -N, --no-sync do not wait for changes to be written safely to disk\n")); printf(_(" --no-instructions do not print instructions for next steps\n")); printf(_(" -s, --show show internal settings\n")); - printf(_(" -S, --sync-only only sync data directory\n")); + printf(_(" -S, --sync-only only sync database files to disk, then exit\n")); printf(_("\nOther options:\n")); printf(_(" -V, --version output version information, then exit\n")); printf(_(" -?, --help show this help, then exit\n"));