about summary refs log tree commit diff
path: root/pkgs/common-updater/unstable-updater.nix
diff options
context:
space:
mode:
Diffstat (limited to 'pkgs/common-updater/unstable-updater.nix')
-rw-r--r--pkgs/common-updater/unstable-updater.nix4
1 files changed, 4 insertions, 0 deletions
diff --git a/pkgs/common-updater/unstable-updater.nix b/pkgs/common-updater/unstable-updater.nix
index d982fc6110ba7..d7a9c73fbc2d6 100644
--- a/pkgs/common-updater/unstable-updater.nix
+++ b/pkgs/common-updater/unstable-updater.nix
@@ -8,6 +8,10 @@
 
 # This is an updater for unstable packages that should always use the latest
 # commit.
+# To use this updater, add the following to your package set:
+# passthru.updateScript = unstableGitUpdater { };
+# relevant attributes can be passed as below:
+
 { url ? null # The git url, if empty it will be set to src.gitRepoUrl
 , branch ? null
 , hardcodeZeroVersion ? false # Use a made-up version "0" instead of latest tag. Use when there is no previous release, or the project's tagging system is incompatible with what we expect from versions