Describe configuration options

1 files changed, 27 insertions, 0 deletions

diff --git a/config/config.toml.example b/config/config.toml.example
index e2ef02e..2c9b4d4 100644
--- a/config/config.toml.example
+++ b/config/config.toml.example
@@ -1,8 +1,35 @@
+## Global options
+
+# Accessing GitHub APIs is only possible using a personal access token. The
+# token doesn't need any scopes set since it is used to query public
+# repositories.
 gh_token = ""
+
+# Relative path to a cloned SBo repository.
 repository = "./slackbuilds"
+
+# After one package is updated a commit is created on this branch. The branch is
+# not pushed or reset automatically.
 branch = "user/nick/updates"
+
+# If some packages use custom sources and these sources a generated during the
+# update, this option specifies the base URL where the sources can be downloaded
+# afterwads. The full URL written into the .info file contains download_url,
+# followed by the package name and source file name. This option should probably
+# be configured consistently with the remote_path.
 download_url = "https://example.com/some/path"
+
+# If a package updater generates a source tarball, the tarball is uploaded to
+# a remote destination with scp. remote_path specifies the remote server and
+# a local path on the server where the source tarballs are hosted. When
+# uploading the remote_path is followed by the package name and source file
+# name. To specify a public URL where the sources can be downloaded, see
+# download_url.
 remote_path = "example.com:/srv/httpd/some/path"
 
+## Maintainer specific options
 [maintainer]
+
+# Whether the git commits should be signed with a GPG signature using the
+# default key.
 signature = false