[IMP] developer/reference/cli: improve docs of --upgrade-path

Be explicit about what we expect as parameter.
[IMP] developer/reference/cli: --pre-upgrade-scripts
2025-12-20 03:19:10 +07:00 · 2025-03-18 09:55:08 +01:00 · 2025-03-18 09:55:07 +01:00
1 changed files with 9 additions and 1 deletions
--- a/content/developer/reference/cli.rst
+++ b/content/developer/reference/cli.rst
@@ -92,7 +92,15 @@ Running the server

 .. option:: --upgrade-path <upgrade_path>

-   specify an additional upgrade path.
+   comma-separated list of directories from which additional upgrade scripts
+   are loaded.
+
+.. option:: --pre-upgrade-scripts <pre_upgrade_scripts>
+
+   comma-separated list of paths to upgrade scripts. The scripts are run before
+   loading base module when an upgrade of any module is requested. This is
+   useful to perform some actions during custom modules upgrade after a major
+   upgrade.

 .. option:: --load <modules>
Author	SHA1	Message	Date
Alvaro Fuentes	97fadd8f12	[IMP] developer/reference/cli: improve docs of --upgrade-path Be explicit about what we expect as parameter.	2025-03-18 09:55:08 +01:00
Alvaro Fuentes	2ccc6ded36	[IMP] developer/reference/cli: --pre-upgrade-scripts Document the new cli option.	2025-03-18 09:55:07 +01:00