lib/crc: crc32: Document crc32_le(), crc32_be(), and crc32c()
authorEric Biggers <ebiggers@kernel.org>
Thu, 19 Jun 2025 18:34:12 +0000 (11:34 -0700)
committerEric Biggers <ebiggers@kernel.org>
Mon, 30 Jun 2025 16:31:57 +0000 (09:31 -0700)
commit8c7c675155ce3f0f6b12c57a47298a390661652d
treea6fb4718097a1742232a7711645bac760d56d6ec
parent1a822ea52ad0d844805db32333a51d41ffcdf869
lib/crc: crc32: Document crc32_le(), crc32_be(), and crc32c()

Document these widely used functions.

Update kernel-api.rst to point to the correct place, instead of to
crc32-main.c which no longer contains kerneldoc comments.

Simplify the documentation in crc32poly.h to just point to the
corresponding functions, now that they are properly documented.  Change
the value of CRC32C_POLY_LE to lower case, for consistency.

Acked-by: Ard Biesheuvel <ardb@kernel.org>
Link: https://lore.kernel.org/r/20250619183414.100082-2-ebiggers@kernel.org
Signed-off-by: Eric Biggers <ebiggers@kernel.org>
Documentation/core-api/kernel-api.rst
include/linux/crc32.h
include/linux/crc32poly.h