From: Pádraig Brady <P@draigBrady.com>
Date: Sun, 30 Apr 2023 21:10:25 +0000 (+0100)
Subject: doc: provide more info on the default 32-bit cksum digest
X-Git-Tag: v9.4~142
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=6d683a1d020894d549986bd7b9e78b77b35650a2;p=thirdparty%2Fcoreutils.git

doc: provide more info on the default 32-bit cksum digest

* doc/coreutils.texi (cksum invocation): Say that the default
digest format is 32-bit and based on the Ethernet standard CRC.
---

diff --git a/doc/coreutils.texi b/doc/coreutils.texi
index 2188922c6d..260592db22 100644
--- a/doc/coreutils.texi
+++ b/doc/coreutils.texi
@@ -3984,11 +3984,13 @@ next section) is preferable in new applications.
 @pindex cksum
 @cindex cyclic redundancy check
 @cindex CRC checksum
+@cindex 32-bit checksum
+@cindex checksum, 32-bit
 @cindex digest
 
-@command{cksum} by default computes a cyclic redundancy check (CRC) checksum
-for each given @var{file}, or standard input if none are given or for a
-@var{file} of @samp{-}.
+@command{cksum} by default computes a 32-bit cyclic redundancy check (CRC)
+checksum for each given @var{file}, or standard input if none are given or for
+a @var{file} of @samp{-}.
 
 cksum also supports the @option{-a/--algorithm} option to select the
 digest algorithm to use. @command{cksum} is the preferred interface
@@ -4008,6 +4010,8 @@ distribution).
 @command{cksum} by default prints the POSIX standard CRC checksum
 for each file along with the number of bytes in the file,
 and the file name unless no arguments were given.
+The 32-bit CRC used is based on the polynomial used
+for CRC error checking in the ISO/IEC 8802-3:1996 standard (Ethernet).
 
 The same usage and options as the @command{b2sum}
 command are supported.  @xref{b2sum invocation}.