Document customizing the temporary location (#112)

CHANGELOG.md

@@ -26,7 +26,7 @@ Bug fixes:
 - Copy debug bundles instead of renaming them from the temp location.
   This resolves issues preventing debug bundles from being stored for Linux installations where the temporary location
   and the home folder are on separate mount points.
-- Locate `fossa` in `$PATH` before running it.
+- Locate `fossa` in `PATH` before running it.
   This resolves issues where some Linux implementations cannot execute commands without the full path.
 
 ## v0.2.0

Cargo.toml

@@ -62,7 +62,7 @@ tracing-test = { version = "0.2.4", features = ["no-env-filter"] }
 duplicate = "1.0.0"
 aho-corasick = "0.7.20"
 regex = "1.8.4"
-srclib = { git = "https://github.com/fossas/foundation-libs", branch = "add-srclib" }
+srclib = { git = "https://github.com/fossas/foundation-libs" }
 walkdir = "2.3.3"
 tar = "0.4.38"
 libflate = "1.3.0"

docs/reference/faq.md

@@ -14,13 +14,24 @@ feel free to send us a support request via [support.fossa.com](https://support.f
 - On Linux and macOS: `~/.config/fossa/broker/`
 - On Windows: `%USERPROFILE%\.config\fossa\broker`
 
-Elsewhere in these docs we refer to this as though it is an environment variable, e.g. `$DATA_ROOT` or `%DATA_ROOT%`.
+Elsewhere in these docs we refer to this as though it is an environment variable, as `DATA_ROOT`.
 Note that this is not a true environment variable, we just use it this way inside file paths in the documentation
 to make relative file paths clear.
 
 Most Broker subcommands allow customizing the data root via the `-r` flag.
 For more information on this and other runtime customization, run `broker -h`.
 
+### Can I customize the temporary directory used by Broker?
+
+- On Linux and macOS: set the `TMPDIR` environment variable.
+- On Windows: Broker uses the `GetTempPath` system call,
+  [which checks for the existence of environment variables in the following order](https://learn.microsoft.com/en-us/windows/win32/api/fileapi/nf-fileapi-gettemppath2a#remarks)
+  and uses the first path found:
+  - The path specified by the `TMP` environment variable.
+  - The path specified by the `TEMP` environment variable.
+  - The path specified by the `USERPROFILE` environment variable.
+  - The Windows directory.
+
 ### Where is the config file stored?
 
 - On macOS and Linux, the config is stored at `$DATA_ROOT/config.yml`.

docs/subcommands/fix.md

@@ -34,7 +34,7 @@ If, after running `broker fix`, you submit a support ticket to FOSSA, please alw
 
 ## Subcommand FAQs
 
-- [Where is the `$DATA_ROOT`?](../reference/faq.md#where-is-the-data-root-for-broker)
+- [Where is the `DATA_ROOT`?](../reference/faq.md#where-is-the-data-root-for-broker)
 - [Where is the config file stored?](../reference/faq.md#where-is-the-config-file-stored)
 - [Where are debugging artifacts stored?](../reference/faq.md#where-are-debug-artifacts-stored)
 

docs/subcommands/init.md

@@ -14,5 +14,5 @@ After `broker init` finishes, it reports the data root and these actions to the
 
 ## Subcommand FAQs
 
-- [Where is the `$DATA_ROOT`?](../reference/faq.md#where-is-the-data-root-for-broker)
+- [Where is the `DATA_ROOT`?](../reference/faq.md#where-is-the-data-root-for-broker)
 - [Where is the config file stored?](../reference/faq.md#where-is-the-config-file-stored)

docs/subcommands/run.md

@@ -7,7 +7,7 @@ _For more information on the config, see the [config reference](../reference/con
 
 ## Subcommand FAQs
 
-- [Where is the `$DATA_ROOT`?](../reference/faq.md#where-is-the-data-root-for-broker)
+- [Where is the `DATA_ROOT`?](../reference/faq.md#where-is-the-data-root-for-broker)
 - [Where is the config file stored?](../reference/faq.md#where-is-the-config-file-stored)
 - [Where are debugging artifacts stored?](../reference/faq.md#where-are-debug-artifacts-stored)
 - [Does Broker understand FOSSA CLI config files?](../reference/faq.md#does-broker-understand-fossa-cli-config-files-checked-into-the-repository-being-scanned)