Re: Doc: Move standalone backup section, mention -X argument

From: Benoit Lobréau <benoit(dot)lobreau(at)dalibo(dot)com>
To: david(dot)g(dot)johnston(at)gmail(dot)com, marlene(dot)reiterer(dot)03(at)gmail(dot)com
Cc: pgsql-hackers(at)lists(dot)postgresql(dot)org
Subject: Re: Doc: Move standalone backup section, mention -X argument
Date: 2025-01-22 08:54:19
Message-ID: 54d16298-da71-48f1-96e0-8f011cf5c6ce@dalibo.com
Views: Raw Message | Whole Thread | Download mbox | Resend email
Thread:
Lists: pgsql-hackers

Hi,

Initially, I shared your perspective, but I wasn’t entirely on board
with the subdivision you proposed. The more I thought about it and tried
to reshape it, the less convinced I became.

I don’t think pg_basebackup fits naturally under the "File System Level
Backup" section. I considered creating a "Standalone Physical Backup"
section with two subsections: FS-level backups and pg_basebackup, but
that didn’t feel right either.

What I find most problematic about the current state of the
documentation is that this solution is buried in the "Tips and Examples"
section. As a result, it’s easy to miss when skimming through the docs
since the list of sub sections displayed at the top of the page and in
"Chapter 25. Backup and Restore" stops 3 level deep.

What if we just move the "Standalone Hot Backups" up one level and
rename the level 2 section ? Something like this ?

25.3. Continuous Archiving, backups and Point-in-Time Recovery (PITR)
25.3.1. Setting Up WAL Archiving
25.3.2. Making a Base Backup
25.3.3. Making an Incremental Backup
25.3.4. Making a Base Backup Using the Low Level API
25.3.5. Making a Standalone Hot Backup
25.3.6. Recovering Using a Continuous Archive Backup
25.3.7. Timelines
25.3.8. Tips and Examples
25.3.9. Caveats

--
Benoit Lobréau
Consultant
http://dalibo.com

Browse pgsql-hackers by date

  From Date Subject
Next Message Oleg Tselebrovskiy 2025-01-22 09:03:39 Inconsistent string comparison using modified ICU collations
Previous Message Japin Li 2025-01-22 08:49:11 Re: [RFC] Lock-free XLog Reservation from WAL