On 17/01/2024 09:15, John Naylor wrote:
/*
 * hashfn_unstable.h
 *
 * Building blocks for creating fast inlineable hash functions. The
 * unstable designation is in contrast to hashfn.h, which cannot break
 * compatibility because hashes can be written to disk and so must produce
 * the same hashes between versions.
 *
 * The functions in this file are not guaranteed to be stable between
 * versions, and may differ by hardware platform.

These paragraphs sound a bit awkward. It kind of buries the lede, the "these functions are not guaranteed to be stable" part, to the bottom.

Maybe something like:

"
Building blocks for creating fast inlineable hash functions. The functions in this file are not guaranteed to be stable between versions, and may differ by hardware platform. Hence they must not be used in indexes or other on-disk structures. See hashfn.h if you need stability.
"

typo: licencse

Other than that, LGTM.

--
Heikki Linnakangas
Neon (https://neon.tech)



Reply via email to