From d2c56084f812a8b6272c48c846e4758b4e09d4e7 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?S=C3=A9bastien=20Helleu?= Date: Sat, 13 Mar 2021 15:17:01 +0100 Subject: doc: add upgrade chapter in user's guide --- doc/ja/weechat_user.ja.adoc | 72 +++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 72 insertions(+) (limited to 'doc/ja/weechat_user.ja.adoc') diff --git a/doc/ja/weechat_user.ja.adoc b/doc/ja/weechat_user.ja.adoc index 97e79abf5..1c5cabcc9 100644 --- a/doc/ja/weechat_user.ja.adoc +++ b/doc/ja/weechat_user.ja.adoc @@ -531,6 +531,78 @@ gdb /usr/bin/weechat 12345 (gdb) bt full ---- +// TRANSLATION MISSING +[[upgrade]] +=== Upgrade + +If a new stable version of WeeChat is released, this is time for you to +switch to this version. + +First of all, you must install the new version of WeeChat, either with your +package manager or by compiling yourself, so that the `weechat` binary and all +required files are in the same paths. + +This can be done while WeeChat is running. + +// TRANSLATION MISSING +[[upgrade_command]] +==== Upgrade command + +WeeChat can restart the new binary, in place, using the +<> command: the buffer contents and non-SSL +connections are preserved. + +The SSL connections are lost during upgrade and you are automatically +reconnected after the upgrade (reload of SSL sessions is currently not possible +with GnuTLS). + +The command can also be used if you have to restart the machine, for example +to upgrade the kernel or to move your WeeChat to another machine: + +---- +/upgrade -quit +---- + +This saves the current state in `*.upgrade` files. You can then either reboot +or move the whole directory `~/.weechat` to another machine, and restart +WeeChat later with this command: + +---- +$ weechat --upgrade +---- + +// TRANSLATION MISSING +[[restart_after_upgrade]] +==== Restart after upgrade + +===== Release notes + +After an upgrade, it is *strongly recommended* to read the +https://weechat.org/files/releasenotes/ReleaseNotes-devel.html[release notes] +which contain important information about breaking changes and some +manual actions that could be required. + +You must read the release notes of all versions between your old (excluded) and +your new version (included). + +For example if you switch from version 3.0 to 3.2, you must read release notes +of versions 3.1 and 3.2. + +===== Configuration upgrade + +WeeChat has an automatic upgrade of configuration files (`*.conf`): + +* new options are silently added with default value +* obsolete options are automatically discarded and WeeChat displays a warning + with the value read from file. + +Example of warning when an option has been removed: + +---- +=!= 警告: /home/xxx/.weechat/sec.conf, 行 15: セクション "crypt" の無効なオプション: passphrase_file = "" +---- + +That means the option `sec.crypt.passphrase_file` has been removed, and you +had value set to empty string, which was the default value in the previous version +(in this case no manual action is required). + [[usage]] == 使い方 -- cgit v1.2.3