From d223050925e31b3e3aea72b09eca99f686cc137a Mon Sep 17 00:00:00 2001
From: Michal Koutný <mkoutny@suse.com>
Date: Apr 05 2024 14:18:24 +0000
Subject: mass-cve: Add README


---

diff --git a/scripts/cve_tools/README.md b/scripts/cve_tools/README.md
new file mode 100644
index 0000000..143ab98
--- /dev/null
+++ b/scripts/cve_tools/README.md
@@ -0,0 +1,27 @@
+## Usage
+
+* Set `VULNS_GIT` environment variable to a clone of https://git.kernel.org/pub/scm/linux/security/vulns.git
+* Set `KSOURCE_GIT` environment variable to a clone of kernel-source
+  * Fetch the repo to base work on up-to-date branches
+* Pick a working directory `WD` (will store working data)
+
+* Run as
+```
+cd $WD
+make -f path/to/scripts/cve_tools/Makefile BRANCH=cve/linux-5.14-LTSS update_refs_history
+```
+
+* that will create a new git branch in `KSOURCE_GIT` and add commits with new
+  references
+* it is recommended that `KSOURCE_GIT` is not same directory where
+  scripts/cve_tools/Makefile resides (e.g. use git worktrees)
+* it will store processed data files in the `WD`
+
+## TODO
+
+* move working data from CWD to `XDG_CACHE_HOME` so that they can be used by
+  other utils
+* integrate with branches.conf so that list of "root" branches is extracted
+* integrate with branches.conf so that non-root branches are handled too (easy
+  if we allow multiplicities of RPM changelog messages)
+* `git --git-dir="$(VULNS_GIT)/.git" pull` is broken, it adds files to $WD when fresh pull