From ce19338f9fa4e8fa1fea7faf33c0f2c384e590dd Mon Sep 17 00:00:00 2001 From: Valentin Gagarin Date: Tue, 13 Feb 2024 13:30:17 +0100 Subject: [PATCH 1/3] update glossary entry on store types the interesting information is on the proper pages, and is now presented a bit more prominently. the paragraph was a bit confusing to read, also because an anchor link to an inline definition was in the middle of the sentence. "local store" now has its own glossary entry. --- doc/manual/src/glossary.md | 23 +++++++++++++---------- 1 file changed, 13 insertions(+), 10 deletions(-) diff --git a/doc/manual/src/glossary.md b/doc/manual/src/glossary.md index 13b2906f7..51f1e3a71 100644 --- a/doc/manual/src/glossary.md +++ b/doc/manual/src/glossary.md @@ -59,18 +59,21 @@ - [store]{#gloss-store} - A collection of store objects, with operations to manipulate that collection. - See [Nix store](./store/index.md) for details. + A collection of [store objects][store object], with operations to manipulate that collection. + See [Nix Store](./store/index.md) for details. - There are many types of stores. - See [`nix help-stores`](@docroot@/command-ref/new-cli/nix3-help-stores.md) for a complete list. - - From the perspective of the location where Nix is invoked, the Nix store can be referred to _local_ or _remote_. - Only a [local store]{#gloss-local-store} exposes a location in the file system of the machine where Nix is invoked that allows access to store objects, typically `/nix/store`. - Local stores can be used for building [derivations](#gloss-derivation). - See [Local Store](@docroot@/command-ref/new-cli/nix3-help-stores.md#local-store) for details. + There are many types of stores, see [Store Types](./store/types/index.md) for details. [store]: #gloss-store + +- [local store]{#gloss-local-store} + + From the perspective of the location where Nix is invoked, the Nix [store] can be referred to _local_ or _remote_. + Only a local store exposes a file system directory, typically `/nix/store`, to allow operating system processes to directly access store objects. + Local stores can be used for building [derivations][derivation]. + + See [Local Store](@docroot@/command-ref/new-cli/nix3-help-stores.md#local-store) for details. + [local store]: #gloss-local-store - [chroot store]{#gloss-chroot-store} @@ -87,7 +90,7 @@ - [store path]{#gloss-store-path} - The location of a [store object](@docroot@/store/index.md#store-object) in the file system, i.e., an immediate child of the Nix store directory. + The location of a [store object] in the file system, i.e., an immediate child of the Nix store directory. > **Example** > From 5b69409f6b479ff28870c0502682882ee14a9dc8 Mon Sep 17 00:00:00 2001 From: Valentin Gagarin Date: Tue, 13 Feb 2024 16:08:44 +0100 Subject: [PATCH 2/3] only refer to the local store page --- doc/manual/src/glossary.md | 4 ---- 1 file changed, 4 deletions(-) diff --git a/doc/manual/src/glossary.md b/doc/manual/src/glossary.md index 51f1e3a71..6126b7e47 100644 --- a/doc/manual/src/glossary.md +++ b/doc/manual/src/glossary.md @@ -68,10 +68,6 @@ - [local store]{#gloss-local-store} - From the perspective of the location where Nix is invoked, the Nix [store] can be referred to _local_ or _remote_. - Only a local store exposes a file system directory, typically `/nix/store`, to allow operating system processes to directly access store objects. - Local stores can be used for building [derivations][derivation]. - See [Local Store](@docroot@/command-ref/new-cli/nix3-help-stores.md#local-store) for details. [local store]: #gloss-local-store From f27205f743fcfd05126f5fa7cc83eefea7873f1f Mon Sep 17 00:00:00 2001 From: Valentin Gagarin Date: Tue, 13 Feb 2024 16:25:07 +0100 Subject: [PATCH 3/3] redirect local and chroot store to main page --- doc/manual/redirects.js | 6 +++++- doc/manual/src/glossary.md | 11 +---------- 2 files changed, 6 insertions(+), 11 deletions(-) diff --git a/doc/manual/redirects.js b/doc/manual/redirects.js index d04f32b49..e25b17c76 100644 --- a/doc/manual/redirects.js +++ b/doc/manual/redirects.js @@ -358,7 +358,11 @@ const redirects = { "one-time-setup": "testing.html#one-time-setup", "using-the-ci-generated-installer-for-manual-testing": "testing.html#using-the-ci-generated-installer-for-manual-testing", "characterization-testing": "#characterisation-testing-unit", - } + }, + "glossary.html": { + "gloss-local-store": "store/types/local-store.html", + "gloss-chroot-store": "store/types/local-store.html", + }, }; // the following code matches the current page's URL against the set of redirects. diff --git a/doc/manual/src/glossary.md b/doc/manual/src/glossary.md index 6126b7e47..d257a8189 100644 --- a/doc/manual/src/glossary.md +++ b/doc/manual/src/glossary.md @@ -66,16 +66,6 @@ [store]: #gloss-store -- [local store]{#gloss-local-store} - - See [Local Store](@docroot@/command-ref/new-cli/nix3-help-stores.md#local-store) for details. - - [local store]: #gloss-local-store - -- [chroot store]{#gloss-chroot-store} - - A [local store] whose canonical path is anything other than `/nix/store`. - - [binary cache]{#gloss-binary-cache} A *binary cache* is a Nix store which uses a different format: its @@ -242,6 +232,7 @@ - All paths in the store path's [closure] are valid. [validity]: #gloss-validity + [local store]: @docroot@/store/types/local-store.md - [user environment]{#gloss-user-env}