From 39f01176a713bad4e090e19c8a25c2447056640d Mon Sep 17 00:00:00 2001 From: Valentin Gagarin Date: Wed, 27 Apr 2022 23:25:33 +0200 Subject: [PATCH] design -> architecture, add motivation following ideas found in Architecture of Gazelle[1] [1]: https://github.com/bazelbuild/bazel-gazelle/blob/56d35f8db086bb65ef876f96f7baa7b71516daf8/Design.rst --- doc/manual/src/SUMMARY.md.in | 2 +- .../src/{design/design.md => architecture/architecture.md} | 7 ++++--- doc/manual/src/{design => architecture}/store/building.md | 0 doc/manual/src/{design => architecture}/store/drvs/ca.md | 0 doc/manual/src/{design => architecture}/store/drvs/drvs.md | 0 doc/manual/src/{design => architecture}/store/drvs/ia.md | 0 .../src/{design => architecture}/store/input-addressing.md | 0 doc/manual/src/{design => architecture}/store/nar.md | 0 doc/manual/src/{design => architecture}/store/object-ca.md | 0 doc/manual/src/{design => architecture}/store/objects.md | 0 doc/manual/src/{design => architecture}/store/paths.md | 0 .../src/{design => architecture}/store/related-work.md | 0 .../src/{design => architecture}/store/relocatability.md | 0 doc/manual/src/{design => architecture}/store/store.md | 0 14 files changed, 5 insertions(+), 4 deletions(-) rename doc/manual/src/{design/design.md => architecture/architecture.md} (88%) rename doc/manual/src/{design => architecture}/store/building.md (100%) rename doc/manual/src/{design => architecture}/store/drvs/ca.md (100%) rename doc/manual/src/{design => architecture}/store/drvs/drvs.md (100%) rename doc/manual/src/{design => architecture}/store/drvs/ia.md (100%) rename doc/manual/src/{design => architecture}/store/input-addressing.md (100%) rename doc/manual/src/{design => architecture}/store/nar.md (100%) rename doc/manual/src/{design => architecture}/store/object-ca.md (100%) rename doc/manual/src/{design => architecture}/store/objects.md (100%) rename doc/manual/src/{design => architecture}/store/paths.md (100%) rename doc/manual/src/{design => architecture}/store/related-work.md (100%) rename doc/manual/src/{design => architecture}/store/relocatability.md (100%) rename doc/manual/src/{design => architecture}/store/store.md (100%) diff --git a/doc/manual/src/SUMMARY.md.in b/doc/manual/src/SUMMARY.md.in index ec457126a..c029e30bf 100644 --- a/doc/manual/src/SUMMARY.md.in +++ b/doc/manual/src/SUMMARY.md.in @@ -15,7 +15,7 @@ - [Multi-User Mode](installation/multi-user.md) - [Environment Variables](installation/env-variables.md) - [Upgrading Nix](installation/upgrading.md) -- [Design and Data Model](design/design.md) +- [Architecture](architecture/architecture.md) - [Store](design/store/store.md) - [Store Objects](design/store/objects.md) - [Store Paths](design/store/paths.md) diff --git a/doc/manual/src/design/design.md b/doc/manual/src/architecture/architecture.md similarity index 88% rename from doc/manual/src/design/design.md rename to doc/manual/src/architecture/architecture.md index 16c51533b..b17eacd2e 100644 --- a/doc/manual/src/design/design.md +++ b/doc/manual/src/architecture/architecture.md @@ -1,8 +1,9 @@ -# Design and Data Model +# Architecture -This chapter is about the technical principles behind Nix. +This chapter describes how Nix works. +It should help users understand why Nix behaves as it does, and it should help developers understand how to modify Nix and how to write similar tools. -## Architecture +## Overview Nix consists of hierarchical [layers](https://en.m.wikipedia.org/wiki/Multitier_architecture#Layers). diff --git a/doc/manual/src/design/store/building.md b/doc/manual/src/architecture/store/building.md similarity index 100% rename from doc/manual/src/design/store/building.md rename to doc/manual/src/architecture/store/building.md diff --git a/doc/manual/src/design/store/drvs/ca.md b/doc/manual/src/architecture/store/drvs/ca.md similarity index 100% rename from doc/manual/src/design/store/drvs/ca.md rename to doc/manual/src/architecture/store/drvs/ca.md diff --git a/doc/manual/src/design/store/drvs/drvs.md b/doc/manual/src/architecture/store/drvs/drvs.md similarity index 100% rename from doc/manual/src/design/store/drvs/drvs.md rename to doc/manual/src/architecture/store/drvs/drvs.md diff --git a/doc/manual/src/design/store/drvs/ia.md b/doc/manual/src/architecture/store/drvs/ia.md similarity index 100% rename from doc/manual/src/design/store/drvs/ia.md rename to doc/manual/src/architecture/store/drvs/ia.md diff --git a/doc/manual/src/design/store/input-addressing.md b/doc/manual/src/architecture/store/input-addressing.md similarity index 100% rename from doc/manual/src/design/store/input-addressing.md rename to doc/manual/src/architecture/store/input-addressing.md diff --git a/doc/manual/src/design/store/nar.md b/doc/manual/src/architecture/store/nar.md similarity index 100% rename from doc/manual/src/design/store/nar.md rename to doc/manual/src/architecture/store/nar.md diff --git a/doc/manual/src/design/store/object-ca.md b/doc/manual/src/architecture/store/object-ca.md similarity index 100% rename from doc/manual/src/design/store/object-ca.md rename to doc/manual/src/architecture/store/object-ca.md diff --git a/doc/manual/src/design/store/objects.md b/doc/manual/src/architecture/store/objects.md similarity index 100% rename from doc/manual/src/design/store/objects.md rename to doc/manual/src/architecture/store/objects.md diff --git a/doc/manual/src/design/store/paths.md b/doc/manual/src/architecture/store/paths.md similarity index 100% rename from doc/manual/src/design/store/paths.md rename to doc/manual/src/architecture/store/paths.md diff --git a/doc/manual/src/design/store/related-work.md b/doc/manual/src/architecture/store/related-work.md similarity index 100% rename from doc/manual/src/design/store/related-work.md rename to doc/manual/src/architecture/store/related-work.md diff --git a/doc/manual/src/design/store/relocatability.md b/doc/manual/src/architecture/store/relocatability.md similarity index 100% rename from doc/manual/src/design/store/relocatability.md rename to doc/manual/src/architecture/store/relocatability.md diff --git a/doc/manual/src/design/store/store.md b/doc/manual/src/architecture/store/store.md similarity index 100% rename from doc/manual/src/design/store/store.md rename to doc/manual/src/architecture/store/store.md