pg.ddx.io  pgsql-committers@postgresql.org mailing list archive  
help / color / mirror / Atom feed
From: Peter Eisentraut <peter@eisentraut.org>
To: pgsql-committers@lists.postgresql.org
Subject: pgsql: doc: Avoid too prominent use of "backup" on pg_dump man page
Date: Wed, 31 Jul 2024 06:04:33 +0000
Message-ID: <E1sZ2Rt-001zcy-HK@gemulon.postgresql.org> (raw)

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(-)



Message-ID: <E1sZ2Rt-001zcy-HK@gemulon.postgresql.org>
Permalink:  ../E1sZ2Rt-001zcy-HK@gemulon.postgresql.org/
Also on:    postgresql.org/message-id/E1sZ2Rt-001zcy-HK@gemulon.postgresql.org

 · 

reply

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Reply to all the recipients using the --to and --cc options:
  reply via email

  To: pgsql-committers@postgresql.org
  Cc: peter@eisentraut.org, pgsql-committers@lists.postgresql.org
  Subject: Re: pgsql: doc: Avoid too prominent use of "backup" on pg_dump man page
  In-Reply-To: <E1sZ2Rt-001zcy-HK@gemulon.postgresql.org>

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

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