Avoid too prominent use of "backup" on pg_dump man page

From: Peter Eisentraut <peter(at)eisentraut(dot)org>
To: pgsql-docs <pgsql-docs(at)postgresql(dot)org>
Subject: Avoid too prominent use of "backup" on pg_dump man page
Date: 2024-05-29 23:11:34
Message-ID: 70b48475-7706-4268-990d-fd522b038d96@eisentraut.org
Views: Raw Message | Whole Thread | Download mbox | Resend email
Thread:
Lists: pgsql-docs

In Karen Jex's presentation today at pgconf.dev [0] one of the examples
given was that users inadvertently rely on pg_dump as their primary
backup tool, when better solutions exist. The pg_dump man page is
arguably misleading in that it starts with

"pg_dump is a utility for backing up a PostgreSQL database."

I suggest toning this down a little bit. In the attached patch, I have
replaced most uses of "backup" with "export" and added a short note that
pg_dump is not a general-purpose backup tool.

Suggestions for word-smithing welcome.

[0]:
https://www.pgevents.ca/events/pgconfdev2024/schedule/session/126-how-postgres-is-misused-and-abused-in-the-wild/

Attachment Content-Type Size
0001-doc-Avoid-too-prominent-use-of-backup-on-pg_dump-man.patch text/plain 2.8 KB

Responses

Browse pgsql-docs by date

  From Date Subject
Next Message Peter Smith 2024-05-30 00:50:49 Re: Ambiguous description on new columns
Previous Message Tom Lane 2024-05-29 16:32:54 Re: 17beta1 source download does not include docs & manpages