minion/docs
1
0
Fork 0
forked from auxolotl/docs
Code Pull requests 5 Activity
docs/Nixpkgs/Library-Reference/fileset/index.html

3838 lines
99 KiB
HTML
Raw Normal View History

Deploy cd4936a to pages...pages.gay
2024-07-24 19:14:02 +00:00
<!doctype html>
<html lang="en" class="no-js">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width,initial-scale=1">
<meta name="description" content="Aux Documentation">
<meta name="author" content="Nixpkgs Aux, and Lix Contributors">
<link rel="canonical" href="https://docs.auxolotl.org/Nixpkgs/Library-Reference/fileset/">
<link rel="prev" href="../derivations/">
<link rel="next" href="../filesystem/">
<link rel="icon" href="../../../assets/aux-logo.svg">
<meta name="generator" content="mkdocs-1.6.0, mkdocs-material-9.5.29">
<title>lib.fileset: file set functions - Aux Docs</title>
<link rel="stylesheet" href="../../../assets/stylesheets/main.76a95c52.min.css">
<link rel="stylesheet" href="../../../assets/stylesheets/palette.06af60db.min.css">
<link rel="preconnect" href="https://fonts.gstatic.com" crossorigin>
<link rel="stylesheet" href="https://fonts.bunny.net/css?family=IBM+Plex+Sans:300,300i,400,400i,700,700i%7CIBM+Plex+Mono:400,400i,700,700i&display=fallback">
<style>:root{--md-text-font:"IBM Plex Sans";--md-code-font:"IBM Plex Mono"}</style>
<script>__md_scope=new URL("../../..",location),__md_hash=e=>[...e].reduce((e,_)=>(e<<5)-e+_.charCodeAt(0),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
<meta property="og:type" content="website" >
<meta property="og:title" content="lib.fileset: file set functions {#sec-functions-library-fileset} - Aux Docs" >
<meta property="og:description" content="Aux Documentation" >
<meta property="og:image" content="https://docs.auxolotl.org/assets/images/social/Nixpkgs/Library-Reference/fileset.png" >
<meta property="og:image:type" content="image/png" >
<meta property="og:image:width" content="1200" >
<meta property="og:image:height" content="630" >
<meta property="og:url" content="https://docs.auxolotl.org/Nixpkgs/Library-Reference/fileset/" >
<meta name="twitter:card" content="summary_large_image" >
<meta name="twitter:title" content="lib.fileset: file set functions {#sec-functions-library-fileset} - Aux Docs" >
<meta name="twitter:description" content="Aux Documentation" >
<meta name="twitter:image" content="https://docs.auxolotl.org/assets/images/social/Nixpkgs/Library-Reference/fileset.png" >
</head>
<body dir="ltr" data-md-color-scheme="default" data-md-color-primary="indigo" data-md-color-accent="blue">
<input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="__drawer" autocomplete="off">
<input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search" autocomplete="off">
<label class="md-overlay" for="__drawer"></label>
<div data-md-component="skip">
<a href="#sec-functions-library-fileset" class="md-skip">
Skip to content
</a>
</div>
<div data-md-component="announce">
</div>
<header class="md-header" data-md-component="header">
<nav class="md-header__inner md-grid" aria-label="Header">
<a href="../../.." title="Aux Docs" class="md-header__button md-logo" aria-label="Aux Docs" data-md-component="logo">
<img src="../../../assets/aux-logo.svg" alt="logo">
</a>
<label class="md-header__button md-icon" for="__drawer">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M3 6h18v2H3V6m0 5h18v2H3v-2m0 5h18v2H3v-2Z"/></svg>
</label>
<div class="md-header__title" data-md-component="header-title">
<div class="md-header__ellipsis">
<div class="md-header__topic">
<span class="md-ellipsis">
Aux Docs
</span>
</div>
<div class="md-header__topic" data-md-component="header-topic">
<span class="md-ellipsis">
lib.fileset: file set functions
</span>
</div>
</div>
</div>
<form class="md-header__option" data-md-component="palette">
<input class="md-option" data-md-color-media="(prefers-color-scheme: light)" data-md-color-scheme="default" data-md-color-primary="indigo" data-md-color-accent="blue" aria-label="Dark Mode" type="radio" name="__palette" id="__palette_0">
<label class="md-header__button md-icon" title="Dark Mode" for="__palette_1" hidden>
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="m17.75 4.09-2.53 1.94.91 3.06-2.63-1.81-2.63 1.81.91-3.06-2.53-1.94L12.44 4l1.06-3 1.06 3 3.19.09m3.5 6.91-1.64 1.25.59 1.98-1.7-1.17-1.7 1.17.59-1.98L15.75 11l2.06-.05L18.5 9l.69 1.95 2.06.05m-2.28 4.95c.83-.08 1.72 1.1 1.19 1.85-.32.45-.66.87-1.08 1.27C15.17 23 8.84 23 4.94 19.07c-3.91-3.9-3.91-10.24 0-14.14.4-.4.82-.76 1.27-1.08.75-.53 1.93.36 1.85 1.19-.27 2.86.69 5.83 2.89 8.02a9.96 9.96 0 0 0 8.02 2.89m-1.64 2.02a12.08 12.08 0 0 1-7.8-3.47c-2.17-2.19-3.33-5-3.49-7.82-2.81 3.14-2.7 7.96.31 10.98 3.02 3.01 7.84 3.12 10.98.31Z"/></svg>
</label>
<input class="md-option" data-md-color-media="(prefers-color-scheme: dark)" data-md-color-scheme="slate" data-md-color-primary="indigo" data-md-color-accent="blue" aria-label="Light Mode" type="radio" name="__palette" id="__palette_1">
<label class="md-header__button md-icon" title="Light Mode" for="__palette_0" hidden>
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 7a5 5 0 0 1 5 5 5 5 0 0 1-5 5 5 5 0 0 1-5-5 5 5 0 0 1 5-5m0 2a3 3 0 0 0-3 3 3 3 0 0 0 3 3 3 3 0 0 0 3-3 3 3 0 0 0-3-3m0-7 2.39 3.42C13.65 5.15 12.84 5 12 5c-.84 0-1.65.15-2.39.42L12 2M3.34 7l4.16-.35A7.2 7.2 0 0 0 5.94 8.5c-.44.74-.69 1.5-.83 2.29L3.34 7m.02 10 1.76-3.77a7.131 7.131 0 0 0 2.38 4.14L3.36 17M20.65 7l-1.77 3.79a7.023 7.023 0 0 0-2.38-4.15l4.15.36m-.01 10-4.14.36c.59-.51 1.12-1.14 1.54-1.86.42-.73.69-1.5.83-2.29L20.64 17M12 22l-2.41-3.44c.74.27 1.55.44 2.41.44.82 0 1.63-.17 2.37-.44L12 22Z"/></svg>
</label>
</form>
<script>var media,input,key,value,palette=__md_get("__palette");if(palette&&palette.color){"(prefers-color-scheme)"===palette.color.media&&(media=matchMedia("(prefers-color-scheme: light)"),input=document.querySelector(media.matches?"[data-md-color-media='(prefers-color-scheme: light)']":"[data-md-color-media='(prefers-color-scheme: dark)']"),palette.color.media=input.getAttribute("data-md-color-media"),palette.color.scheme=input.getAttribute("data-md-color-scheme"),palette.color.primary=input.getAttribute("data-md-color-primary"),palette.color.accent=input.getAttribute("data-md-color-accent"));for([key,value]of Object.entries(palette.color))document.body.setAttribute("data-md-color-"+key,value)}</script>
<label class="md-header__button md-icon" for="__search">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.516 6.516 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5Z"/></svg>
</label>
<div class="md-search" data-md-component="search" role="dialog">
<label class="md-search__overlay" for="__search"></label>
<div class="md-search__inner" role="search">
<form class="md-search__form" name="search">
<input type="text" class="md-search__input" name="query" aria-label="Search" placeholder="Search" autocapitalize="off" autocorrect="off" autocomplete="off" spellcheck="false" data-md-component="search-query" required>
<label class="md-search__icon md-icon" for="__search">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.516 6.516 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5Z"/></svg>
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11h12Z"/></svg>
</label>
<nav class="md-search__options" aria-label="Search">
<button type="reset" class="md-search__icon md-icon" title="Clear" aria-label="Clear" tabindex="-1">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M19 6.41 17.59 5 12 10.59 6.41 5 5 6.41 10.59 12 5 17.59 6.41 19 12 13.41 17.59 19 19 17.59 13.41 12 19 6.41Z"/></svg>
</button>
</nav>
</form>
<div class="md-search__output">
<div class="md-search__scrollwrap" tabindex="0" data-md-scrollfix>
<div class="md-search-result" data-md-component="search-result">
<div class="md-search-result__meta">
Initializing search
</div>
<ol class="md-search-result__list" role="presentation"></ol>
</div>
</div>
</div>
</div>
</div>
<div class="md-header__source">
<a href="https://git.auxolotl.org/auxolotl/docs" title="Go to repository" class="md-source" data-md-component="source">
<div class="md-source__icon md-icon">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M16.777 0a2.9 2.9 0 1 1-2.529 4.322H12.91a4.266 4.266 0 0 0-4.265 4.195v2.118a7.076 7.076 0 0 1 4.147-1.42l.118-.002h1.338a2.9 2.9 0 0 1 5.43 1.422 2.9 2.9 0 0 1-5.43 1.422H12.91a4.266 4.266 0 0 0-4.265 4.195v2.319A2.9 2.9 0 0 1 7.222 24 2.9 2.9 0 0 1 5.8 18.57V8.589a7.109 7.109 0 0 1 6.991-7.108l.118-.001h1.338A2.9 2.9 0 0 1 16.778 0ZM7.223 19.905a1.194 1.194 0 1 0 0 2.389 1.194 1.194 0 0 0 0-2.389Zm9.554-10.464a1.194 1.194 0 1 0 0 2.389 1.194 1.194 0 0 0 0-2.39Zm0-7.735a1.194 1.194 0 1 0 0 2.389 1.194 1.194 0 0 0 0-2.389Z"/></svg>
</div>
<div class="md-source__repository">
auxolotl/docs
</div>
</a>
</div>
</nav>
</header>
<div class="md-container" data-md-component="container">
<nav class="md-tabs" aria-label="Tabs" data-md-component="tabs">
<div class="md-grid">
<ul class="md-tabs__list">
<li class="md-tabs__item">
<a href="../../.." class="md-tabs__link">
Aux Documentation Hub
</a>
</li>
<li class="md-tabs__item">
<a href="../../../TODO/" class="md-tabs__link">
TODO
</a>
</li>
<li class="md-tabs__item">
<a href="../../../Aux/" class="md-tabs__link">
Aux
</a>
</li>
<li class="md-tabs__item">
<a href="../../../Lix/" class="md-tabs__link">
Lix
</a>
</li>
<li class="md-tabs__item">
<a href="../../../NixOS/appstream/" class="md-tabs__link">
NixOS
</a>
</li>
<li class="md-tabs__item md-tabs__item--active">
<a href="../../" class="md-tabs__link">
Nixpkgs
</a>
</li>
</ul>
</div>
</nav>
<main class="md-main" data-md-component="main">
<div class="md-main__inner md-grid">
<div class="md-sidebar md-sidebar--primary" data-md-component="sidebar" data-md-type="navigation" >
<div class="md-sidebar__scrollwrap">
<div class="md-sidebar__inner">
<nav class="md-nav md-nav--primary md-nav--lifted" aria-label="Navigation" data-md-level="0">
<label class="md-nav__title" for="__drawer">
<a href="../../.." title="Aux Docs" class="md-nav__button md-logo" aria-label="Aux Docs" data-md-component="logo">
<img src="../../../assets/aux-logo.svg" alt="logo">
</a>
Aux Docs
</label>
<div class="md-nav__source">
<a href="https://git.auxolotl.org/auxolotl/docs" title="Go to repository" class="md-source" data-md-component="source">
<div class="md-source__icon md-icon">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M16.777 0a2.9 2.9 0 1 1-2.529 4.322H12.91a4.266 4.266 0 0 0-4.265 4.195v2.118a7.076 7.076 0 0 1 4.147-1.42l.118-.002h1.338a2.9 2.9 0 0 1 5.43 1.422 2.9 2.9 0 0 1-5.43 1.422H12.91a4.266 4.266 0 0 0-4.265 4.195v2.319A2.9 2.9 0 0 1 7.222 24 2.9 2.9 0 0 1 5.8 18.57V8.589a7.109 7.109 0 0 1 6.991-7.108l.118-.001h1.338A2.9 2.9 0 0 1 16.778 0ZM7.223 19.905a1.194 1.194 0 1 0 0 2.389 1.194 1.194 0 0 0 0-2.389Zm9.554-10.464a1.194 1.194 0 1 0 0 2.389 1.194 1.194 0 0 0 0-2.39Zm0-7.735a1.194 1.194 0 1 0 0 2.389 1.194 1.194 0 0 0 0-2.389Z"/></svg>
</div>
<div class="md-source__repository">
auxolotl/docs
</div>
</a>
</div>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../../.." class="md-nav__link">
<span class="md-ellipsis">
Aux Documentation Hub
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../../TODO/" class="md-nav__link">
<span class="md-ellipsis">
TODO
</span>
</a>
</li>
<li class="md-nav__item md-nav__item--pruned md-nav__item--nested">
<a href="../../../Aux/" class="md-nav__link">
<span class="md-ellipsis">
Aux
</span>
<span class="md-nav__icon md-icon"></span>
</a>
</li>
<li class="md-nav__item md-nav__item--pruned md-nav__item--nested">
<a href="../../../Lix/" class="md-nav__link">
<span class="md-ellipsis">
Lix
</span>
<span class="md-nav__icon md-icon"></span>
</a>
</li>
<li class="md-nav__item md-nav__item--pruned md-nav__item--nested">
<a href="../../../NixOS/appstream/" class="md-nav__link">
<span class="md-ellipsis">
NixOS
</span>
<span class="md-nav__icon md-icon"></span>
</a>
</li>
<li class="md-nav__item md-nav__item--active md-nav__item--section md-nav__item--nested">
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_6" checked>
<div class="md-nav__link md-nav__container">
<a href="../../" class="md-nav__link ">
<span class="md-ellipsis">
Nixpkgs
</span>
</a>
<label class="md-nav__link " for="__nav_6" id="__nav_6_label" tabindex="">
<span class="md-nav__icon md-icon"></span>
</label>
</div>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_6_label" aria-expanded="true">
<label class="md-nav__title" for="__nav_6">
<span class="md-nav__icon md-icon"></span>
Nixpkgs
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../../options/" class="md-nav__link">
<span class="md-ellipsis">
Options
</span>
</a>
</li>
<li class="md-nav__item md-nav__item--pruned md-nav__item--nested">
<a href="../../Build-Helpers/" class="md-nav__link">
<span class="md-ellipsis">
Build Helpers
</span>
<span class="md-nav__icon md-icon"></span>
</a>
</li>
<li class="md-nav__item md-nav__item--pruned md-nav__item--nested">
<a href="../../Development/" class="md-nav__link">
<span class="md-ellipsis">
Development
</span>
<span class="md-nav__icon md-icon"></span>
</a>
</li>
<li class="md-nav__item md-nav__item--pruned md-nav__item--nested">
<a href="../../Functions/" class="md-nav__link">
<span class="md-ellipsis">
Functions
</span>
<span class="md-nav__icon md-icon"></span>
</a>
</li>
<li class="md-nav__item md-nav__item--pruned md-nav__item--nested">
<a href="../../Hooks/" class="md-nav__link">
<span class="md-ellipsis">
Hooks
</span>
<span class="md-nav__icon md-icon"></span>
</a>
</li>
<li class="md-nav__item md-nav__item--pruned md-nav__item--nested">
<a href="../../Languages-And-Frameworks/" class="md-nav__link">
<span class="md-ellipsis">
Languages And Frameworks
</span>
<span class="md-nav__icon md-icon"></span>
</a>
</li>
<li class="md-nav__item md-nav__item--active md-nav__item--nested">
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_6_8" checked>
<label class="md-nav__link" for="__nav_6_8" id="__nav_6_8_label" tabindex="0">
<span class="md-ellipsis">
Library Reference
</span>
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="2" aria-labelledby="__nav_6_8_label" aria-expanded="true">
<label class="md-nav__title" for="__nav_6_8">
<span class="md-nav__icon md-icon"></span>
Library Reference
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../asserts/" class="md-nav__link">
<span class="md-ellipsis">
lib.asserts: assertion functions
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../attrsets/" class="md-nav__link">
<span class="md-ellipsis">
lib.attrsets: attribute set functions
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../cli/" class="md-nav__link">
<span class="md-ellipsis">
lib.cli: command-line serialization functions
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../customisation/" class="md-nav__link">
<span class="md-ellipsis">
lib.customisation: Functions to customise (derivation-related) functions, derivatons, or attribute sets
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../debug/" class="md-nav__link">
<span class="md-ellipsis">
lib.debug: debugging functions
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../derivations/" class="md-nav__link">
<span class="md-ellipsis">
lib.derivations: miscellaneous derivation-specific functions
</span>
</a>
</li>
<li class="md-nav__item md-nav__item--active">
<input class="md-nav__toggle md-toggle" type="checkbox" id="__toc">
<label class="md-nav__link md-nav__link--active" for="__toc">
<span class="md-ellipsis">
lib.fileset: file set functions
</span>
<span class="md-nav__icon md-icon"></span>
</label>
<a href="./" class="md-nav__link md-nav__link--active">
<span class="md-ellipsis">
lib.fileset: file set functions
</span>
</a>
<nav class="md-nav md-nav--secondary" aria-label="Table of contents">
<label class="md-nav__title" for="__toc">
<span class="md-nav__icon md-icon"></span>
Table of contents
</label>
<ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
<li class="md-nav__item">
<a href="#sec-fileset-overview" class="md-nav__link">
<span class="md-ellipsis">
Overview
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#sec-fileset-path-coercion" class="md-nav__link">
<span class="md-ellipsis">
Implicit coercion from paths to file sets
</span>
</a>
<nav class="md-nav" aria-label="Implicit coercion from paths to file sets">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#sec-fileset-path-coercion-example" class="md-nav__link">
<span class="md-ellipsis">
Example
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#function-library-lib.fileset.maybeMissing" class="md-nav__link">
<span class="md-ellipsis">
lib.fileset.maybeMissing
</span>
</a>
<nav class="md-nav" aria-label="lib.fileset.maybeMissing">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#inputs" class="md-nav__link">
<span class="md-ellipsis">
Inputs
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#type" class="md-nav__link">
<span class="md-ellipsis">
Type
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#examples" class="md-nav__link">
<span class="md-ellipsis">
Examples
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#function-library-lib.fileset.trace" class="md-nav__link">
<span class="md-ellipsis">
lib.fileset.trace
</span>
</a>
<nav class="md-nav" aria-label="lib.fileset.trace">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#inputs_1" class="md-nav__link">
<span class="md-ellipsis">
Inputs
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#type_1" class="md-nav__link">
<span class="md-ellipsis">
Type
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#examples_1" class="md-nav__link">
<span class="md-ellipsis">
Examples
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#function-library-lib.fileset.traceVal" class="md-nav__link">
<span class="md-ellipsis">
lib.fileset.traceVal
</span>
</a>
<nav class="md-nav" aria-label="lib.fileset.traceVal">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#inputs_2" class="md-nav__link">
<span class="md-ellipsis">
Inputs
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#type_2" class="md-nav__link">
<span class="md-ellipsis">
Type
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#examples_2" class="md-nav__link">
<span class="md-ellipsis">
Examples
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#function-library-lib.fileset.toSource" class="md-nav__link">
<span class="md-ellipsis">
lib.fileset.toSource
</span>
</a>
<nav class="md-nav" aria-label="lib.fileset.toSource">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#inputs_3" class="md-nav__link">
<span class="md-ellipsis">
Inputs
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#type_3" class="md-nav__link">
<span class="md-ellipsis">
Type
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#examples_3" class="md-nav__link">
<span class="md-ellipsis">
Examples
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#function-library-lib.fileset.toList" class="md-nav__link">
<span class="md-ellipsis">
lib.fileset.toList
</span>
</a>
<nav class="md-nav" aria-label="lib.fileset.toList">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#inputs_4" class="md-nav__link">
<span class="md-ellipsis">
Inputs
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#type_4" class="md-nav__link">
<span class="md-ellipsis">
Type
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#examples_4" class="md-nav__link">
<span class="md-ellipsis">
Examples
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#function-library-lib.fileset.union" class="md-nav__link">
<span class="md-ellipsis">
lib.fileset.union
</span>
</a>
<nav class="md-nav" aria-label="lib.fileset.union">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#inputs_5" class="md-nav__link">
<span class="md-ellipsis">
Inputs
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#type_5" class="md-nav__link">
<span class="md-ellipsis">
Type
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#examples_5" class="md-nav__link">
<span class="md-ellipsis">
Examples
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#function-library-lib.fileset.unions" class="md-nav__link">
<span class="md-ellipsis">
lib.fileset.unions
</span>
</a>
<nav class="md-nav" aria-label="lib.fileset.unions">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#inputs_6" class="md-nav__link">
<span class="md-ellipsis">
Inputs
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#type_6" class="md-nav__link">
<span class="md-ellipsis">
Type
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#examples_6" class="md-nav__link">
<span class="md-ellipsis">
Examples
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#function-library-lib.fileset.intersection" class="md-nav__link">
<span class="md-ellipsis">
lib.fileset.intersection
</span>
</a>
<nav class="md-nav" aria-label="lib.fileset.intersection">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#inputs_7" class="md-nav__link">
<span class="md-ellipsis">
Inputs
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#type_7" class="md-nav__link">
<span class="md-ellipsis">
Type
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#examples_7" class="md-nav__link">
<span class="md-ellipsis">
Examples
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#function-library-lib.fileset.difference" class="md-nav__link">
<span class="md-ellipsis">
lib.fileset.difference
</span>
</a>
<nav class="md-nav" aria-label="lib.fileset.difference">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#inputs_8" class="md-nav__link">
<span class="md-ellipsis">
Inputs
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#type_8" class="md-nav__link">
<span class="md-ellipsis">
Type
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#examples_8" class="md-nav__link">
<span class="md-ellipsis">
Examples
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#function-library-lib.fileset.fileFilter" class="md-nav__link">
<span class="md-ellipsis">
lib.fileset.fileFilter
</span>
</a>
<nav class="md-nav" aria-label="lib.fileset.fileFilter">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#inputs_9" class="md-nav__link">
<span class="md-ellipsis">
Inputs
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#type_9" class="md-nav__link">
<span class="md-ellipsis">
Type
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#examples_9" class="md-nav__link">
<span class="md-ellipsis">
Examples
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#function-library-lib.fileset.fromSource" class="md-nav__link">
<span class="md-ellipsis">
lib.fileset.fromSource
</span>
</a>
<nav class="md-nav" aria-label="lib.fileset.fromSource">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#inputs_10" class="md-nav__link">
<span class="md-ellipsis">
Inputs
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#type_10" class="md-nav__link">
<span class="md-ellipsis">
Type
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#examples_10" class="md-nav__link">
<span class="md-ellipsis">
Examples
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#function-library-lib.fileset.gitTracked" class="md-nav__link">
<span class="md-ellipsis">
lib.fileset.gitTracked
</span>
</a>
<nav class="md-nav" aria-label="lib.fileset.gitTracked">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#inputs_11" class="md-nav__link">
<span class="md-ellipsis">
Inputs
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#type_11" class="md-nav__link">
<span class="md-ellipsis">
Type
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#examples_11" class="md-nav__link">
<span class="md-ellipsis">
Examples
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#function-library-lib.fileset.gitTrackedWith" class="md-nav__link">
<span class="md-ellipsis">
lib.fileset.gitTrackedWith
</span>
</a>
<nav class="md-nav" aria-label="lib.fileset.gitTrackedWith">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#inputs_12" class="md-nav__link">
<span class="md-ellipsis">
Inputs
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#type_12" class="md-nav__link">
<span class="md-ellipsis">
Type
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#examples_12" class="md-nav__link">
<span class="md-ellipsis">
Examples
</span>
</a>
</li>
</ul>
</nav>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="../filesystem/" class="md-nav__link">
<span class="md-ellipsis">
lib.filesystem: filesystem functions
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../fixedPoints/" class="md-nav__link">
<span class="md-ellipsis">
lib.fixedPoints: explicit recursion functions
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../generators/" class="md-nav__link">
<span class="md-ellipsis">
lib.generators: functions that create file formats from nix data structures
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../gvariant/" class="md-nav__link">
<span class="md-ellipsis">
lib.gvariant: GVariant formatted string serialization functions
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../lists/" class="md-nav__link">
<span class="md-ellipsis">
lib.lists: list manipulation functions
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../meta/" class="md-nav__link">
<span class="md-ellipsis">
lib.meta: functions for derivation metadata
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../options/" class="md-nav__link">
<span class="md-ellipsis">
lib.options: NixOS / nixpkgs option handling
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../path/" class="md-nav__link">
<span class="md-ellipsis">
lib.path: path functions
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../sources/" class="md-nav__link">
<span class="md-ellipsis">
lib.sources: source filtering functions
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../strings/" class="md-nav__link">
<span class="md-ellipsis">
lib.strings: string manipulation functions
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../trivial/" class="md-nav__link">
<span class="md-ellipsis">
lib.trivial: miscellaneous functions
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../versions/" class="md-nav__link">
<span class="md-ellipsis">
lib.versions: version string functions
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item md-nav__item--pruned md-nav__item--nested">
<a href="../../Module-System/module-system.chapter/" class="md-nav__link">
<span class="md-ellipsis">
Module System
</span>
<span class="md-nav__icon md-icon"></span>
</a>
</li>
<li class="md-nav__item md-nav__item--pruned md-nav__item--nested">
<a href="../../Packages/" class="md-nav__link">
<span class="md-ellipsis">
Packages
</span>
<span class="md-nav__icon md-icon"></span>
</a>
</li>
<li class="md-nav__item md-nav__item--pruned md-nav__item--nested">
<a href="../../Standard-Environment/" class="md-nav__link">
<span class="md-ellipsis">
Standard Environment
</span>
<span class="md-nav__icon md-icon"></span>
</a>
</li>
<li class="md-nav__item md-nav__item--pruned md-nav__item--nested">
<a href="../../Using-Nixpkgs/" class="md-nav__link">
<span class="md-ellipsis">
Using Nixpkgs
</span>
<span class="md-nav__icon md-icon"></span>
</a>
</li>
</ul>
</nav>
</li>
</ul>
</nav>
</div>
</div>
</div>
<div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" >
<div class="md-sidebar__scrollwrap">
<div class="md-sidebar__inner">
<nav class="md-nav md-nav--secondary" aria-label="Table of contents">
<label class="md-nav__title" for="__toc">
<span class="md-nav__icon md-icon"></span>
Table of contents
</label>
<ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
<li class="md-nav__item">
<a href="#sec-fileset-overview" class="md-nav__link">
<span class="md-ellipsis">
Overview
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#sec-fileset-path-coercion" class="md-nav__link">
<span class="md-ellipsis">
Implicit coercion from paths to file sets
</span>
</a>
<nav class="md-nav" aria-label="Implicit coercion from paths to file sets">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#sec-fileset-path-coercion-example" class="md-nav__link">
<span class="md-ellipsis">
Example
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#function-library-lib.fileset.maybeMissing" class="md-nav__link">
<span class="md-ellipsis">
lib.fileset.maybeMissing
</span>
</a>
<nav class="md-nav" aria-label="lib.fileset.maybeMissing">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#inputs" class="md-nav__link">
<span class="md-ellipsis">
Inputs
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#type" class="md-nav__link">
<span class="md-ellipsis">
Type
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#examples" class="md-nav__link">
<span class="md-ellipsis">
Examples
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#function-library-lib.fileset.trace" class="md-nav__link">
<span class="md-ellipsis">
lib.fileset.trace
</span>
</a>
<nav class="md-nav" aria-label="lib.fileset.trace">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#inputs_1" class="md-nav__link">
<span class="md-ellipsis">
Inputs
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#type_1" class="md-nav__link">
<span class="md-ellipsis">
Type
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#examples_1" class="md-nav__link">
<span class="md-ellipsis">
Examples
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#function-library-lib.fileset.traceVal" class="md-nav__link">
<span class="md-ellipsis">
lib.fileset.traceVal
</span>
</a>
<nav class="md-nav" aria-label="lib.fileset.traceVal">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#inputs_2" class="md-nav__link">
<span class="md-ellipsis">
Inputs
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#type_2" class="md-nav__link">
<span class="md-ellipsis">
Type
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#examples_2" class="md-nav__link">
<span class="md-ellipsis">
Examples
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#function-library-lib.fileset.toSource" class="md-nav__link">
<span class="md-ellipsis">
lib.fileset.toSource
</span>
</a>
<nav class="md-nav" aria-label="lib.fileset.toSource">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#inputs_3" class="md-nav__link">
<span class="md-ellipsis">
Inputs
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#type_3" class="md-nav__link">
<span class="md-ellipsis">
Type
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#examples_3" class="md-nav__link">
<span class="md-ellipsis">
Examples
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#function-library-lib.fileset.toList" class="md-nav__link">
<span class="md-ellipsis">
lib.fileset.toList
</span>
</a>
<nav class="md-nav" aria-label="lib.fileset.toList">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#inputs_4" class="md-nav__link">
<span class="md-ellipsis">
Inputs
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#type_4" class="md-nav__link">
<span class="md-ellipsis">
Type
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#examples_4" class="md-nav__link">
<span class="md-ellipsis">
Examples
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#function-library-lib.fileset.union" class="md-nav__link">
<span class="md-ellipsis">
lib.fileset.union
</span>
</a>
<nav class="md-nav" aria-label="lib.fileset.union">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#inputs_5" class="md-nav__link">
<span class="md-ellipsis">
Inputs
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#type_5" class="md-nav__link">
<span class="md-ellipsis">
Type
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#examples_5" class="md-nav__link">
<span class="md-ellipsis">
Examples
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#function-library-lib.fileset.unions" class="md-nav__link">
<span class="md-ellipsis">
lib.fileset.unions
</span>
</a>
<nav class="md-nav" aria-label="lib.fileset.unions">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#inputs_6" class="md-nav__link">
<span class="md-ellipsis">
Inputs
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#type_6" class="md-nav__link">
<span class="md-ellipsis">
Type
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#examples_6" class="md-nav__link">
<span class="md-ellipsis">
Examples
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#function-library-lib.fileset.intersection" class="md-nav__link">
<span class="md-ellipsis">
lib.fileset.intersection
</span>
</a>
<nav class="md-nav" aria-label="lib.fileset.intersection">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#inputs_7" class="md-nav__link">
<span class="md-ellipsis">
Inputs
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#type_7" class="md-nav__link">
<span class="md-ellipsis">
Type
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#examples_7" class="md-nav__link">
<span class="md-ellipsis">
Examples
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#function-library-lib.fileset.difference" class="md-nav__link">
<span class="md-ellipsis">
lib.fileset.difference
</span>
</a>
<nav class="md-nav" aria-label="lib.fileset.difference">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#inputs_8" class="md-nav__link">
<span class="md-ellipsis">
Inputs
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#type_8" class="md-nav__link">
<span class="md-ellipsis">
Type
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#examples_8" class="md-nav__link">
<span class="md-ellipsis">
Examples
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#function-library-lib.fileset.fileFilter" class="md-nav__link">
<span class="md-ellipsis">
lib.fileset.fileFilter
</span>
</a>
<nav class="md-nav" aria-label="lib.fileset.fileFilter">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#inputs_9" class="md-nav__link">
<span class="md-ellipsis">
Inputs
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#type_9" class="md-nav__link">
<span class="md-ellipsis">
Type
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#examples_9" class="md-nav__link">
<span class="md-ellipsis">
Examples
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#function-library-lib.fileset.fromSource" class="md-nav__link">
<span class="md-ellipsis">
lib.fileset.fromSource
</span>
</a>
<nav class="md-nav" aria-label="lib.fileset.fromSource">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#inputs_10" class="md-nav__link">
<span class="md-ellipsis">
Inputs
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#type_10" class="md-nav__link">
<span class="md-ellipsis">
Type
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#examples_10" class="md-nav__link">
<span class="md-ellipsis">
Examples
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#function-library-lib.fileset.gitTracked" class="md-nav__link">
<span class="md-ellipsis">
lib.fileset.gitTracked
</span>
</a>
<nav class="md-nav" aria-label="lib.fileset.gitTracked">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#inputs_11" class="md-nav__link">
<span class="md-ellipsis">
Inputs
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#type_11" class="md-nav__link">
<span class="md-ellipsis">
Type
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#examples_11" class="md-nav__link">
<span class="md-ellipsis">
Examples
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#function-library-lib.fileset.gitTrackedWith" class="md-nav__link">
<span class="md-ellipsis">
lib.fileset.gitTrackedWith
</span>
</a>
<nav class="md-nav" aria-label="lib.fileset.gitTrackedWith">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#inputs_12" class="md-nav__link">
<span class="md-ellipsis">
Inputs
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#type_12" class="md-nav__link">
<span class="md-ellipsis">
Type
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#examples_12" class="md-nav__link">
<span class="md-ellipsis">
Examples
</span>
</a>
</li>
</ul>
</nav>
</li>
</ul>
</nav>
</div>
</div>
</div>
<div class="md-content" data-md-component="content">
<article class="md-content__inner md-typeset">
<h1 id="sec-functions-library-fileset">lib.fileset: file set functions</h1>
<!-- This anchor is here for backwards compatibility -->
<p>[]{#sec-fileset}</p>
<p>The <a href="#sec-functions-library-fileset"><code>lib.fileset</code></a> library allows you to work with <em>file sets</em>.
A file set is a (mathematical) set of local files that can be added to the Nix store for use in Nix derivations.
File sets are easy and safe to use, providing obvious and composable semantics with good error messages to prevent mistakes.</p>
<h2 id="sec-fileset-overview">Overview</h2>
<p>Basics:
- <a href="#sec-fileset-path-coercion">Implicit coercion from paths to file sets</a></p>
<ul>
<li><a href="#function-library-lib.fileset.maybeMissing"><code>lib.fileset.maybeMissing</code></a>:</li>
</ul>
<p>Create a file set from a path that may be missing.</p>
<ul>
<li><a href="#function-library-lib.fileset.trace"><code>lib.fileset.trace</code></a>/<a href="#function-library-lib.fileset.trace"><code>lib.fileset.traceVal</code></a>:</li>
</ul>
<p>Pretty-print file sets for debugging.</p>
<ul>
<li><a href="#function-library-lib.fileset.toSource"><code>lib.fileset.toSource</code></a>:</li>
</ul>
<p>Add files in file sets to the store to use as derivation sources.</p>
<ul>
<li><a href="#function-library-lib.fileset.toList"><code>lib.fileset.toList</code></a>:</li>
</ul>
<p>The list of files contained in a file set.</p>
<p>Combinators:
- <a href="#function-library-lib.fileset.union"><code>lib.fileset.union</code></a>/<a href="#function-library-lib.fileset.unions"><code>lib.fileset.unions</code></a>:</p>
<p>Create a larger file set from all the files in multiple file sets.</p>
<ul>
<li><a href="#function-library-lib.fileset.intersection"><code>lib.fileset.intersection</code></a>:</li>
</ul>
<p>Create a smaller file set from only the files in both file sets.</p>
<ul>
<li><a href="#function-library-lib.fileset.difference"><code>lib.fileset.difference</code></a>:</li>
</ul>
<p>Create a smaller file set containing all files that are in one file set, but not another one.</p>
<p>Filtering:
- <a href="#function-library-lib.fileset.fileFilter"><code>lib.fileset.fileFilter</code></a>:</p>
<p>Create a file set from all files that satisisfy a predicate in a directory.</p>
<p>Utilities:
- <a href="#function-library-lib.fileset.fromSource"><code>lib.fileset.fromSource</code></a>:</p>
<p>Create a file set from a <code>lib.sources</code>-based value.</p>
<ul>
<li><a href="#function-library-lib.fileset.gitTracked"><code>lib.fileset.gitTracked</code></a>/<a href="#function-library-lib.fileset.gitTrackedWith"><code>lib.fileset.gitTrackedWith</code></a>:</li>
</ul>
<p>Create a file set from all tracked files in a local Git repository.</p>
<p>If you need more file set functions,
see <a href="https://github.com/NixOS/nixpkgs/issues/266356">this issue</a> to request it.</p>
<h2 id="sec-fileset-path-coercion">Implicit coercion from paths to file sets</h2>
<p>All functions accepting file sets as arguments can also accept <a href="https://nixos.org/manual/nix/stable/language/values.html#type-path">paths</a> as arguments.
Such path arguments are implicitly coerced to file sets containing all files under that path:
- A path to a file turns into a file set containing that single file.
- A path to a directory turns into a file set containing all files <em>recursively</em> in that directory.</p>
<p>If the path points to a non-existent location, an error is thrown.</p>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>Just like in Git, file sets cannot represent empty directories.
Because of this, a path to a directory that contains no files (recursively) will turn into a file set containing no files.</p>
</div>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>File set coercion does <em>not</em> add any of the files under the coerced paths to the store.
Only the <a href="#function-library-lib.fileset.toSource"><code>toSource</code></a> function adds files to the Nix store, and only those files contained in the <code>fileset</code> argument.
This is in contrast to using <a href="https://nixos.org/manual/nix/stable/language/values.html#type-path">paths in string interpolation</a>, which does add the entire referenced path to the store.</p>
</div>
<h3 id="sec-fileset-path-coercion-example">Example</h3>
<p>Assume we are in a local directory with a file hierarchy like this:
<div class="highlight"><pre><span></span><code>├─ a/
│ ├─ x (file)
│ └─ b/
│   └─ y (file)
└─ c/
  └─ d/
</code></pre></div></p>
<p>Here's a listing of which files get included when different path expressions get coerced to file sets:
- <code>./.</code> as a file set contains both <code>a/x</code> and <code>a/b/y</code> (<code>c/</code> does not contain any files and is therefore omitted).
- <code>./a</code> as a file set contains both <code>a/x</code> and <code>a/b/y</code>.
- <code>./a/x</code> as a file set contains only <code>a/x</code>.
- <code>./a/b</code> as a file set contains only <code>a/b/y</code>.
- <code>./c</code> as a file set is empty, since neither <code>c</code> nor <code>c/d</code> contain any files.</p>
<h2 id="function-library-lib.fileset.maybeMissing"><code>lib.fileset.maybeMissing</code></h2>
<p>Create a file set from a path that may or may not exist:
- If the path does exist, the path is <a href="#sec-fileset-path-coercion">coerced to a file set</a>.
- If the path does not exist, a file set containing no files is returned.</p>
<h3 id="inputs">Inputs</h3>
<p><code>path</code></p>
<p>: 1. Function argument</p>
<h3 id="type">Type</h3>
<div class="highlight"><pre><span></span><code>maybeMissing :: Path -&gt; FileSet
</code></pre></div>
<h3 id="examples">Examples</h3>
<div class="admonition example">
<p class="admonition-title"><code>lib.fileset.maybeMissing</code> usage example</p>
<div class="highlight"><pre><span></span><code><span class="c1"># All files in the current directory, but excluding main.o if it exists</span>
difference <span class="l">./.</span> <span class="p">(</span>maybeMissing <span class="l">./main.o</span><span class="p">)</span>
</code></pre></div>
</div>
<p>Located at <a href="https://github.com/NixOS/nixpkgs/blob/master/lib/fileset/default.nix#L189">lib/fileset/default.nix:189</a> in <code>&lt;nixpkgs&gt;</code>.</p>
<h2 id="function-library-lib.fileset.trace"><code>lib.fileset.trace</code></h2>
<p>Incrementally evaluate and trace a file set in a pretty way.
This function is only intended for debugging purposes.
The exact tracing format is unspecified and may change.</p>
<p>This function takes a final argument to return.
In comparison, <a href="#function-library-lib.fileset.traceVal"><code>traceVal</code></a> returns
the given file set argument.</p>
<p>This variant is useful for tracing file sets in the Nix repl.</p>
<h3 id="inputs_1">Inputs</h3>
<p><code>fileset</code></p>
<p>: The file set to trace.</p>
<p>This argument can also be a path,
which gets <a href="#sec-fileset-path-coercion">implicitly coerced to a file set</a>.</p>
<p><code>val</code></p>
<p>: The value to return.</p>
<h3 id="type_1">Type</h3>
<div class="highlight"><pre><span></span><code>trace :: FileSet -&gt; Any -&gt; Any
</code></pre></div>
<h3 id="examples_1">Examples</h3>
<div class="admonition example">
<p class="admonition-title"><code>lib.fileset.trace</code> usage example</p>
<div class="highlight"><pre><span></span><code>trace <span class="p">(</span>unions <span class="p">[</span> <span class="l">./Makefile</span> <span class="l">./src</span> <span class="l">./tests/run.sh</span> <span class="p">])</span> <span class="no">null</span>
<span class="o">=&gt;</span>
trace<span class="p">:</span> <span class="l">/home/user/src/myProject</span>
trace<span class="p">:</span> <span class="o">-</span> Makefile <span class="p">(</span>regular<span class="p">)</span>
trace<span class="p">:</span> <span class="o">-</span> src <span class="p">(</span>all files <span class="k">in</span> directory<span class="p">)</span>
trace<span class="p">:</span> <span class="o">-</span> tests
trace<span class="p">:</span> <span class="o">-</span> run<span class="o">.</span>sh <span class="p">(</span>regular<span class="p">)</span>
<span class="no">null</span>
</code></pre></div>
</div>
<p>Located at <a href="https://github.com/NixOS/nixpkgs/blob/master/lib/fileset/default.nix#L251">lib/fileset/default.nix:251</a> in <code>&lt;nixpkgs&gt;</code>.</p>
<h2 id="function-library-lib.fileset.traceVal"><code>lib.fileset.traceVal</code></h2>
<p>Incrementally evaluate and trace a file set in a pretty way.
This function is only intended for debugging purposes.
The exact tracing format is unspecified and may change.</p>
<p>This function returns the given file set.
In comparison, <a href="#function-library-lib.fileset.trace"><code>trace</code></a> takes another argument to return.</p>
<p>This variant is useful for tracing file sets passed as arguments to other functions.</p>
<h3 id="inputs_2">Inputs</h3>
<p><code>fileset</code></p>
<p>: The file set to trace and return.</p>
<p>This argument can also be a path,
which gets <a href="#sec-fileset-path-coercion">implicitly coerced to a file set</a>.</p>
<h3 id="type_2">Type</h3>
<div class="highlight"><pre><span></span><code>traceVal :: FileSet -&gt; FileSet
</code></pre></div>
<h3 id="examples_2">Examples</h3>
<div class="admonition example">
<p class="admonition-title"><code>lib.fileset.traceVal</code> usage example</p>
<div class="highlight"><pre><span></span><code>toSource <span class="p">{</span>
<span class="ss">root</span> <span class="o">=</span> <span class="l">./.</span><span class="p">;</span>
<span class="ss">fileset</span> <span class="o">=</span> traceVal <span class="p">(</span>unions <span class="p">[</span>
<span class="l">./Makefile</span>
<span class="l">./src</span>
<span class="l">./tests/run.sh</span>
<span class="p">]);</span>
<span class="p">}</span>
<span class="o">=&gt;</span>
trace<span class="p">:</span> <span class="l">/home/user/src/myProject</span>
trace<span class="p">:</span> <span class="o">-</span> Makefile <span class="p">(</span>regular<span class="p">)</span>
trace<span class="p">:</span> <span class="o">-</span> src <span class="p">(</span>all files <span class="k">in</span> directory<span class="p">)</span>
trace<span class="p">:</span> <span class="o">-</span> tests
trace<span class="p">:</span> <span class="o">-</span> run<span class="o">.</span>sh <span class="p">(</span>regular<span class="p">)</span>
<span class="s2">&quot;/nix/store/...-source&quot;</span>
</code></pre></div>
</div>
<p>Located at <a href="https://github.com/NixOS/nixpkgs/blob/master/lib/fileset/default.nix#L311">lib/fileset/default.nix:311</a> in <code>&lt;nixpkgs&gt;</code>.</p>
<h2 id="function-library-lib.fileset.toSource"><code>lib.fileset.toSource</code></h2>
<p>Add the local files contained in <code>fileset</code> to the store as a single <a href="https://nixos.org/manual/nix/stable/glossary#gloss-store-path">store path</a> rooted at <code>root</code>.</p>
<p>The result is the store path as a string-like value, making it usable e.g. as the <code>src</code> of a derivation, or in string interpolation:
<div class="highlight"><pre><span></span><code>stdenv<span class="o">.</span>mkDerivation <span class="p">{</span>
<span class="ss">src</span> <span class="o">=</span> lib<span class="o">.</span>fileset<span class="o">.</span>toSource <span class="p">{</span> <span class="o">...</span> <span class="p">};</span>
<span class="c1"># ...</span>
<span class="p">}</span>
</code></pre></div></p>
<p>The name of the store path is always <code>source</code>.</p>
<h3 id="inputs_3">Inputs</h3>
<p>Takes an attribute set with the following attributes</p>
<p><code>root</code> (Path; <em>required</em>)</p>
<p>: The local directory <a href="https://nixos.org/manual/nix/stable/language/values.html#type-path">path</a> that will correspond to the root of the resulting store path.
Paths in <a href="https://nixos.org/manual/nix/stable/language/values.html#type-string">strings</a>, including Nix store paths, cannot be passed as <code>root</code>.
<code>root</code> has to be a directory.</p>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>Changing <code>root</code> only affects the directory structure of the resulting store path, it does not change which files are added to the store.
The only way to change which files get added to the store is by changing the <code>fileset</code> attribute.</p>
</div>
<p><code>fileset</code> (FileSet; <em>required</em>)</p>
<p>: The file set whose files to import into the store.
File sets can be created using other functions in this library.
This argument can also be a path,
which gets <a href="#sec-fileset-path-coercion">implicitly coerced to a file set</a>.</p>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>If a directory does not recursively contain any file, it is omitted from the store path contents.</p>
</div>
<h3 id="type_3">Type</h3>
<div class="highlight"><pre><span></span><code>toSource :: {
root :: Path,
fileset :: FileSet,
} -&gt; SourceLike
</code></pre></div>
<h3 id="examples_3">Examples</h3>
<div class="admonition example">
<p class="admonition-title"><code>lib.fileset.toSource</code> usage example</p>
<div class="highlight"><pre><span></span><code><span class="c1"># Import the current directory into the store</span>
<span class="c1"># but only include files under ./src</span>
toSource <span class="p">{</span>
<span class="ss">root</span> <span class="o">=</span> <span class="l">./.</span><span class="p">;</span>
<span class="ss">fileset</span> <span class="o">=</span> <span class="l">./src</span><span class="p">;</span>
<span class="p">}</span>
<span class="o">=&gt;</span> <span class="s2">&quot;/nix/store/...-source&quot;</span> <span class="s2">&quot;Import the current directory into the store</span>
<span class="s2"># but only include ./Makefile and all files under ./src</span>
<span class="s2">toSource {</span>
<span class="s2"> root = ./.;</span>
<span class="s2"> fileset = union</span>
<span class="s2"> ./Makefile</span>
<span class="s2"> ./src;</span>
<span class="s2">}</span>
<span class="s2">=&gt; &quot;</span><span class="l">/nix/store/...-source</span><span class="s2">&quot; &quot;</span>Trying to include a file outside the root will fail
toSource <span class="p">{</span>
<span class="ss">root</span> <span class="o">=</span> <span class="l">./.</span><span class="p">;</span>
<span class="ss">fileset</span> <span class="o">=</span> unions <span class="p">[</span>
<span class="l">./Makefile</span>
<span class="l">./src</span>
<span class="l">../LICENSE</span>
<span class="p">];</span>
<span class="p">}</span>
<span class="o">=&gt;</span> <span class="l">&lt;error&gt;</span> <span class="s2">&quot;The root needs to point to a directory that contains all the files</span>
<span class="s2">toSource {</span>
<span class="s2"> root = ../.;</span>
<span class="s2"> fileset = unions [</span>
<span class="s2"> ./Makefile</span>
<span class="s2"> ./src</span>
<span class="s2"> ../LICENSE</span>
<span class="s2"> ];</span>
<span class="s2">}</span>
<span class="s2">=&gt; &quot;</span><span class="l">/nix/store/...-source</span><span class="s2">&quot; &quot;</span>The root has to be a local filesystem path
toSource <span class="p">{</span>
<span class="ss">root</span> <span class="o">=</span> <span class="s2">&quot;/nix/store/...-source&quot;</span><span class="p">;</span>
<span class="ss">fileset</span> <span class="o">=</span> <span class="l">./.</span><span class="p">;</span>
<span class="p">}</span>
<span class="o">=&gt;</span> <span class="l">&lt;error&gt;</span>
</code></pre></div>
</div>
<p>Located at <a href="https://github.com/NixOS/nixpkgs/blob/master/lib/fileset/default.nix#L426">lib/fileset/default.nix:426</a> in <code>&lt;nixpkgs&gt;</code>.</p>
<h2 id="function-library-lib.fileset.toList"><code>lib.fileset.toList</code></h2>
<p>The list of file paths contained in the given file set.</p>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>This function is strict in the entire file set.
This is in contrast with combinators <a href="#function-library-lib.fileset.union"><code>lib.fileset.union</code></a>,
<a href="#function-library-lib.fileset.intersection"><code>lib.fileset.intersection</code></a> and <a href="#function-library-lib.fileset.difference"><code>lib.fileset.difference</code></a>.</p>
</div>
<p>Thus it is recommended to call <code>toList</code> on file sets created using the combinators,
instead of doing list processing on the result of <code>toList</code>.</p>
<p>The resulting list of files can be turned back into a file set using <a href="#function-library-lib.fileset.unions"><code>lib.fileset.unions</code></a>.</p>
<h3 id="inputs_4">Inputs</h3>
<p><code>fileset</code></p>
<p>: The file set whose file paths to return. This argument can also be a path, which gets <a href="#sec-fileset-path-coercion">implicitly coerced to a file set</a>.</p>
<h3 id="type_4">Type</h3>
<div class="highlight"><pre><span></span><code>toList :: FileSet -&gt; [ Path ]
</code></pre></div>
<h3 id="examples_4">Examples</h3>
<div class="admonition example">
<p class="admonition-title"><code>lib.fileset.toList</code> usage example</p>
<div class="highlight"><pre><span></span><code>toList <span class="l">./.</span>
<span class="p">[</span> <span class="l">./README.md</span> <span class="l">./Makefile</span> <span class="l">./src/main.c</span> <span class="l">./src/main.h</span> <span class="p">]</span>
toList <span class="p">(</span>difference <span class="l">./.</span> <span class="l">./src</span><span class="p">)</span>
<span class="p">[</span> <span class="l">./README.md</span> <span class="l">./Makefile</span> <span class="p">]</span>
</code></pre></div>
</div>
<p>Located at <a href="https://github.com/NixOS/nixpkgs/blob/master/lib/fileset/default.nix#L524">lib/fileset/default.nix:524</a> in <code>&lt;nixpkgs&gt;</code>.</p>
<h2 id="function-library-lib.fileset.union"><code>lib.fileset.union</code></h2>
<p>The file set containing all files that are in either of two given file sets.
This is the same as <a href="#function-library-lib.fileset.unions"><code>unions</code></a>,
but takes just two file sets instead of a list.
See also <a href="https://en.wikipedia.org/wiki/Union_(set_theory)">Union (set theory)</a>.</p>
<p>The given file sets are evaluated as lazily as possible,
with the first argument being evaluated first if needed.</p>
<h3 id="inputs_5">Inputs</h3>
<p><code>fileset1</code></p>
<p>: The first file set. This argument can also be a path, which gets <a href="#sec-fileset-path-coercion">implicitly coerced to a file set</a>.</p>
<p><code>fileset2</code></p>
<p>: The second file set. This argument can also be a path, which gets <a href="#sec-fileset-path-coercion">implicitly coerced to a file set</a>.</p>
<h3 id="type_5">Type</h3>
<div class="highlight"><pre><span></span><code>union :: FileSet -&gt; FileSet -&gt; FileSet
</code></pre></div>
<h3 id="examples_5">Examples</h3>
<div class="admonition example">
<p class="admonition-title"><code>lib.fileset.union</code> usage example</p>
<div class="highlight"><pre><span></span><code><span class="c1"># Create a file set containing the file `Makefile`</span>
<span class="c1"># and all files recursively in the `src` directory</span>
union <span class="l">./Makefile</span> <span class="l">./src</span> <span class="s2">&quot;Create a file set containing the file `Makefile`</span>
<span class="s2"># and the LICENSE file from the parent directory</span>
<span class="s2">union ./Makefile ../LICENSE</span>
</code></pre></div>
</div>
<p>Located at <a href="https://github.com/NixOS/nixpkgs/blob/master/lib/fileset/default.nix#L569">lib/fileset/default.nix:569</a> in <code>&lt;nixpkgs&gt;</code>.</p>
<h2 id="function-library-lib.fileset.unions"><code>lib.fileset.unions</code></h2>
<p>The file set containing all files that are in any of the given file sets.
This is the same as <a href="#function-library-lib.fileset.unions"><code>union</code></a>,
but takes a list of file sets instead of just two.
See also <a href="https://en.wikipedia.org/wiki/Union_(set_theory)">Union (set theory)</a>.</p>
<p>The given file sets are evaluated as lazily as possible,
with earlier elements being evaluated first if needed.</p>
<h3 id="inputs_6">Inputs</h3>
<p><code>filesets</code></p>
<p>: A list of file sets. The elements can also be paths, which get <a href="#sec-fileset-path-coercion">implicitly coerced to file sets</a>.</p>
<h3 id="type_6">Type</h3>
<div class="highlight"><pre><span></span><code>unions :: [ FileSet ] -&gt; FileSet
</code></pre></div>
<h3 id="examples_6">Examples</h3>
<div class="admonition example">
<p class="admonition-title"><code>lib.fileset.unions</code> usage example</p>
<div class="highlight"><pre><span></span><code><span class="c1"># Create a file set containing selected files</span>
unions <span class="p">[</span>
<span class="c1"># Include the single file `Makefile` in the current directory</span>
<span class="c1"># This errors if the file doesn&#39;t exist</span>
<span class="l">./Makefile</span>
<span class="c1"># Recursively include all files in the `src/code` directory</span>
<span class="c1"># If this directory is empty this has no effect</span>
<span class="l">./src/code</span>
<span class="c1"># Include the files `run.sh` and `unit.c` from the `tests` directory</span>
<span class="l">./tests/run.sh</span>
<span class="l">./tests/unit.c</span>
<span class="c1"># Include the `LICENSE` file from the parent directory</span>
<span class="l">../LICENSE</span>
<span class="p">]</span>
</code></pre></div>
</div>
<p>Located at <a href="https://github.com/NixOS/nixpkgs/blob/master/lib/fileset/default.nix#L632">lib/fileset/default.nix:632</a> in <code>&lt;nixpkgs&gt;</code>.</p>
<h2 id="function-library-lib.fileset.intersection"><code>lib.fileset.intersection</code></h2>
<p>The file set containing all files that are in both of two given file sets.
See also <a href="https://en.wikipedia.org/wiki/Intersection_(set_theory)">Intersection (set theory)</a>.</p>
<p>The given file sets are evaluated as lazily as possible,
with the first argument being evaluated first if needed.</p>
<h3 id="inputs_7">Inputs</h3>
<p><code>fileset1</code></p>
<p>: The first file set. This argument can also be a path, which gets <a href="#sec-fileset-path-coercion">implicitly coerced to a file set</a>.</p>
<p><code>fileset2</code></p>
<p>: The second file set. This argument can also be a path, which gets <a href="#sec-fileset-path-coercion">implicitly coerced to a file set</a>.</p>
<h3 id="type_7">Type</h3>
<div class="highlight"><pre><span></span><code>intersection :: FileSet -&gt; FileSet -&gt; FileSet
</code></pre></div>
<h3 id="examples_7">Examples</h3>
<div class="admonition example">
<p class="admonition-title"><code>lib.fileset.intersection</code> usage example</p>
<div class="highlight"><pre><span></span><code><span class="c1"># Limit the selected files to the ones in ./., so only ./src and ./Makefile</span>
intersection <span class="l">./.</span> <span class="p">(</span>unions <span class="p">[</span> <span class="l">../LICENSE</span> <span class="l">./src</span> <span class="l">./Makefile</span> <span class="p">])</span>
</code></pre></div>
</div>
<p>Located at <a href="https://github.com/NixOS/nixpkgs/blob/master/lib/fileset/default.nix#L683">lib/fileset/default.nix:683</a> in <code>&lt;nixpkgs&gt;</code>.</p>
<h2 id="function-library-lib.fileset.difference"><code>lib.fileset.difference</code></h2>
<p>The file set containing all files from the first file set that are not in the second file set.
See also <a href="https://en.wikipedia.org/wiki/Complement_(set_theory)#Relative_complement">Difference (set theory)</a>.</p>
<p>The given file sets are evaluated as lazily as possible,
with the first argument being evaluated first if needed.</p>
<h3 id="inputs_8">Inputs</h3>
<p><code>positive</code></p>
<p>: The positive file set. The result can only contain files that are also in this file set. This argument can also be a path, which gets <a href="#sec-fileset-path-coercion">implicitly coerced to a file set</a>.</p>
<p><code>negative</code></p>
<p>: The negative file set. The result will never contain files that are also in this file set. This argument can also be a path, which gets <a href="#sec-fileset-path-coercion">implicitly coerced to a file set</a>.</p>
<h3 id="type_8">Type</h3>
<div class="highlight"><pre><span></span><code>union :: FileSet -&gt; FileSet -&gt; FileSet
</code></pre></div>
<h3 id="examples_8">Examples</h3>
<div class="admonition example">
<p class="admonition-title"><code>lib.fileset.difference</code> usage example</p>
<div class="highlight"><pre><span></span><code><span class="c1"># Create a file set containing all files from the current directory,</span>
<span class="c1"># except ones under ./tests</span>
difference <span class="l">./.</span> <span class="l">./tests</span>
<span class="k">let</span>
<span class="c1"># A set of Nix-related files</span>
<span class="ss">nixFiles</span> <span class="o">=</span> unions <span class="p">[</span> <span class="l">./default.nix</span> <span class="l">./nix</span> <span class="l">./tests/default.nix</span> <span class="p">];</span>
<span class="k">in</span>
<span class="c1"># Create a file set containing all files under ./tests, except ones in `nixFiles`,</span>
<span class="c1"># meaning only without ./tests/default.nix</span>
difference <span class="l">./tests</span> nixFiles
</code></pre></div>
</div>
<p>Located at <a href="https://github.com/NixOS/nixpkgs/blob/master/lib/fileset/default.nix#L746">lib/fileset/default.nix:746</a> in <code>&lt;nixpkgs&gt;</code>.</p>
<h2 id="function-library-lib.fileset.fileFilter"><code>lib.fileset.fileFilter</code></h2>
<p>Filter a file set to only contain files matching some predicate.</p>
<h3 id="inputs_9">Inputs</h3>
<p><code>predicate</code></p>
<p>: The predicate function to call on all files contained in given file set.
A file is included in the resulting file set if this function returns true for it.</p>
<p>This function is called with an attribute set containing these attributes:</p>
<ul>
<li>
<p><code>name</code> (String): The name of the file</p>
</li>
<li>
<p><code>type</code> (String, one of <code>"regular"</code>, <code>"symlink"</code> or <code>"unknown"</code>): The type of the file.
This matches result of calling <a href="https://nixos.org/manual/nix/stable/language/builtins.html#builtins-readFileType"><code>builtins.readFileType</code></a> on the file's path.</p>
</li>
<li>
<p><code>hasExt</code> (String -&gt; Bool): Whether the file has a certain file extension.
<code>hasExt ext</code> is true only if <code>hasSuffix ".${ext}" name</code>.</p>
<p>This also means that e.g. for a file with name <code>.gitignore</code>,
<code>hasExt "gitignore"</code> is true.</p>
</li>
</ul>
<p>Other attributes may be added in the future.</p>
<p><code>path</code></p>
<p>: The path whose files to filter</p>
<h3 id="type_9">Type</h3>
<div class="highlight"><pre><span></span><code>fileFilter ::
({
name :: String,
type :: String,
hasExt :: String -&gt; Bool,
...
} -&gt; Bool)
-&gt; Path
-&gt; FileSet
</code></pre></div>
<h3 id="examples_9">Examples</h3>
<div class="admonition example">
<p class="admonition-title"><code>lib.fileset.fileFilter</code> usage example</p>
<div class="highlight"><pre><span></span><code><span class="c1"># Include all regular `default.nix` files in the current directory</span>
fileFilter <span class="p">(</span>file<span class="p">:</span> file<span class="o">.</span><span class="ss">name</span> <span class="o">==</span> <span class="s2">&quot;default.nix&quot;</span><span class="p">)</span> <span class="l">./.</span> <span class="s2">&quot;Include all non-Nix files from the current directory</span>
<span class="s2">fileFilter (file: ! file.hasExt &quot;</span>nix<span class="s2">&quot;) ./. &quot;</span>Include all files that start <span class="k">with</span> a <span class="s2">&quot;.&quot;</span> <span class="k">in</span> the current directory
fileFilter <span class="p">(</span>file<span class="p">:</span> hasPrefix <span class="s2">&quot;.&quot;</span> file<span class="o">.</span>name<span class="p">)</span> <span class="l">./.</span> <span class="s2">&quot;Include all regular files (not symlinks or others) in the current directory</span>
<span class="s2">fileFilter (file: file.type == &quot;</span>regular<span class="s2">&quot;) ./.</span>
</code></pre></div>
</div>
<p>Located at <a href="https://github.com/NixOS/nixpkgs/blob/master/lib/fileset/default.nix#L829">lib/fileset/default.nix:829</a> in <code>&lt;nixpkgs&gt;</code>.</p>
<h2 id="function-library-lib.fileset.fromSource"><code>lib.fileset.fromSource</code></h2>
<p>Create a file set with the same files as a <code>lib.sources</code>-based value.
This does not import any of the files into the store.</p>
<p>This can be used to gradually migrate from <code>lib.sources</code>-based filtering to <code>lib.fileset</code>.</p>
<p>A file set can be turned back into a source using <a href="#function-library-lib.fileset.toSource"><code>toSource</code></a>.</p>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>File sets cannot represent empty directories.
Turning the result of this function back into a source using <code>toSource</code> will therefore not preserve empty directories.</p>
</div>
<h3 id="inputs_10">Inputs</h3>
<p><code>source</code></p>
<p>: 1. Function argument</p>
<h3 id="type_10">Type</h3>
<div class="highlight"><pre><span></span><code>fromSource :: SourceLike -&gt; FileSet
</code></pre></div>
<h3 id="examples_10">Examples</h3>
<div class="admonition example">
<p class="admonition-title"><code>lib.fileset.fromSource</code> usage example</p>
<div class="highlight"><pre><span></span><code><span class="c1"># There&#39;s no cleanSource-like function for file sets yet,</span>
<span class="c1"># but we can just convert cleanSource to a file set and use it that way</span>
toSource <span class="p">{</span>
<span class="ss">root</span> <span class="o">=</span> <span class="l">./.</span><span class="p">;</span>
<span class="ss">fileset</span> <span class="o">=</span> fromSource <span class="p">(</span>lib<span class="o">.</span>sources<span class="o">.</span>cleanSource <span class="l">./.</span><span class="p">);</span>
<span class="p">}</span> <span class="s2">&quot;Keeping a previous sourceByRegex (which could be migrated to `lib.fileset.unions`),</span>
<span class="s2"># but removing a subdirectory using file set functions</span>
<span class="s2">difference</span>
<span class="s2"> (fromSource (lib.sources.sourceByRegex ./. [</span>
<span class="s2"> &quot;</span><span class="err">^</span>README<span class="err">\</span><span class="o">.</span>md<span class="err">$</span><span class="s2">&quot;</span>
<span class="s2"> # This regex includes everything in ./doc</span>
<span class="s2"> &quot;</span><span class="err">^</span>doc<span class="p">(</span><span class="l">/.</span><span class="o">*</span><span class="p">)</span><span class="o">?</span><span class="err">$</span><span class="s2">&quot;</span>
<span class="s2"> ])</span>
<span class="s2"> ./doc/generated &quot;</span>Use cleanSource<span class="p">,</span> but limit it to only include <span class="l">./Makefile</span> <span class="ow">and</span> files under <span class="l">./src</span>
intersection
<span class="p">(</span>fromSource <span class="p">(</span>lib<span class="o">.</span>sources<span class="o">.</span>cleanSource <span class="l">./.</span><span class="p">))</span>
<span class="p">(</span>unions <span class="p">[</span>
<span class="l">./Makefile</span>
<span class="l">./src</span>
<span class="p">]);</span>
</code></pre></div>
</div>
<p>Located at <a href="https://github.com/NixOS/nixpkgs/blob/master/lib/fileset/default.nix#L908">lib/fileset/default.nix:908</a> in <code>&lt;nixpkgs&gt;</code>.</p>
<h2 id="function-library-lib.fileset.gitTracked"><code>lib.fileset.gitTracked</code></h2>
<p>Create a file set containing all <a href="https://git-scm.com/book/en/v2/Git-Basics-Recording-Changes-to-the-Repository">Git-tracked files</a> in a repository.</p>
<p>This function behaves like <a href="#function-library-lib.fileset.gitTrackedWith"><code>gitTrackedWith { }</code></a> - using the defaults.</p>
<h3 id="inputs_11">Inputs</h3>
<p><code>path</code></p>
<p>: The <a href="https://nixos.org/manual/nix/stable/language/values#type-path">path</a> to the working directory of a local Git repository.
This directory must contain a <code>.git</code> file or subdirectory.</p>
<h3 id="type_11">Type</h3>
<div class="highlight"><pre><span></span><code>gitTracked :: Path -&gt; FileSet
</code></pre></div>
<h3 id="examples_11">Examples</h3>
<div class="admonition example">
<p class="admonition-title"><code>lib.fileset.gitTracked</code> usage example</p>
<div class="highlight"><pre><span></span><code><span class="c1"># Include all files tracked by the Git repository in the current directory</span>
gitTracked <span class="l">./.</span> <span class="s2">&quot;Include only files tracked by the Git repository in the parent directory</span>
<span class="s2"># that are also in the current directory</span>
<span class="s2">intersection ./. (gitTracked ../.)</span>
</code></pre></div>
</div>
<p>Located at <a href="https://github.com/NixOS/nixpkgs/blob/master/lib/fileset/default.nix#L969">lib/fileset/default.nix:969</a> in <code>&lt;nixpkgs&gt;</code>.</p>
<h2 id="function-library-lib.fileset.gitTrackedWith"><code>lib.fileset.gitTrackedWith</code></h2>
<p>Create a file set containing all <a href="https://git-scm.com/book/en/v2/Git-Basics-Recording-Changes-to-the-Repository">Git-tracked files</a> in a repository.
The first argument allows configuration with an attribute set,
while the second argument is the path to the Git working tree.</p>
<p><code>gitTrackedWith</code> does not perform any filtering when the path is a <a href="https://nixos.org/manual/nix/stable/store/store-path.html#store-path">Nix store path</a> and not a repository.
In this way, it accommodates the use case where the expression that makes the <code>gitTracked</code> call does not reside in an actual git repository anymore,
and has presumably already been fetched in a way that excludes untracked files.
Fetchers with such equivalent behavior include <code>builtins.fetchGit</code>, <code>builtins.fetchTree</code> (experimental), and <code>pkgs.fetchgit</code> when used without <code>leaveDotGit</code>.</p>
<p>If you don't need the configuration,
you can use <a href="#function-library-lib.fileset.gitTracked"><code>gitTracked</code></a> instead.</p>
<p>This is equivalent to the result of <a href="#function-library-lib.fileset.unions"><code>unions</code></a> on all files returned by <a href="https://git-scm.com/docs/git-ls-files"><code>git ls-files</code></a>
(which uses <a href="https://git-scm.com/docs/git-ls-files#Documentation/git-ls-files.txt--c"><code>--cached</code></a> by default).</p>
<div class="admonition warning">
<p class="admonition-title">Warning</p>
<p>Currently this function is based on <a href="https://nixos.org/manual/nix/stable/language/builtins.html#builtins-fetchGit"><code>builtins.fetchGit</code></a>
As such, this function causes all Git-tracked files to be unnecessarily added to the Nix store,
without being re-usable by <a href="#function-library-lib.fileset.toSource"><code>toSource</code></a>.</p>
</div>
<p>This may change in the future.</p>
<h3 id="inputs_12">Inputs</h3>
<p><code>options</code> (attribute set)
: <code>recurseSubmodules</code> (optional, default: <code>false</code>)
: Whether to recurse into <a href="https://git-scm.com/book/en/v2/Git-Tools-Submodules">Git submodules</a> to also include their tracked files.
If <code>true</code>, this is equivalent to passing the <a href="https://git-scm.com/docs/git-ls-files#Documentation/git-ls-files.txt---recurse-submodules">--recurse-submodules</a> flag to <code>git ls-files</code>.</p>
<p><code>path</code>
: The <a href="https://nixos.org/manual/nix/stable/language/values#type-path">path</a> to the working directory of a local Git repository.
This directory must contain a <code>.git</code> file or subdirectory.</p>
<h3 id="type_12">Type</h3>
<div class="highlight"><pre><span></span><code>gitTrackedWith :: { recurseSubmodules :: Bool ? false } -&gt; Path -&gt; FileSet
</code></pre></div>
<h3 id="examples_12">Examples</h3>
<div class="admonition example">
<p class="admonition-title"><code>lib.fileset.gitTrackedWith</code> usage example</p>
<div class="highlight"><pre><span></span><code><span class="c1"># Include all files tracked by the Git repository in the current directory</span>
<span class="c1"># and any submodules under it</span>
gitTracked <span class="p">{</span> <span class="ss">recurseSubmodules</span> <span class="o">=</span> <span class="no">true</span><span class="p">;</span> <span class="p">}</span> <span class="l">./.</span>
</code></pre></div>
</div>
<p>Located at <a href="https://github.com/NixOS/nixpkgs/blob/master/lib/fileset/default.nix#L1031">lib/fileset/default.nix:1031</a> in <code>&lt;nixpkgs&gt;</code>.</p>
</article>
</div>
<script>var target=document.getElementById(location.hash.slice(1));target&&target.name&&(target.checked=target.name.startsWith("__tabbed_"))</script>
</div>
</main>
<footer class="md-footer">
<div class="md-footer-meta md-typeset">
<div class="md-footer-meta__inner md-grid">
<div class="md-copyright">
<div class="md-copyright__highlight">
Licenced MIT
</div>
Made with
<a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
Material for MkDocs
</a>
</div>
<div class="md-social">
<a href="https://git.auxolotl.org/auxolotl/docs" target="_blank" rel="noopener" title="Aux Docs Repo" class="md-social__link">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M16.777 0a2.9 2.9 0 1 1-2.529 4.322H12.91a4.266 4.266 0 0 0-4.265 4.195v2.118a7.076 7.076 0 0 1 4.147-1.42l.118-.002h1.338a2.9 2.9 0 0 1 5.43 1.422 2.9 2.9 0 0 1-5.43 1.422H12.91a4.266 4.266 0 0 0-4.265 4.195v2.319A2.9 2.9 0 0 1 7.222 24 2.9 2.9 0 0 1 5.8 18.57V8.589a7.109 7.109 0 0 1 6.991-7.108l.118-.001h1.338A2.9 2.9 0 0 1 16.778 0ZM7.223 19.905a1.194 1.194 0 1 0 0 2.389 1.194 1.194 0 0 0 0-2.389Zm9.554-10.464a1.194 1.194 0 1 0 0 2.389 1.194 1.194 0 0 0 0-2.39Zm0-7.735a1.194 1.194 0 1 0 0 2.389 1.194 1.194 0 0 0 0-2.389Z"/></svg>
</a>
<a href="https://forum.aux.computer/" target="_blank" rel="noopener" title="Aux Forum" class="md-social__link">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12.103 0C18.666 0 24 5.485 24 11.997c0 6.51-5.33 11.99-11.9 11.99L0 24V11.79C0 5.28 5.532 0 12.103 0zm.116 4.563a7.395 7.395 0 0 0-6.337 3.57 7.247 7.247 0 0 0-.148 7.22L4.4 19.61l4.794-1.074a7.424 7.424 0 0 0 8.136-1.39 7.256 7.256 0 0 0 1.737-7.997 7.375 7.375 0 0 0-6.84-4.585h-.008z"/></svg>
</a>
<a href="https://wiki.auxolotl.org/" target="_blank" rel="noopener" title="Aux Wiki" class="md-social__link">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M17.801 13.557c.148.098.288.202.417.313 1.854 1.6 3.127 4.656 2.582 7.311-1.091-.255-5.747-1.055-7.638-3.383-.91-1.12-1.366-2.081-1.569-2.885a5.65 5.65 0 0 0 .034-.219c.089.198.197.35.313.466.24.24.521.335.766.372.304.046.594-.006.806-.068l.001.001c.05-.015.433-.116.86-.342.325-.173 2.008-.931 3.428-1.566Zm-7.384 1.435C9.156 16.597 6.6 18.939.614 18.417c.219-1.492 1.31-3.019 2.51-4.11.379-.345.906-.692 1.506-1.009.286.168.598.332.939.486 2.689 1.221 3.903 1.001 4.89.573a1.3 1.3 0 0 0 .054-.025 6.156 6.156 0 0 0-.096.66Zm4.152-.462c.38-.341.877-.916 1.383-1.559-.389-.15-.866-.371-1.319-.591-.598-.29-1.305-.283-2.073-.315a4.685 4.685 0 0 1-.804-.103c.014-.123.027-.246.038-.369.062.104.673.057.871.057.354 0 1.621.034 3.074-.574 1.452-.608 2.55-1.706 3.022-3.225.474-1.52.22-3.091-.168-3.952-.169.709-1.453 2.381-1.926 2.871-.473.489-2.381 2.296-2.972 2.921-.7.74-.688.793-1.332 1.302-.202.19-.499.402-.563.53.027-.338.039-.675.027-.997a7.653 7.653 0 0 0-.032-.523c.322-.059.567-.522.567-.861 0-.224-.106-.247-.271-.229.075-.894.382-3.923 1.254-4.281.218.109.831.068.649-.295-.182-.364-.825-.074-1.081.266-.28.374-.956 2.046-.92 4.324-.113.014-.174.033-.322.033-.171 0-.321-.04-.433-.05.034-2.275-.714-3.772-.84-4.169-.12-.375-.491-.596-.781-.596-.146 0-.272.056-.333.179-.182.363.459.417.677.308.706.321 1.156 3.519 1.254 4.277-.125-.006-.199.035-.199.233 0 .311.17.756.452.843a.442.442 0 0 0-.007.03s-.287.99-.413 2.189a4.665 4.665 0 0 1-.718-.225c-.714-.286-1.355-.583-2.019-.566-.664.018-1.366.023-1.804-.036-.438-.058-.649-.15-.649-.15s-.234.365.257 1.075c.42.607 1.055 1.047 1.644 1.18.589.134 1.972.18 2.785-.377.16-.109.317-.228.459-.34a8.717 8.717 0 0 0-.013.626c-.289.753-.571 1.993-.268 3.338 0-.001.701-.842.787-2.958.006-.144.009-.271.01-.383.052-.248.103-.518.148-.799.072.135.151.277.234.413.511.842 1.791 1.37 2.383 1.49.091.019.187.032.285.038Zm-1.12.745c-.188.055-.445.1-.713.059-.21-.031-.45-.11-.655-.316-.169-.168-.312-.419-.401-.789a9.837 9.837 0 0 0 .039-.82l.049-.243c.563.855 1.865 1.398 2.476 1.522.036.008.072.014.109.02l-.013.009c-.579.415-.76.503-.891.558Zm6.333-2.818c-.257.114-4.111 1.822-5.246 2.363.98-.775 3.017-3.59 3.699-4.774 1.062.661 1.468 1.109 1.623 1.441.101.217.09.38.096.515a.57.57 0 0 1-.172.455Zm-9.213 1.62a1.606 1.606 0 0 1-.19.096c-.954.414-2.126.61-4.728-.571-2.023-.918-3.024-2.157-3.371-2.666.476.161 1.471.473 2.157.524.282.021.703.068 1.167.125.021.209.109.486.345.829l.001.001c.451.651 1.134 1.119 1.765 1.262.622.141 2.083.182 2.942-.407a3.12 3.12 0 0 0 .132-.093l.001.179a6.052 6.052 0 0 0-.221.721Zm5.512-1.271a17.49 17.49 0 0 1-1.326-.589c.437.042 1.054.083 1.692.108-.121.162-.244.323-.366.481Zm.932-1.26c-.12.17-.245.343-.373.517-.241.018-.478.03-.709.038a29.05 29.05 0 0 1-.741-.048c.608-.065 1.228-.252 1.823-.507Zm.22-.315c-.809.382-1.679.648-2.507.648-.472 0-.833.018-1.139.039v.001c-.324-.031-.665-.039-1.019-.054a3.555 3.555 0 0 1-.152-.009c.102-.002.192-.006.249-.006.363 0 1.662.034 3.151-.589 1.508-.632 2.645-1.773 3.136-3.351.37-1.186.31-2.402.086-3.312.458-.336.86-.651 1.147-.91.501-.451.743-.733.848-.869.199.206.714.864.685 2.138-.036 1.611-.606 3.187-1.501 4.154a9.099 9.099 0 0 1-1.321 1.132 11.978 11.978 0 0 0-.644-.422l-.089-.055-.051.091c-.184.332-.5.825-.879 1.374ZM4.763 5.817c-.157 1.144.113 2.323.652 3.099.539.776 2.088 2.29 3.614 2.505.991.14 2.055.134 2.055.134s-.593-.576-1.114-1.66c-.521-1.085-.948-2.104-1.734-2.786-.785-.681-1.601-1.416-2.045-1.945-.444-.53-.59-.86-.59-.86s-.656.175-.838 1.513Zm14.301 4.549a9.162 9.162 0 0 0 1.3-1.12c.326-.352.611-.782.845-1.265 1.315.145 2.399.371 2.791.434 0 0-.679 1.971-3.945 3.022l-.016-.035c-.121-.26-.385-.594-.975-1.036Zm-11.634.859a8.537 8.537 0 0 1-.598-.224c-1.657-.693-2.91-1.944-3.449-3.678-.498-1.601-.292-3.251.091-4.269.225.544.758 1.34 1.262 2.01a3.58 3.58 0 0 0-.172.726c-.163 1.197.123 2.428.687 3.24.416.599 1.417 1.62 2.555 2.193-.128.002-.253.003-.376.002Zm-1.758-.077c-.958-.341-1.901-.787-2.697-1.368C-.07 7.559 0 6.827 0 6.827s1.558-.005 3.088.179c.03.126.065.
</a>
</div>
</div>
</div>
</footer>
</div>
<div class="md-dialog" data-md-component="dialog">
<div class="md-dialog__inner md-typeset"></div>
</div>
<script id="__config" type="application/json">{"base": "../../..", "features": ["content.tooltips", "search.highlight", "navigation.tabs", "navigation.indexes", "navigation.prune"], "search": "../../../assets/javascripts/workers/search.b8dbb3d2.min.js", "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}}</script>
<script src="../../../assets/javascripts/bundle.fe8b6f2b.min.js"></script>
</body>
</html>
Copy permalink