From 9963ad5c5fbbe55fb310e9477cab2fa685afaac2 Mon Sep 17 00:00:00 2001 From: Yueh-Shun Li Date: Sat, 3 Jun 2023 19:05:54 +0000 Subject: [PATCH] doc: builders -> build helpers to reduce ambigualty --- .github/CODEOWNERS | 4 ++-- doc/build-helpers.md | 12 ++++++++++++ doc/{builders => build-helpers}/fetchers.chapter.md | 0 doc/{builders => build-helpers}/images.md | 0 .../images/appimagetools.section.md | 0 .../images/binarycache.section.md | 0 .../images/dockertools.section.md | 0 .../images/makediskimage.section.md | 0 .../images/ocitools.section.md | 0 .../images/portableservice.section.md | 0 .../images/snaptools.section.md | 0 doc/{builders => build-helpers}/special.md | 4 ++-- .../special/fhs-environments.section.md | 0 .../special/makesetuphook.section.md | 2 +- .../special/mkshell.section.md | 0 .../special/vm-tools.section.md | 0 doc/{builders => build-helpers}/testers.chapter.md | 0 .../trivial-build-helpers.chapter.md} | 2 +- doc/builders.md | 12 ------------ doc/manual.md.in | 2 +- 20 files changed, 19 insertions(+), 19 deletions(-) create mode 100644 doc/build-helpers.md rename doc/{builders => build-helpers}/fetchers.chapter.md (100%) rename doc/{builders => build-helpers}/images.md (100%) rename doc/{builders => build-helpers}/images/appimagetools.section.md (100%) rename doc/{builders => build-helpers}/images/binarycache.section.md (100%) rename doc/{builders => build-helpers}/images/dockertools.section.md (100%) rename doc/{builders => build-helpers}/images/makediskimage.section.md (100%) rename doc/{builders => build-helpers}/images/ocitools.section.md (100%) rename doc/{builders => build-helpers}/images/portableservice.section.md (100%) rename doc/{builders => build-helpers}/images/snaptools.section.md (100%) rename doc/{builders => build-helpers}/special.md (62%) rename doc/{builders => build-helpers}/special/fhs-environments.section.md (100%) rename doc/{builders => build-helpers}/special/makesetuphook.section.md (91%) rename doc/{builders => build-helpers}/special/mkshell.section.md (100%) rename doc/{builders => build-helpers}/special/vm-tools.section.md (100%) rename doc/{builders => build-helpers}/testers.chapter.md (100%) rename doc/{builders/trivial-builders.chapter.md => build-helpers/trivial-build-helpers.chapter.md} (99%) delete mode 100644 doc/builders.md diff --git a/.github/CODEOWNERS b/.github/CODEOWNERS index dcec65355632..59348b7b27aa 100644 --- a/.github/CODEOWNERS +++ b/.github/CODEOWNERS @@ -61,7 +61,7 @@ /pkgs/build-support/writers @lassulus @Profpatsch # Nixpkgs make-disk-image -/doc/builders/images/makediskimage.section.md @raitobezarius +/doc/build-helpers/images/makediskimage.section.md @raitobezarius /nixos/lib/make-disk-image.nix @raitobezarius # Nixpkgs documentation @@ -272,7 +272,7 @@ pkgs/development/python-modules/buildcatrust/ @ajs124 @lukegb @mweinelt # Docker tools /pkgs/build-support/docker @roberth /nixos/tests/docker-tools* @roberth -/doc/builders/images/dockertools.section.md @roberth +/doc/build-helpers/images/dockertools.section.md @roberth # Blockchains /pkgs/applications/blockchains @mmahut @RaghavSood diff --git a/doc/build-helpers.md b/doc/build-helpers.md new file mode 100644 index 000000000000..40ce7173a221 --- /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 similarity index 100% rename from doc/builders/fetchers.chapter.md rename to doc/build-helpers/fetchers.chapter.md diff --git a/doc/builders/images.md b/doc/build-helpers/images.md similarity index 100% rename from doc/builders/images.md rename to doc/build-helpers/images.md diff --git a/doc/builders/images/appimagetools.section.md b/doc/build-helpers/images/appimagetools.section.md similarity index 100% rename from doc/builders/images/appimagetools.section.md rename to doc/build-helpers/images/appimagetools.section.md diff --git a/doc/builders/images/binarycache.section.md b/doc/build-helpers/images/binarycache.section.md similarity index 100% rename from doc/builders/images/binarycache.section.md rename to doc/build-helpers/images/binarycache.section.md diff --git a/doc/builders/images/dockertools.section.md b/doc/build-helpers/images/dockertools.section.md similarity index 100% rename from doc/builders/images/dockertools.section.md rename to doc/build-helpers/images/dockertools.section.md diff --git a/doc/builders/images/makediskimage.section.md b/doc/build-helpers/images/makediskimage.section.md similarity index 100% rename from doc/builders/images/makediskimage.section.md rename to doc/build-helpers/images/makediskimage.section.md diff --git a/doc/builders/images/ocitools.section.md b/doc/build-helpers/images/ocitools.section.md similarity index 100% rename from doc/builders/images/ocitools.section.md rename to doc/build-helpers/images/ocitools.section.md diff --git a/doc/builders/images/portableservice.section.md b/doc/build-helpers/images/portableservice.section.md similarity index 100% rename from doc/builders/images/portableservice.section.md rename to doc/build-helpers/images/portableservice.section.md diff --git a/doc/builders/images/snaptools.section.md b/doc/build-helpers/images/snaptools.section.md similarity index 100% rename from doc/builders/images/snaptools.section.md rename to doc/build-helpers/images/snaptools.section.md diff --git a/doc/builders/special.md b/doc/build-helpers/special.md similarity index 62% rename from doc/builders/special.md rename to doc/build-helpers/special.md index aa6d9e4d98d6..f88648207fdc 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 similarity index 100% rename from doc/builders/special/fhs-environments.section.md rename to 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 similarity index 91% rename from doc/builders/special/makesetuphook.section.md rename to doc/build-helpers/special/makesetuphook.section.md index eb042412137b..e83164b7eb70 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 similarity index 100% rename from doc/builders/special/mkshell.section.md rename to 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 similarity index 100% rename from doc/builders/special/vm-tools.section.md rename to doc/build-helpers/special/vm-tools.section.md diff --git a/doc/builders/testers.chapter.md b/doc/build-helpers/testers.chapter.md similarity index 100% rename from doc/builders/testers.chapter.md rename to doc/build-helpers/testers.chapter.md diff --git a/doc/builders/trivial-builders.chapter.md b/doc/build-helpers/trivial-build-helpers.chapter.md similarity index 99% rename from doc/builders/trivial-builders.chapter.md rename to doc/build-helpers/trivial-build-helpers.chapter.md index 2cb1f2debcb8..a0cda86a6607 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 9a238add083f..000000000000 --- 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 6b8d351380f9..52971ff526c2 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 ```