summary refs log tree commit diff
path: root/pkgs/tools/text
diff options
context:
space:
mode:
authorMatthew Bauer <mjbauer95@gmail.com>2020-06-26 16:44:45 -0400
committerFrederik Rietdijk <freddyrietdijk@fridh.nl>2020-07-31 08:56:53 +0200
commitd0677e6d45c4acf9fdd3f09e77f7201794a45a82 (patch)
treef1deaee4b39ad422609a6fdb3cfad37c6dbfdb56 /pkgs/tools/text
parentf36899e11826b18fdd60496b28af692afbea8b85 (diff)
downloadnixpkgs-d0677e6d45c4acf9fdd3f09e77f7201794a45a82.tar
nixpkgs-d0677e6d45c4acf9fdd3f09e77f7201794a45a82.tar.gz
nixpkgs-d0677e6d45c4acf9fdd3f09e77f7201794a45a82.tar.bz2
nixpkgs-d0677e6d45c4acf9fdd3f09e77f7201794a45a82.tar.lz
nixpkgs-d0677e6d45c4acf9fdd3f09e77f7201794a45a82.tar.xz
nixpkgs-d0677e6d45c4acf9fdd3f09e77f7201794a45a82.tar.zst
nixpkgs-d0677e6d45c4acf9fdd3f09e77f7201794a45a82.zip
treewide: add warning comment to “boot” packages
This adds a warning to the top of each “boot” package that reads:

  Note: this package is used for bootstrapping fetchurl, and thus cannot
  use fetchpatch! All mutable patches (generated by GitHub or cgit) that
  are needed here should be included directly in Nixpkgs as files.

This makes it clear to maintainer that they may need to treat this
package a little differently than others. Importantly, we can’t use
fetchpatch here due to using <nix/fetchurl.nix>. To avoid having stale
hashes, we need to include patches that are subject to changing
overtime (for instance, gitweb’s patches contain a version number at
the bottom).
Diffstat (limited to 'pkgs/tools/text')
-rw-r--r--pkgs/tools/text/diffutils/default.nix5
-rw-r--r--pkgs/tools/text/gnugrep/default.nix7
2 files changed, 11 insertions, 1 deletions
diff --git a/pkgs/tools/text/diffutils/default.nix b/pkgs/tools/text/diffutils/default.nix
index 06ecda9ff21..6fd69a9ba4c 100644
--- a/pkgs/tools/text/diffutils/default.nix
+++ b/pkgs/tools/text/diffutils/default.nix
@@ -1,5 +1,10 @@
 { stdenv, fetchurl, xz, coreutils ? null }:
 
+# Note: this package is used for bootstrapping fetchurl, and thus
+# cannot use fetchpatch! All mutable patches (generated by GitHub or
+# cgit) that are needed here should be included directly in Nixpkgs as
+# files.
+
 stdenv.mkDerivation rec {
   name = "diffutils-3.7";
 
diff --git a/pkgs/tools/text/gnugrep/default.nix b/pkgs/tools/text/gnugrep/default.nix
index 3f5c4d7d86c..f7e3cd42a9b 100644
--- a/pkgs/tools/text/gnugrep/default.nix
+++ b/pkgs/tools/text/gnugrep/default.nix
@@ -1,5 +1,10 @@
 { stdenv, fetchurl, pcre, libiconv, perl }:
 
+# Note: this package is used for bootstrapping fetchurl, and thus
+# cannot use fetchpatch! All mutable patches (generated by GitHub or
+# cgit) that are needed here should be included directly in Nixpkgs as
+# files.
+
 let version = "3.4"; in
 
 stdenv.mkDerivation {
@@ -19,7 +24,7 @@ stdenv.mkDerivation {
 
   # cygwin: FAIL: multibyte-white-space
   # freebsd: FAIL mb-non-UTF8-performance
-  # all platforms: timing sensitivity in long-pattern-perf 
+  # all platforms: timing sensitivity in long-pattern-perf
   #doCheck = !stdenv.isDarwin && !stdenv.isSunOS && !stdenv.isCygwin && !stdenv.isFreeBSD;
   doCheck = false;