summaryrefslogtreecommitdiff
path: root/.config/qutebrowser/misc/requirements/README.md
diff options
context:
space:
mode:
Diffstat (limited to '.config/qutebrowser/misc/requirements/README.md')
-rw-r--r--.config/qutebrowser/misc/requirements/README.md20
1 files changed, 20 insertions, 0 deletions
diff --git a/.config/qutebrowser/misc/requirements/README.md b/.config/qutebrowser/misc/requirements/README.md
new file mode 100644
index 0000000..6ae9862
--- /dev/null
+++ b/.config/qutebrowser/misc/requirements/README.md
@@ -0,0 +1,20 @@
+This directory contains various `requirements` files which are used by `tox` to
+have reproducible tests with pinned versions.
+
+The files are generated based on unpinned requirements in `*.txt-raw` files.
+
+Those files can also contain some special commands:
+
+- Add an additional comment to a line: `#@ comment: <package> <comment here>`
+- Filter a line for requirements.io: `#@ filter: <package> <filter>`
+- Don't include a package in the output: `#@ ignore: <package>` (or multiple packages)
+- Replace a part of a frozen package specification with another: `#@ replace <regex> <replacement>`
+
+Some examples:
+
+```
+#@ comment: mypkg blah blub
+#@ filter: mypkg != 1.0.0
+#@ ignore: mypkg, otherpkg
+#@ replace: foo bar
+```