From f8fc966d98e83ea33c886be9dd7102d5ce571935 Mon Sep 17 00:00:00 2001 From: James Lu Date: Mon, 3 Feb 2025 21:37:18 -0800 Subject: [PATCH] configuration: reorder editing config manually section It's better to disable flushing first, rather than risk having your changes overwritten... --- use/configuration.rst | 21 +++++++++++---------- 1 file changed, 11 insertions(+), 10 deletions(-) diff --git a/use/configuration.rst b/use/configuration.rst index e8e7e95..f82232b 100644 --- a/use/configuration.rst +++ b/use/configuration.rst @@ -157,22 +157,23 @@ Note that channel-specific settings take precedence over network-specific ones. Finally, you can also unset any channel-specific or network-specific variables with the ``config reset channel`` and ``config reset network`` commands. -Editing the Configuration Values by Hand ----------------------------------------- +Editing the Config Manually +--------------------------- -NOTE: **We don't recommend this; you should normally -do everything with the commands in the Config plugin.** +.. note:: + We don't recommend this; you should normally do everything with the commands + in the Config plugin. -To reload Limnoria's configuration from disk, use the ``config reload`` command. +Before editing the config manually, you should either stop the bot or +set the ``supybot.flush`` option to ``false`` to prevent Limnoria from +writing its config out and overwriting your changes. + +Once you have made your changes, use the ``config reload`` command to reload +Limnoria's configuration from disk. This will refresh the bot's main configuration as well as any user/channel/ignore databases, which are stored by default in separate files under the ``conf/`` directory. -Note that Limnoria writes its configuration files to disk periodically, -so it may overwrite manual edits to configuration files. -To prevent this, set the ``supybot.flush`` option to ``false`` while editing -its config files to disable automatic flushing. - If you cannot access the bot on IRC and your bot is running on a POSIX system, you can also send it a SIGHUP signal; it is exactly the same as ``config reload`` (note that the Config plugin has to be loaded for this