[staging] fetchFromGitHub: name source with content intristic to the value

doc/functions/nix-gitignore.section.md

@@ -13,10 +13,10 @@
      # Simplest version
 
  nix-gitignore.gitignoreSource "supplemental-ignores\n" ./source
-     # This one reads the ./source/.gitignore and concats the auxiliary ignores
+     # This one reads the ./${src.name}/.gitignore and concats the auxiliary ignores
 
  nix-gitignore.gitignoreSourcePure "ignore-this\nignore-that\n" ./source
-     # Use this string as gitignore, don't read ./source/.gitignore.
+     # Use this string as gitignore, don't read ./${src.name}/.gitignore.
 
  nix-gitignore.gitignoreSourcePure ["ignore-this\nignore-that\n", ~/.gitignore] ./source
      # It also accepts a list (of strings and paths) that will be concatenated

doc/languages-frameworks/rust.section.md

@@ -503,7 +503,7 @@ buildPythonPackage rec {
     hash = "sha256-BoHIN/519Top1NUBjpB/oEMqi86Omt3zTQcXFWqrek0=";
   };
 
-  sourceRoot = "source/bindings/python";
+  sourceRoot = "${src.name}/bindings/python";
 
   nativeBuildInputs = [ setuptools-rust ] ++ (with rustPlatform; [
     cargoSetupHook

nixos/doc/manual/from_md/release-notes/rl-2205.section.xml

@@ -229,6 +229,22 @@
           new versions will release.
         </para>
       </listitem>
+      <listitem>
+        <para>
+          <literal>pkgs.fetchFromGitHub</literal> will now default to
+          using the repo and rev to create a default name for the
+          derivation. This helps to avoid the cases in which an
+          unchanged sha256 doesn’t expose the misaligned behavior.
+          However, this also means that usage of <quote>source/</quote>
+          as the derivation’s sourceRoot may be broken. This can be
+          mitigated by using <literal>${src.name}</literal> instead of
+          <quote>source</quote>. For usage such as
+          <literal>sourceRoot = &quot;source/sub_dir&quot;;</literal>
+          may be replaced with
+          <literal>prePatch = &quot;cd sub_dir&quot;;</literal> in most
+          cases.
+        </para>
+      </listitem>
       <listitem>
         <para>
           <literal>services.kubernetes.addons.dashboard</literal> was

nixos/doc/manual/release-notes/rl-2205.section.md

@@ -79,6 +79,15 @@ In addition to numerous new and upgraded packages, this release has the followin
   org-contrib, refer to the ones in `pkgs.emacsPackages.elpaPackages` and
   `pkgs.emacsPackages.nongnuPackages` where the new versions will release.
 
+- `pkgs.fetchFromGitHub` will now default to using the repo and rev
+  to create a default name for the derivation. This helps to avoid
+  the cases in which an unchanged sha256 doesn't expose the misaligned
+  behavior. However, this also means that usage of "source/" as the
+  derivation's sourceRoot may be broken. This can be mitigated by
+  using `${src.name}` instead of "source". For usage such as
+  `sourceRoot = "source/sub_dir";` may be replaced with
+  `prePatch = "cd sub_dir";` in most cases.
+
 - `services.kubernetes.addons.dashboard` was removed due to it being an outdated version.
 
 - The DHCP server (`services.dhcpd4`, `services.dhcpd6`) has been hardened.

nixos/modules/services/misc/home-assistant.nix

@@ -287,7 +287,7 @@ in {
           # Components that require access to serial devices (/dev/tty*)
           # List generated from home-assistant documentation:
           #   git clone https://github.com/home-assistant/home-assistant.io/
-          #   cd source/_integrations
+          #   cd ${src.name}/_integrations
           #   rg "/dev/tty" -l | cut -d'/' -f3 | cut -d'.' -f1 | sort
           # And then extended by references found in the source code, these
           # mostly the ones using config flows already.

pkgs/applications/audio/aeolus/default.nix

@@ -16,7 +16,7 @@ stdenv.mkDerivation rec {
     libX11 libXft readline
   ];
 
-  patchPhase = ''sed "s@ldconfig.*@@" -i source/Makefile'';
+  patchPhase = ''sed "s@ldconfig.*@@" -i ${src.name}/Makefile'';
 
   preBuild = "cd source";
 

pkgs/applications/audio/jaaa/default.nix

@@ -19,7 +19,7 @@ stdenv.mkDerivation rec {
   ];
 
   preConfigure = ''
-    cd ./source/
+    cd ./${src.name}/
   '';
 
   meta = with lib; {

pkgs/applications/audio/japa/default.nix

@@ -12,7 +12,7 @@ stdenv.mkDerivation rec {
   buildInputs = [ alsa-lib libjack2 fftwFloat libclthreads libclxclient libX11 libXft zita-alsa-pcmi ];
 
   preConfigure = ''
-    cd ./source/
+    cd ./${src.name}/
   '';
 
   makeFlags = [

pkgs/applications/audio/muse/default.nix

@@ -14,7 +14,7 @@ stdenv.mkDerivation rec {
     sha256 = "1rasp2v1ds2aw296lbf27rzw0l9fjl0cvbvw85d5ycvh6wkm301p";
   };
 
-  sourceRoot = "source/muse3";
+  sourceRoot = "${src.name}/muse3";
 
   prePatch = ''
     chmod u+w $NIX_BUILD_TOP

pkgs/applications/audio/picoloop/default.nix

@@ -21,7 +21,7 @@ stdenv.mkDerivation rec {
     libjack2
   ];
 
-  sourceRoot = "source/picoloop";
+  sourceRoot = "${src.name}/picoloop";
 
   makeFlags = [ "-f Makefile.PatternPlayer_debian_RtAudio_sdl20" ];
 

pkgs/applications/audio/puddletag/default.nix

@@ -11,7 +11,7 @@ python3Packages.buildPythonApplication rec {
     sha256 = "sha256-9l8Pc77MX5zFkOqU00HFS8//3Bzd2OMnVV1brmWsNAQ=";
   };
 
-  sourceRoot = "source/source";
+  sourceRoot = "${src.name}/source";
 
   nativeBuildInputs = [ wrapQtAppsHook ];
 

pkgs/applications/audio/soundkonverter/default.nix

@@ -68,7 +68,7 @@ mkDerivation rec {
   buildInputs = [ taglib ] ++ runtimeDeps;
   # encoder plugins go to ${out}/lib so they're found by kbuildsycoca5
   cmakeFlags = [ "-DCMAKE_INSTALL_PREFIX=$out" ];
-  sourceRoot = "source/src";
+  sourceRoot = "${src.name}/src";
   # add runt-time deps to PATH
   postInstall = ''
     wrapProgram $out/bin/soundkonverter --prefix PATH : ${lib.makeBinPath runtimeDeps }

pkgs/applications/audio/speech-denoiser/default.nix

@@ -12,7 +12,7 @@ let
     pname = "rnnoise-nu";
     version = "unstable-07-10-2019";
     src = speech-denoiser-src;
-    sourceRoot = "source/rnnoise";
+    prePatch = "cd rnnoise";
     nativeBuildInputs = [ autoreconfHook ];
     configureFlags = [ "--disable-examples" "--disable-doc" "--disable-shared" "--enable-static" ];
     installTargets = [ "install-rnnoise-nu" ];

pkgs/applications/audio/tagutil/default.nix

@@ -15,7 +15,7 @@ stdenv.mkDerivation rec {
     sha256 = "sha256-oY1aGl5CKVtpOfh8Wskio/huWYMiPuxWPqxlooTutcw=";
   };
 
-  sourceRoot = "source/src";
+  sourceRoot = "${src.name}/src";
 
   nativeBuildInputs = [
     cmake

pkgs/applications/audio/tetraproc/default.nix

@@ -25,7 +25,7 @@ stdenv.mkDerivation rec {
   ];
 
   preConfigure = ''
-    cd ./source/
+    cd ./${src.name}/
   '';
 
   postInstall = ''

pkgs/applications/audio/zita-ajbridge/default.nix

@@ -12,7 +12,7 @@ stdenv.mkDerivation rec {
   buildInputs = [ alsa-lib libjack2 zita-alsa-pcmi zita-resampler ];
 
   preConfigure = ''
-    cd ./source/
+    cd ./${src.name}/
   '';
 
   makeFlags = [

pkgs/applications/audio/zita-at1/default.nix

@@ -18,7 +18,7 @@ stdenv.mkDerivation rec {
   ];
 
   preConfigure = ''
-    cd ./source/
+    cd ./${src.name}/
   '';
 
   makeFlags = [

pkgs/applications/audio/zita-njbridge/default.nix

@@ -12,7 +12,7 @@ stdenv.mkDerivation rec {
   buildInputs = [ libjack2 zita-resampler ];
 
   preConfigure = ''
-    cd ./source/
+    cd ./${src.name}/
   '';
 
   makeFlags = [

pkgs/applications/blockchains/bitcoin-abc/default.nix

@@ -29,7 +29,7 @@ mkDerivation rec {
     owner = "bitcoin-ABC";
     repo = "bitcoin-abc";
     rev = "v${version}";
-    sha256 = "1x8xcdi1vcskggk9bqkwr3ah4vi9b7sj2h8hf7spac6dvz8lmzav";
+    sha256 = "sha256-z3Mjkcd/KaA5+A89pWc3WrnrMVj0JWXnlJdzR5pCinY=";
   };
 
   patches = [ ./fix-bitcoin-qt-build.patch ];

pkgs/applications/blockchains/monero-gui/default.nix

@@ -42,8 +42,8 @@ stdenv.mkDerivation rec {
   postUnpack = ''
     # copy monero sources here
     # (needs to be writable)
-    cp -r ${monero-cli.source}/* source/monero
-    chmod -R +w source/monero
+    cp -r ${monero-cli.source}/* ${src.name}/monero
+    chmod -R +w ${src.name}/monero
   '';
 
   patches = [

pkgs/applications/display-managers/lightdm-tiny-greeter/default.nix

@@ -16,7 +16,7 @@ stdenv.mkDerivation rec {
   buildInputs = [ lightdm gtk3 glib ];
 
   postUnpack = if conf != "" then ''
-    cp ${builtins.toFile "config.h" conf} source/config.h
+    cp ${builtins.toFile "config.h" conf} ${src.name}/config.h
   '' else "";
 
   buildPhase = ''

pkgs/applications/editors/emacs/elisp-packages/melpa-packages.nix

@@ -180,13 +180,13 @@ let
           buildInputs = old.buildInputs ++ [ pkgs.sqlite ];
 
           postBuild = ''
-            cd source/sqlite
+            cd ${old.src.name}/sqlite
             make
             cd -
           '';
 
           postInstall = ''
-            install -m=755 -D source/sqlite/emacsql-sqlite \
+            install -m=755 -D ${old.src.name}/sqlite/emacsql-sqlite \
               $out/share/emacs/site-lisp/elpa/emacsql-sqlite-${old.version}/sqlite/emacsql-sqlite
           '';
 
@@ -262,7 +262,7 @@ let
             cd ..
           '';
           checkPhase = ''
-            cd source/server
+            cd ${old.src.name}/server
             make check
             cd ../..
           '';
@@ -297,7 +297,7 @@ let
           postInstall = ''
             outd=$(echo $out/share/emacs/site-lisp/elpa/libgit-**)
             mkdir $outd/build
-            install -m444 -t $outd/build ./source/src/libegit2.so
+            install -m444 -t $outd/build ./${attrs.src.name}/src/libegit2.so
             rm -r $outd/src $outd/Makefile $outd/CMakeLists.txt
           '';
         });
@@ -414,14 +414,14 @@ let
           '';
 
           postBuild = ''
-            cd source/server
+            cd ${old.src.name}/server
             make
             cd -
           '';
 
           postInstall = ''
             mkdir -p $out/bin
-            install -m755 -Dt $out/bin ./source/server/telega-server
+            install -m755 -Dt $out/bin ./${old.src.name}/server/telega-server
           '';
         });
 
@@ -527,7 +527,7 @@ let
           # we need the proper out directory to exist, so we do this in the
           # postInstall instead of postBuild
           postInstall = ''
-            pushd source/build >/dev/null
+            pushd ${old.src.name}/build >/dev/null
             make
             install -m444 -t $out/share/emacs/site-lisp/elpa/vterm-** ../*.so
             popd > /dev/null

pkgs/applications/editors/nedit/default.nix

@@ -21,7 +21,7 @@ stdenv.mkDerivation rec {
 
   installPhase = ''
     mkdir -p $out/bin
-    cp -p source/nedit source/nc $out/bin
+    cp -p ${src.name}/nedit ${src.name}/nc $out/bin
   '';
 
   meta = with lib; {

pkgs/applications/graphics/djv/default.nix

@@ -55,7 +55,7 @@ let
 
     src = djvSrc;
 
-    sourceRoot = "source/etc/SuperBuild";
+    sourceRoot = "${src.name}/etc/SuperBuild";
 
     nativeBuildInputs = [ cmake ];
     buildInputs = [

pkgs/applications/graphics/imgbrd-grabber/default.nix

@@ -88,7 +88,7 @@ stdenv.mkDerivation rec {
     ln -s $out/share/Grabber/Grabber-cli $out/bin/Grabber-cli
   '';
 
-  sourceRoot = "source/src";
+  sourceRoot = "${src.name}/src";
 
   meta = with lib; {
     description = "Very customizable imageboard/booru downloader with powerful filenaming features";

pkgs/applications/graphics/pixelnuke/default.nix

@@ -11,7 +11,7 @@ stdenv.mkDerivation {
     sha256 = "03dp0p00chy00njl4w02ahxqiwqpjsrvwg8j4yi4dgckkc3gbh40";
   };
 
-  sourceRoot = "source/pixelnuke";
+  prePatch = "cd pixelnuke";
 
   buildInputs = [ libevent glew glfw ];
 

pkgs/applications/misc/blender/default.nix

@@ -73,7 +73,7 @@ stdenv.mkDerivation rec {
   '' +
     (if stdenv.isDarwin then ''
       : > build_files/cmake/platform/platform_apple_xcode.cmake
-      substituteInPlace source/creator/CMakeLists.txt \
+      substituteInPlace ${src.name}/creator/CMakeLists.txt \
         --replace '${"$"}{LIBDIR}/python' \
                   '${python}' \
         --replace '${"$"}{LIBDIR}/openmp' \

pkgs/applications/misc/candle/default.nix

@@ -13,7 +13,7 @@ mkDerivation rec {
 
   nativeBuildInputs = [ qmake ];
 
-  sourceRoot = "source/src";
+  sourceRoot = "${src.name}/src";
 
   installPhase = ''
     runHook preInstall

pkgs/applications/misc/ericw-tools/default.nix

@@ -14,7 +14,7 @@ stdenv.mkDerivation rec {
     sha256 = "11sap7qv0rlhw8q25azvhgjcwiql3zam09q0gim3i04cg6fkh0vp";
   };
   postUnpack = ''
-    pushd source/3rdparty
+    pushd ${src.name}/3rdparty
     ln -s ${fmt.src} fmt
     ln -s ${gtest.src} googletest
     popd

pkgs/applications/misc/fitnesstrax/default.nix

@@ -41,5 +41,8 @@ rustPlatform.buildRustPackage rec {
     homepage = "https://github.com/luminescent-dreams/fitnesstrax";
     license = licenses.bsd3;
     maintainers = with maintainers; [ savannidgerinel ];
+
+    # https://github.com/luminescent-dreams/fitnesstrax/ no longer exists
+    broken = true;
   };
 }

pkgs/applications/misc/gpsbabel/gui.nix

@@ -5,7 +5,7 @@ mkDerivation {
 
   inherit (gpsbabel) src version;
 
-  sourceRoot = "source/gui";
+  prePatch = "cd gui";
 
   nativeBuildInputs = [ qmake qttools ];
   buildInputs = [ qtwebkit ];

pkgs/applications/misc/k2pdfopt/default.nix

@@ -85,15 +85,15 @@ in stdenv.mkDerivation rec {
         sha256 = "13nl9nrcx2awz9l83mlv2psi1lmn3hdnfwxvwgwiwbxlkjl3zqq0";
       };
       patchCommands = ''
-        cp ${k2pdfopt_src}/mupdf_mod/{filter-basic,font,stext-device,string}.c ./source/fitz/
-        cp ${k2pdfopt_src}/mupdf_mod/pdf-* ./source/pdf/
+        cp ${k2pdfopt_src}/mupdf_mod/{filter-basic,font,stext-device,string}.c ./${src.name}/fitz/
+        cp ${k2pdfopt_src}/mupdf_mod/pdf-* ./${src.name}/pdf/
       '';
     };
     mupdf_modded = mupdf_1_17.overrideAttrs ({ patches ? [], ... }: {
       patches = patches ++ [ mupdf_patch ];
       # This function is missing in font.c, see font-win32.c
       postPatch = ''
-        echo "void pdf_install_load_system_font_funcs(fz_context *ctx) {}" >> source/fitz/font.c
+        echo "void pdf_install_load_system_font_funcs(fz_context *ctx) {}" >> ${src.name}/fitz/font.c
       '';
     });
 

pkgs/applications/misc/mupdf/1.17.nix

@@ -28,7 +28,7 @@ in stdenv.mkDerivation rec {
   ;
 
   postPatch = ''
-    sed -i "s/__OPENJPEG__VERSION__/${openJpegVersion}/" source/fitz/load-jpx.c
+    sed -i "s/__OPENJPEG__VERSION__/${openJpegVersion}/" ${src.name}/fitz/load-jpx.c
   '';
 
   makeFlags = [ "prefix=$(out) USE_SYSTEM_LIBS=yes" ];

pkgs/applications/misc/qsudo/default.nix

@@ -17,7 +17,7 @@ mkDerivation rec {
     sha256 = "06kg057vwkvafnk69m9rar4wih3vq4h36wbzwbfc2kndsnn47lfl";
   };
 
-  sourceRoot = "source/src-qt5";
+  sourceRoot = "${src.name}/src-qt5";
 
   nativeBuildInputs = [
     qmake