Horton

Re: fix CRC algorithm in WAL reliability docs

Robert Haas <robertmhaas@gmail.com>

View thread View on postgr.es
From: Robert Haas <robertmhaas@gmail.com>
To: Nathan Bossart <nathandbossart@gmail.com>
Cc: pgsql-hackers@postgresql.org
Date: 2024-08-08T19:13:50Z
Lists: pgsql-hackers 
On Thu, Aug 8, 2024 at 1:51 PM Nathan Bossart <nathandbossart@gmail.com> wrote:
> I noticed that the "WAL reliability" documentation says that we use CRC-32
> for WAL records and two-phase state files, but we've actually used CRC-32C
> since v9.5 (commit 5028f22).  I've attached a short patch to fix this that
> I think should be back-patched to all supported versions.
>
> I've attached a second patch that standardizes how we refer to these kinds
> of algorithms in our docs.  Specifically, it adds dashes (e.g., "CRC-32C"
> instead of "CRC32C").  Wikipedia uses this style pretty consistently [0]
> [1] [2], and so I think we should, too.  I don't think this one needs to be
> back-patched.
>
> Thoughts?

LGTM.

-- 
Robert Haas
EDB: http://www.enterprisedb.com

Commits

  1. doc: Standardize use of dashes in references to CRC and SHA.

  2. doc: Fix name of CRC algorithm in "Reliability" section.

  3. Switch to CRC-32C in WAL and other places.