stow/oh-my-zsh/.oh-my-zsh/plugins/svn-fast-info/README.md

   1 # svn-fast-info plugin
   2
   3 Faster alternative to the main SVN plugin implementation. Works with svn 1.6 and newer.
   4 Use as a drop-in replacement to the svn plugin, not as complementary.
   5
   6 To use it, add `svn-fast-info` to the plugins array in your zshrc file:
   7
   8 ```zsh
   9 plugins=(... svn-fast-info)
  10 ```
  11
  12 It's faster because it has an efficient use of svn (single svn call) which saves a lot on a huge codebase.
  13 It displays the current status of the local files (added, deleted, modified, replaced, or else...)
  14
  15 Use `svn_prompt_info` method to display the svn repository status in your theme.
  16
  17 ## Functions
  18
  19 - `svn_prompt_info`: displays all the available information regarding the status of the svn repository.
  20
  21 - `svn_repo_need_upgrade`: shows whether the repository needs upgrading. `svn_prompt_info` queries the
  22   rest of functions or not based on the result of this function.
  23
  24 - `svn_current_branch_name`: shows the current branch.
  25
  26 - `svn_repo_root_name`: displays the repository root.
  27
  28 - `svn_current_revision`: shows the currently checked-out revision.
  29
  30 - `svn_status_info`: shows a bunch of symbols depending on the status of the files in the repository.
  31
  32 ## Options
  33
  34 - `ZSH_THEME_SVN_PROMPT_PREFIX`: sequence displayed at the beginning of the prompt info output.
  35
  36 - `ZSH_THEME_SVN_PROMPT_SUFFIX`: sequence displayed at the end of the prompt info output.
  37
  38 - `ZSH_THEME_SVN_PROMPT_CLEAN`: sequence displayed when the status of the repository is clean.
  39
  40 - `ZSH_THEME_SVN_PROMPT_ADDITIONS`: sequence displayed if there are added files in the repository.
  41   **Default:** `+`.
  42
  43 - `ZSH_THEME_SVN_PROMPT_DELETIONS`: sequence displayed if there are deleted files in the repository.
  44   **Default:** `✖`.
  45
  46 - `ZSH_THEME_SVN_PROMPT_MODIFICATIONS`: sequence displayed if there are modified files in the repository.
  47   **Default:** `✎`.
  48
  49 - `ZSH_THEME_SVN_PROMPT_REPLACEMENTS`: sequence displayed if there are replaced files in the repository.
  50   **Default:** `∿`.
  51
  52 - `ZSH_THEME_SVN_PROMPT_UNTRACKED`: sequence displayed if there are untracked files in the repository.
  53   **Default:** `?`.
  54
  55 - `ZSH_THEME_SVN_PROMPT_DIRTY`: sequence displayed if the repository is dirty.
  56   **Default:** `!`.