From 95190e68ed8f6c152f8ba01b2da7baeacb342c0e Mon Sep 17 00:00:00 2001 From: John Ericson Date: Mon, 12 Feb 2024 11:21:54 -0500 Subject: [PATCH] =?UTF-8?q?Mention=20the=20use=20of=20Extended=20Backus?= =?UTF-8?q?=E2=80=93Naur=20form?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- doc/manual/src/protocols/store-path.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/doc/manual/src/protocols/store-path.md b/doc/manual/src/protocols/store-path.md index d5dec77b5..57da808f9 100644 --- a/doc/manual/src/protocols/store-path.md +++ b/doc/manual/src/protocols/store-path.md @@ -2,6 +2,8 @@ This is the complete specification for how store paths are calculated. +The format of this specification is close to [Extended Backus–Naur form](https://en.wikipedia.org/wiki/Extended_Backus%E2%80%93Naur_form), but must deviate for a few things such as hash functions which we treat as bidirectional for specification purposes. + Regular users do *not* need to know this information --- store paths can be treated as black boxes computed from the properties of the store objects they refer to. But for those interested in exactly how Nix works, e.g. if they are reimplementing it, this information can be useful.