about summary refs log tree commit diff
path: root/config.toml.example
diff options
context:
space:
mode:
authorJoshua Nelson <jyn514@gmail.com>2020-09-11 22:55:16 -0400
committerJoshua Nelson <jyn514@gmail.com>2020-09-21 09:08:18 -0400
commitfe6fc555acd51bd7ba8755d9fbc7060feb67be25 (patch)
treea2a1ff084475103530f9199c9460157ed76ee423 /config.toml.example
parent956e06c6c85e918524b67503c4d65c7baf539585 (diff)
Add a changelog for x.py
- Add a changelog and instructions for updating it
- Use `changelog-seen` in `config.toml` and `VERSION` in bootstrap to determine whether the changelog has been read
- Nag people if they haven't read the x.py changelog
  + Print message twice to make sure it's seen
- Give different error messages depending on whether the version needs to be updated or added
Diffstat (limited to 'config.toml.example')
-rw-r--r--config.toml.example6
1 files changed, 6 insertions, 0 deletions
diff --git a/config.toml.example b/config.toml.example
index 8bf1b48ce83..fb62e1b4726 100644
--- a/config.toml.example
+++ b/config.toml.example
@@ -9,6 +9,12 @@
 # a custom configuration file can also be specified with `--config` to the build
 # system.
 
+# Keeps track of the last version of `x.py` used.
+# If it does not match the version that is currently running,
+# `x.py` will prompt you to update it and read the changelog.
+# See `src/bootstrap/CHANGELOG.md` for more information.
+changelog-seen = 1
+
 # =============================================================================
 # Global Settings
 # =============================================================================