diff options
author | Yueh-Shun Li <shamrocklee@posteo.net> | 2023-06-03 19:05:54 +0000 |
---|---|---|
committer | Yueh-Shun Li <shamrocklee@posteo.net> | 2023-11-07 19:58:53 +0000 |
commit | 9963ad5c5fbbe55fb310e9477cab2fa685afaac2 (patch) | |
tree | df313f78c6f9a130173f87df4603693686dbcb1e /doc | |
parent | 70f21a213651a0f4149bea10721fea04485c8a80 (diff) | |
download | nixpkgs-9963ad5c5fbbe55fb310e9477cab2fa685afaac2.tar nixpkgs-9963ad5c5fbbe55fb310e9477cab2fa685afaac2.tar.gz nixpkgs-9963ad5c5fbbe55fb310e9477cab2fa685afaac2.tar.bz2 nixpkgs-9963ad5c5fbbe55fb310e9477cab2fa685afaac2.tar.lz nixpkgs-9963ad5c5fbbe55fb310e9477cab2fa685afaac2.tar.xz nixpkgs-9963ad5c5fbbe55fb310e9477cab2fa685afaac2.tar.zst nixpkgs-9963ad5c5fbbe55fb310e9477cab2fa685afaac2.zip |
doc: builders -> build helpers to reduce ambigualty
Diffstat (limited to 'doc')
-rw-r--r-- | doc/build-helpers.md | 12 | ||||
-rw-r--r-- | doc/build-helpers/fetchers.chapter.md (renamed from doc/builders/fetchers.chapter.md) | 0 | ||||
-rw-r--r-- | doc/build-helpers/images.md (renamed from doc/builders/images.md) | 0 | ||||
-rw-r--r-- | doc/build-helpers/images/appimagetools.section.md (renamed from doc/builders/images/appimagetools.section.md) | 0 | ||||
-rw-r--r-- | doc/build-helpers/images/binarycache.section.md (renamed from doc/builders/images/binarycache.section.md) | 0 | ||||
-rw-r--r-- | doc/build-helpers/images/dockertools.section.md (renamed from doc/builders/images/dockertools.section.md) | 0 | ||||
-rw-r--r-- | doc/build-helpers/images/makediskimage.section.md (renamed from doc/builders/images/makediskimage.section.md) | 0 | ||||
-rw-r--r-- | doc/build-helpers/images/ocitools.section.md (renamed from doc/builders/images/ocitools.section.md) | 0 | ||||
-rw-r--r-- | doc/build-helpers/images/portableservice.section.md (renamed from doc/builders/images/portableservice.section.md) | 0 | ||||
-rw-r--r-- | doc/build-helpers/images/snaptools.section.md (renamed from doc/builders/images/snaptools.section.md) | 0 | ||||
-rw-r--r-- | doc/build-helpers/special.md (renamed from doc/builders/special.md) | 4 | ||||
-rw-r--r-- | doc/build-helpers/special/fhs-environments.section.md (renamed from doc/builders/special/fhs-environments.section.md) | 0 | ||||
-rw-r--r-- | doc/build-helpers/special/makesetuphook.section.md (renamed from doc/builders/special/makesetuphook.section.md) | 2 | ||||
-rw-r--r-- | doc/build-helpers/special/mkshell.section.md (renamed from doc/builders/special/mkshell.section.md) | 0 | ||||
-rw-r--r-- | doc/build-helpers/special/vm-tools.section.md (renamed from doc/builders/special/vm-tools.section.md) | 0 | ||||
-rw-r--r-- | doc/build-helpers/testers.chapter.md (renamed from doc/builders/testers.chapter.md) | 0 | ||||
-rw-r--r-- | doc/build-helpers/trivial-build-helpers.chapter.md (renamed from doc/builders/trivial-builders.chapter.md) | 2 | ||||
-rw-r--r-- | doc/builders.md | 12 | ||||
-rw-r--r-- | doc/manual.md.in | 2 |
19 files changed, 17 insertions, 17 deletions
diff --git a/doc/build-helpers.md b/doc/build-helpers.md new file mode 100644 index 00000000000..40ce7173a22 --- /dev/null +++ b/doc/build-helpers.md @@ -0,0 +1,12 @@ +# Build helpers {#part-builders} + +```{=include=} chapters +build-helpers/fetchers.chapter.md +build-helpers/trivial-build-helpers.chapter.md +build-helpers/testers.chapter.md +build-helpers/special.md +build-helpers/images.md +hooks/index.md +languages-frameworks/index.md +packages/index.md +``` diff --git a/doc/builders/fetchers.chapter.md b/doc/build-helpers/fetchers.chapter.md index 7bd1bbd6de0..7bd1bbd6de0 100644 --- a/doc/builders/fetchers.chapter.md +++ b/doc/build-helpers/fetchers.chapter.md diff --git a/doc/builders/images.md b/doc/build-helpers/images.md index 5596784bfa4..5596784bfa4 100644 --- a/doc/builders/images.md +++ b/doc/build-helpers/images.md diff --git a/doc/builders/images/appimagetools.section.md b/doc/build-helpers/images/appimagetools.section.md index 0c72315a26e..0c72315a26e 100644 --- a/doc/builders/images/appimagetools.section.md +++ b/doc/build-helpers/images/appimagetools.section.md diff --git a/doc/builders/images/binarycache.section.md b/doc/build-helpers/images/binarycache.section.md index 62e47dad7c6..62e47dad7c6 100644 --- a/doc/builders/images/binarycache.section.md +++ b/doc/build-helpers/images/binarycache.section.md diff --git a/doc/builders/images/dockertools.section.md b/doc/build-helpers/images/dockertools.section.md index 42d6e297f52..42d6e297f52 100644 --- a/doc/builders/images/dockertools.section.md +++ b/doc/build-helpers/images/dockertools.section.md diff --git a/doc/builders/images/makediskimage.section.md b/doc/build-helpers/images/makediskimage.section.md index e50479c4e83..e50479c4e83 100644 --- a/doc/builders/images/makediskimage.section.md +++ b/doc/build-helpers/images/makediskimage.section.md diff --git a/doc/builders/images/ocitools.section.md b/doc/build-helpers/images/ocitools.section.md index c35f65bce00..c35f65bce00 100644 --- a/doc/builders/images/ocitools.section.md +++ b/doc/build-helpers/images/ocitools.section.md diff --git a/doc/builders/images/portableservice.section.md b/doc/build-helpers/images/portableservice.section.md index 5400928b158..5400928b158 100644 --- a/doc/builders/images/portableservice.section.md +++ b/doc/build-helpers/images/portableservice.section.md diff --git a/doc/builders/images/snaptools.section.md b/doc/build-helpers/images/snaptools.section.md index 259fa1b0618..259fa1b0618 100644 --- a/doc/builders/images/snaptools.section.md +++ b/doc/build-helpers/images/snaptools.section.md diff --git a/doc/builders/special.md b/doc/build-helpers/special.md index aa6d9e4d98d..f88648207fd 100644 --- a/doc/builders/special.md +++ b/doc/build-helpers/special.md @@ -1,6 +1,6 @@ -# Special builders {#chap-special} +# Special build helpers {#chap-special} -This chapter describes several special builders. +This chapter describes several special build helpers. ```{=include=} sections special/fhs-environments.section.md diff --git a/doc/builders/special/fhs-environments.section.md b/doc/build-helpers/special/fhs-environments.section.md index 8145fbd730f..8145fbd730f 100644 --- a/doc/builders/special/fhs-environments.section.md +++ b/doc/build-helpers/special/fhs-environments.section.md diff --git a/doc/builders/special/makesetuphook.section.md b/doc/build-helpers/special/makesetuphook.section.md index eb042412137..e83164b7eb7 100644 --- a/doc/builders/special/makesetuphook.section.md +++ b/doc/build-helpers/special/makesetuphook.section.md @@ -1,6 +1,6 @@ # pkgs.makeSetupHook {#sec-pkgs.makeSetupHook} -`pkgs.makeSetupHook` is a builder that produces hooks that go in to `nativeBuildInputs` +`pkgs.makeSetupHook` is a build helper that produces hooks that go in to `nativeBuildInputs` ## Usage {#sec-pkgs.makeSetupHook-usage} diff --git a/doc/builders/special/mkshell.section.md b/doc/build-helpers/special/mkshell.section.md index 96d43535955..96d43535955 100644 --- a/doc/builders/special/mkshell.section.md +++ b/doc/build-helpers/special/mkshell.section.md diff --git a/doc/builders/special/vm-tools.section.md b/doc/build-helpers/special/vm-tools.section.md index 8feab04902d..8feab04902d 100644 --- a/doc/builders/special/vm-tools.section.md +++ b/doc/build-helpers/special/vm-tools.section.md diff --git a/doc/builders/testers.chapter.md b/doc/build-helpers/testers.chapter.md index b2a581c3dd8..b2a581c3dd8 100644 --- a/doc/builders/testers.chapter.md +++ b/doc/build-helpers/testers.chapter.md diff --git a/doc/builders/trivial-builders.chapter.md b/doc/build-helpers/trivial-build-helpers.chapter.md index 2cb1f2debcb..a0cda86a660 100644 --- a/doc/builders/trivial-builders.chapter.md +++ b/doc/build-helpers/trivial-build-helpers.chapter.md @@ -1,4 +1,4 @@ -# Trivial builders {#chap-trivial-builders} +# Trivial build helpers {#chap-trivial-builders} Nixpkgs provides a couple of functions that help with building derivations. The most important one, `stdenv.mkDerivation`, has already been documented above. The following functions wrap `stdenv.mkDerivation`, making it easier to use in certain cases. diff --git a/doc/builders.md b/doc/builders.md deleted file mode 100644 index 9a238add083..00000000000 --- a/doc/builders.md +++ /dev/null @@ -1,12 +0,0 @@ -# Builders {#part-builders} - -```{=include=} chapters -builders/fetchers.chapter.md -builders/trivial-builders.chapter.md -builders/testers.chapter.md -builders/special.md -builders/images.md -hooks/index.md -languages-frameworks/index.md -packages/index.md -``` diff --git a/doc/manual.md.in b/doc/manual.md.in index 6b8d351380f..52971ff526c 100644 --- a/doc/manual.md.in +++ b/doc/manual.md.in @@ -9,7 +9,7 @@ preface.chapter.md using-nixpkgs.md lib.md stdenv.md -builders.md +build-helpers.md development.md contributing.md ``` |