pgsql: doc: Avoid too prominent use of "backup" on pg_dump man page

From: Peter Eisentraut <peter(at)eisentraut(dot)org>
To: pgsql-committers(at)lists(dot)postgresql(dot)org
Subject: pgsql: doc: Avoid too prominent use of "backup" on pg_dump man page
Date: 2024-07-31 06:04:33
Message-ID: E1sZ2Rt-001zcy-HK@gemulon.postgresql.org
Views: Raw Message | Whole Thread | Download mbox | Resend email
Thread:
Lists: pgsql-committers

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

Some 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."

This tones this down a little bit, by replacing most uses of "backup"
with "export" and adding a short note that pg_dump is not a
general-purpose backup tool.

Discussion: https://www.postgresql.org/message-id/flat/70b48475-7706-4268-990d-fd522b038d96%40eisentraut.org

Branch
------
master

Details
-------
https://git.postgresql.org/pg/commitdiff/4f29394ea941f688fd4faf7260d2c198931ca797

Modified Files
--------------
doc/src/sgml/ref/pg_dump.sgml | 12 ++++++++----
doc/src/sgml/ref/pg_restore.sgml | 2 +-
2 files changed, 9 insertions(+), 5 deletions(-)

Browse pgsql-committers by date

  From Date Subject
Next Message Peter Eisentraut 2024-07-31 09:18:15 pgsql: Add API and ABI stability guidance to the C language docs
Previous Message Peter Eisentraut 2024-07-31 04:32:02 pgsql: Make building with LTO work on macOS