From 238e089d746ba9ec57e1cf9e2252c2fb8d8e3b62 Mon Sep 17 00:00:00 2001
From: SteveLauC <stevelauc@outlook.com>
Date: Sat, 17 Feb 2024 13:14:39 +0800
Subject: [PATCH] docs: document brew config entries[skip ci] (#696)

---
 config.example.toml | 12 ++++++++++++
 1 file changed, 12 insertions(+)

diff --git a/config.example.toml b/config.example.toml
index 1b8a7932..07d96ae2 100644
--- a/config.example.toml
+++ b/config.example.toml
@@ -103,10 +103,22 @@
 
 
 [brew]
+# For the BrewCask step
+# If `Repo Cask Upgrade` exists, then use the `-a` option.
+# Otherwise, use the `--greedy` option.
 # greedy_cask = true
+
+# For the BrewCask step
+# If `Repo Cask Upgrade` does not exist, then use the `--greedy_latest` optoin.
+# NOTE: the above entry `greedy_cask` contains this entry, though you can enable
+# both of them, they won't clash with each other.
 # greedy_latest = true
+
+# For the BrewFormula step
+# Execute `brew autoremove` after the step.
 # autoremove = true
 
+# For the BrewFormula step
 # Upgrade formulae built from the HEAD branch; `brew upgrade --fetch-HEAD`
 # fetch_head = true