summary refs log tree commit diff
path: root/nixos/doc
diff options
context:
space:
mode:
authorNicolas Benes <nbenes.gh@xandea.de>2022-11-07 19:42:19 +0100
committerNicolas Benes <nbenes.gh@xandea.de>2022-11-15 19:45:33 +0100
commitf6b07f0e2f5834b1fd6432a0f4c2bc11096e53ed (patch)
tree2fe547a476d49c253d605f78dfe06f37516463f4 /nixos/doc
parent79e84ba085c152323f9f960d7b7e34730731f2bf (diff)
downloadnixpkgs-f6b07f0e2f5834b1fd6432a0f4c2bc11096e53ed.tar
nixpkgs-f6b07f0e2f5834b1fd6432a0f4c2bc11096e53ed.tar.gz
nixpkgs-f6b07f0e2f5834b1fd6432a0f4c2bc11096e53ed.tar.bz2
nixpkgs-f6b07f0e2f5834b1fd6432a0f4c2bc11096e53ed.tar.lz
nixpkgs-f6b07f0e2f5834b1fd6432a0f4c2bc11096e53ed.tar.xz
nixpkgs-f6b07f0e2f5834b1fd6432a0f4c2bc11096e53ed.tar.zst
nixpkgs-f6b07f0e2f5834b1fd6432a0f4c2bc11096e53ed.zip
fetchgit: make sparseCheckout a list of strings
The `sparseCheckout` argument allows the user to specify directories or
patterns of files, which Git uses to filter files it should check-out.

Git expects a multi-line string on stdin ("newline-delimited list", see
`git-sparse-checkout(1)`), but within nixpkgs it is more consistent to
use a list of strings instead. The list elements are joined to a
multi-line string only before passing it to the builder script.

A deprecation warning is emitted if a (multi-line) string is passed to
`sparseCheckout`, but for the time being it is still accepted.
Diffstat (limited to 'nixos/doc')
-rw-r--r--nixos/doc/manual/from_md/release-notes/rl-2211.section.xml9
-rw-r--r--nixos/doc/manual/release-notes/rl-2211.section.md2
2 files changed, 11 insertions, 0 deletions
diff --git a/nixos/doc/manual/from_md/release-notes/rl-2211.section.xml b/nixos/doc/manual/from_md/release-notes/rl-2211.section.xml
index a2f67d2707e..b5381ccb472 100644
--- a/nixos/doc/manual/from_md/release-notes/rl-2211.section.xml
+++ b/nixos/doc/manual/from_md/release-notes/rl-2211.section.xml
@@ -545,6 +545,15 @@
       </listitem>
       <listitem>
         <para>
+          The <literal>fetchgit</literal> fetcher supports sparse
+          checkouts via the <literal>sparseCheckout</literal> option.
+          This used to accept a multi-line string with
+          directories/patterns to check out, but now requires a list of
+          strings.
+        </para>
+      </listitem>
+      <listitem>
+        <para>
           <literal>openssh</literal> was updated to version 9.1,
           disabling the generation of DSA keys when using
           <literal>ssh-keygen -A</literal> as they are insecure. Also,
diff --git a/nixos/doc/manual/release-notes/rl-2211.section.md b/nixos/doc/manual/release-notes/rl-2211.section.md
index 3540881c462..913b3f9aea1 100644
--- a/nixos/doc/manual/release-notes/rl-2211.section.md
+++ b/nixos/doc/manual/release-notes/rl-2211.section.md
@@ -179,6 +179,8 @@ Available as [services.patroni](options.html#opt-services.patroni.enable).
 
 - The `fetchgit` fetcher now uses [cone mode](https://www.git-scm.com/docs/git-sparse-checkout/2.37.0#_internalscone_mode_handling) by default for sparse checkouts. [Non-cone mode](https://www.git-scm.com/docs/git-sparse-checkout/2.37.0#_internalsnon_cone_problems) can be enabled by passing `nonConeMode = true`, but note that non-cone mode is deprecated and this option may be removed alongside a future Git update without notice.
 
+- The `fetchgit` fetcher supports sparse checkouts via the `sparseCheckout` option. This used to accept a multi-line string with directories/patterns to check out, but now requires a list of strings.
+
 - `openssh` was updated to version 9.1, disabling the generation of DSA keys when using `ssh-keygen -A` as they are insecure. Also, `SetEnv` directives in `ssh_config` and `sshd_config` are now first-match-wins
 
 - `bsp-layout` no longer uses the command `cycle` to switch to other window layouts, as it got replaced by the commands `previous` and `next`.