Skip to content

Commit

Permalink
treewide: hash type -> hash algorithm
Browse files Browse the repository at this point in the history
"hash type" -> "hash algorithm" in all comments, documentation, and
messages.

ht -> ha, [Hh]ashType -> [HhashAlgo] for all local variables and
function arguments. No API change is made.

Continuation of 5334c9c and 837b889.
  • Loading branch information
ShamrockLee committed Feb 26, 2024
1 parent d83008c commit fd47f76
Show file tree
Hide file tree
Showing 8 changed files with 17 additions and 17 deletions.
6 changes: 3 additions & 3 deletions src/libstore/content-address.cc
Original file line number Diff line number Diff line change
Expand Up @@ -111,10 +111,10 @@ static std::pair<ContentAddressMethod, HashAlgorithm> parseContentAddressMethodP
}

auto parseHashAlgorithm_ = [&](){
auto hashTypeRaw = splitPrefixTo(rest, ':');
if (!hashTypeRaw)
auto hashAlgoRaw = splitPrefixTo(rest, ':');
if (!hashAlgoRaw)
throw UsageError("content address hash must be in form '<algo>:<hash>', but found: %s", wholeInput);
HashAlgorithm hashAlgo = parseHashAlgo(*hashTypeRaw);
HashAlgorithm hashAlgo = parseHashAlgo(*hashAlgoRaw);
return hashAlgo;
};

Expand Down
8 changes: 4 additions & 4 deletions src/libstore/content-address.hh
Original file line number Diff line number Diff line change
Expand Up @@ -91,17 +91,17 @@ struct ContentAddressMethod
std::string_view renderPrefix() const;

/**
* Parse a content addressing method and hash type.
* Parse a content addressing method and hash algorithm.
*/
static std::pair<ContentAddressMethod, HashAlgorithm> parseWithAlgo(std::string_view rawCaMethod);

/**
* Render a content addressing method and hash type in a
* Render a content addressing method and hash algorithm in a
* nicer way, prefixing both cases.
*
* The rough inverse of `parse()`.
*/
std::string renderWithAlgo(HashAlgorithm ht) const;
std::string renderWithAlgo(HashAlgorithm ha) const;

/**
* Get the underlying way to content-address file system objects.
Expand All @@ -127,7 +127,7 @@ struct ContentAddressMethod
* ‘text:sha256:<sha256 hash of file contents>’
*
* - `FixedIngestionMethod`:
* ‘fixed:<r?>:<hash type>:<hash of file contents>’
* ‘fixed:<r?>:<hash algorithm>:<hash of file contents>’
*/
struct ContentAddress
{
Expand Down
2 changes: 1 addition & 1 deletion src/libstore/derivations.cc
Original file line number Diff line number Diff line change
Expand Up @@ -701,7 +701,7 @@ DerivationType BasicDerivation::type() const
floatingHashAlgo = dof.hashAlgo;
} else {
if (*floatingHashAlgo != dof.hashAlgo)
throw Error("all floating outputs must use the same hash type");
throw Error("all floating outputs must use the same hash algorithm");
}
},
[&](const DerivationOutput::Deferred &) {
Expand Down
4 changes: 2 additions & 2 deletions src/libstore/globals.hh
Original file line number Diff line number Diff line change
Expand Up @@ -1094,8 +1094,8 @@ public:
this, {}, "hashed-mirrors",
R"(
A list of web servers used by `builtins.fetchurl` to obtain files by
hash. Given a hash type *ht* and a base-16 hash *h*, Nix will try to
download the file from *hashed-mirror*/*ht*/*h*. This allows files to
hash. Given a hash algorithm *ha* and a base-16 hash *h*, Nix will try to
download the file from *hashed-mirror*/*ha*/*h*. This allows files to
be downloaded even if they have disappeared from their original URI.
For example, given an example mirror `http:https://tarballs.nixos.org/`,
when building the derivation
Expand Down
4 changes: 2 additions & 2 deletions src/libutil/file-content-address.cc
Original file line number Diff line number Diff line change
Expand Up @@ -63,10 +63,10 @@ void restorePath(

HashResult hashPath(
SourceAccessor & accessor, const CanonPath & path,
FileIngestionMethod method, HashAlgorithm ht,
FileIngestionMethod method, HashAlgorithm ha,
PathFilter & filter)
{
HashSink sink { ht };
HashSink sink { ha };
dumpPath(accessor, path, sink, method, filter);
return sink.finish();
}
Expand Down
4 changes: 2 additions & 2 deletions src/libutil/file-content-address.hh
Original file line number Diff line number Diff line change
Expand Up @@ -63,11 +63,11 @@ void restorePath(
* Compute the hash of the given file system object according to the
* given method.
*
* The hash is defined as (essentially) hashString(ht, dumpPath(path)).
* The hash is defined as (essentially) hashString(ha, dumpPath(path)).
*/
HashResult hashPath(
SourceAccessor & accessor, const CanonPath & path,
FileIngestionMethod method, HashAlgorithm ht,
FileIngestionMethod method, HashAlgorithm ha,
PathFilter & filter = defaultPathFilter);

}
2 changes: 1 addition & 1 deletion src/libutil/hash.cc
Original file line number Diff line number Diff line change
Expand Up @@ -274,7 +274,7 @@ Hash newHashAllowEmpty(std::string_view hashStr, std::optional<HashAlgorithm> ha
{
if (hashStr.empty()) {
if (!ha)
throw BadHash("empty hash requires explicit hash type");
throw BadHash("empty hash requires explicit hash algorithm");
Hash h(*ha);
warn("found empty hash, assuming '%s'", h.to_string(HashFormat::SRI, true));
return h;
Expand Down
4 changes: 2 additions & 2 deletions src/libutil/hash.hh
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@ struct Hash
* Parse the hash from a string representation in the format
* "[<type>:]<base16|base32|base64>" or "<type>-<base64>" (a
* Subresource Integrity hash expression). If the 'type' argument
* is not present, then the hash type must be specified in the
* is not present, then the hash algorithm must be specified in the
* string.
*/
static Hash parseAny(std::string_view s, std::optional<HashAlgorithm> optAlgo);
Expand Down Expand Up @@ -200,7 +200,7 @@ std::optional<HashFormat> parseHashFormatOpt(std::string_view hashFormatName);
std::string_view printHashFormat(HashFormat hashFormat);

/**
* Parse a string representing a hash type.
* Parse a string representing a hash algorithm.
*/
HashAlgorithm parseHashAlgo(std::string_view s);

Expand Down

0 comments on commit fd47f76

Please sign in to comment.