diff options
author | Janne Heß <janne@hess.ooo> | 2024-03-27 19:10:27 +0100 |
---|---|---|
committer | Valentin Gagarin <valentin.gagarin@tweag.io> | 2024-03-28 09:28:12 +0100 |
commit | fcc95ff8172cc68a0d2d52aa1e8ef2120d2904ec (patch) | |
tree | 8de1a02f7d1624c97562c7736896a6c95c74ec04 /doc/functions | |
parent | bc77c7a9730833c7668c92288c6af950e7270cb5 (diff) |
treewide: Fix all Nix ASTs in all markdown files
This allows for correct highlighting and maybe future automatic
formatting. The AST was verified to work with nixfmt only.
Diffstat (limited to 'doc/functions')
-rw-r--r-- | doc/functions/nix-gitignore.section.md | 29 |
1 files changed, 18 insertions, 11 deletions
diff --git a/doc/functions/nix-gitignore.section.md b/doc/functions/nix-gitignore.section.md index 8eb4081d2878..8532ab68ac04 100644 --- a/doc/functions/nix-gitignore.section.md +++ b/doc/functions/nix-gitignore.section.md @@ -7,27 +7,30 @@ `pkgs.nix-gitignore` exports a number of functions, but you'll most likely need either `gitignoreSource` or `gitignoreSourcePure`. As their first argument, they both accept either 1. a file with gitignore lines or 2. a string with gitignore lines, or 3. a list of either of the two. They will be concatenated into a single big string. ```nix -{ pkgs ? import <nixpkgs> {} }: +{ pkgs ? import <nixpkgs> {} }: { - nix-gitignore.gitignoreSource [] ./source + src = nix-gitignore.gitignoreSource [] ./source; # Simplest version - nix-gitignore.gitignoreSource "supplemental-ignores\n" ./source + src = nix-gitignore.gitignoreSource "supplemental-ignores\n" ./source; # This one reads the ./source/.gitignore and concats the auxiliary ignores - nix-gitignore.gitignoreSourcePure "ignore-this\nignore-that\n" ./source + src = nix-gitignore.gitignoreSourcePure "ignore-this\nignore-that\n" ./source; # Use this string as gitignore, don't read ./source/.gitignore. - nix-gitignore.gitignoreSourcePure ["ignore-this\nignore-that\n", ~/.gitignore] ./source + src = nix-gitignore.gitignoreSourcePure ["ignore-this\nignore-that\n" ~/.gitignore] ./source; # It also accepts a list (of strings and paths) that will be concatenated # once the paths are turned to strings via readFile. +} ``` These functions are derived from the `Filter` functions by setting the first filter argument to `(_: _: true)`: ```nix -gitignoreSourcePure = gitignoreFilterSourcePure (_: _: true); -gitignoreSource = gitignoreFilterSource (_: _: true); +{ + gitignoreSourcePure = gitignoreFilterSourcePure (_: _: true); + gitignoreSource = gitignoreFilterSource (_: _: true); +} ``` Those filter functions accept the same arguments the `builtins.filterSource` function would pass to its filters, thus `fn: gitignoreFilterSourcePure fn ""` should be extensionally equivalent to `filterSource`. The file is blacklisted if it's blacklisted by either your filter or the gitignoreFilter. @@ -35,7 +38,9 @@ Those filter functions accept the same arguments the `builtins.filterSource` fun If you want to make your own filter from scratch, you may use ```nix -gitignoreFilter = ign: root: filterPattern (gitignoreToPatterns ign) root; +{ + gitignoreFilter = ign: root: filterPattern (gitignoreToPatterns ign) root; +} ``` ## gitignore files in subdirectories {#sec-pkgs-nix-gitignore-usage-recursive} @@ -43,7 +48,9 @@ gitignoreFilter = ign: root: filterPattern (gitignoreToPatterns ign) root; If you wish to use a filter that would search for .gitignore files in subdirectories, just like git does by default, use this function: ```nix -gitignoreFilterRecursiveSource = filter: patterns: root: -# OR -gitignoreRecursiveSource = gitignoreFilterSourcePure (_: _: true); +{ + # gitignoreFilterRecursiveSource = filter: patterns: root: + # OR + gitignoreRecursiveSource = gitignoreFilterSourcePure (_: _: true); +} ``` |