From ca0d94a44bb4022e28b54aa17cb14d9b026213dc Mon Sep 17 00:00:00 2001 From: Eric Wong Date: Thu, 27 Jun 2024 20:14:02 +0800 Subject: [PATCH] docs(help): update and rollback --- autoload/SpaceVim.vim | 60 +++++++++++++++++++++++++++++++++++++++++++ doc/SpaceVim.txt | 60 +++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 120 insertions(+) diff --git a/autoload/SpaceVim.vim b/autoload/SpaceVim.vim index fce3a1383..75f43f108 100644 --- a/autoload/SpaceVim.vim +++ b/autoload/SpaceVim.vim @@ -30,6 +30,66 @@ scriptencoding utf-8 " 6. Mnemonic key bindings: Key bindings are organized using mnemonic prefixes. " 7. Lower the risk of RSI: Heavily using the `` key instead of modifiers. + +"" +" @section Update and Rollback, update-and-rollback +" @parentsection intro +" @subsection Update SpaceVim itself +" +" There are several methods of updating the core files of SpaceVim. +" It is recommended to update the packages first; see the next section. +" +" 1. Automatic Updates +" +" By default, this feature is disabled. +" It would slow down the startup of Vim/Neovim. +" If you like this feature, +" add the following to your custom configuration file. +" > +" [options] +" automatic_update = true +" < +" +" SpaceVim will automatically check for a new version +" every startup. You have to restart Vim after updating. +" +" 2. Updating from the SpaceVim Buffer +" +" Users can use command `:SPUpdate SpaceVim` to update SpaceVim. +" This command will open a new buffer to show the process of updating. +" +" 3. Updating Manually with git +" +" For users who prefer to use the command line, they can use the following command +" in a terminal to update SpaceVim manually: +" > +" git -C ~/.SpaceVim pull +" < +" +" @subsection Update plugins +" +" Use `:SPUpdate` command to update all the plugins and +" SpaceVim itself. After `:SPUpdate`, you can assign +" plugins need to be updated. Use `Tab` to complete +" plugin names after `:SPUpdate`. +" +" @subsection Reinstall plugins +" +" When a plugin has failed to update or is broken, Use the `:SPReinstall` +" command to reinstall the plugin. The plugin's name can be completed via the key binding ``. +" +" For example: +" > +" :SPReinstall echodoc.vim +" < +" +" @subsection Get SpaceVim log +" +" The runtime log of SpaceVim can be obtained via the key binding `SPC h L`. +" To get the debug information about the current SpaceVim environment, +" Use the command `:SPDebugInfo!`. This command will open a new buffer where default information will be shown. +" You can also use `SPC h I` to open a buffer with SpaceVim's issue template. + "" " @section Options, options " The very first time SpaceVim starts up, it will ask you to choose a mode, diff --git a/doc/SpaceVim.txt b/doc/SpaceVim.txt index 3171ea499..b13461679 100644 --- a/doc/SpaceVim.txt +++ b/doc/SpaceVim.txt @@ -18,6 +18,7 @@ wsdjeg *spacevim* *SpaceVim* CONTENTS *SpaceVim-contents* 1. Introduction.............................................. |SpaceVim-intro| 1. Highlighted Features............................... |SpaceVim-features| + 2. Update and Rollback..................... |SpaceVim-update-and-rollback| 2. Options................................................. |SpaceVim-options| 1. autocomplete_method............. |SpaceVim-options-autocomplete_method| 2. autocomplete_parens............. |SpaceVim-options-autocomplete_parens| @@ -326,6 +327,65 @@ HIGHLIGHTED FEATURES *SpaceVim-features* 7. Lower the risk of RSI: Heavily using the `` key instead of modifiers. +============================================================================== +UPDATE AND ROLLBACK *SpaceVim-update-and-rollback* + +UPDATE SPACEVIM ITSELF + +There are several methods of updating the core files of SpaceVim. It is +recommended to update the packages first; see the next section. + + 1. Automatic Updates + +By default, this feature is disabled. It would slow down the startup of +Vim/Neovim. If you like this feature, add the following to your custom +configuration file. +> + [options] + automatic_update = true +< + +SpaceVim will automatically check for a new version every startup. You have to +restart Vim after updating. + + 2. Updating from the SpaceVim Buffer + +Users can use command `:SPUpdate SpaceVim` to update SpaceVim. This command +will open a new buffer to show the process of updating. + + 3. Updating Manually with git + +For users who prefer to use the command line, they can use the following +command in a terminal to update SpaceVim manually: +> + git -C ~/.SpaceVim pull +< + +UPDATE PLUGINS + +Use `:SPUpdate` command to update all the plugins and SpaceVim itself. After +`:SPUpdate`, you can assign plugins need to be updated. Use `Tab` to complete +plugin names after `:SPUpdate`. + +REINSTALL PLUGINS + +When a plugin has failed to update or is broken, Use the `:SPReinstall` +command to reinstall the plugin. The plugin's name can be completed via the +key binding ``. + +For example: +> + :SPReinstall echodoc.vim +< + +GET SPACEVIM LOG + +The runtime log of SpaceVim can be obtained via the key binding `SPC h L`. To +get the debug information about the current SpaceVim environment, Use the +command `:SPDebugInfo!`. This command will open a new buffer where default +information will be shown. You can also use `SPC h I` to open a buffer with +SpaceVim's issue template. + ============================================================================== OPTIONS *SpaceVim-options*