Merge pull request #203 from vim-volt/devel

Release v0.3.3

Author: tyru

.appveyor.yml

@@ -7,11 +7,11 @@ clone_folder: c:\gopath\src\github.com\vim-volt\volt
 
 environment:
   GOPATH: c:\gopath
-  MYGODIR: C:\go19
+  GOROOT: C:\go19
   VIM_URL: http://vim-jp.org/redirects/koron/vim-kaoriya/vim80/oldest/win64/
 
 install:
-  - set PATH=%GOPATH%\bin;%MYGODIR%\bin;%PATH%
+  - set PATH=%GOPATH%\bin;%GOROOT%\bin;%PATH%
   - echo %PATH%
   - echo %GOPATH%
   - go version

CMDREF.md

@@ -62,7 +62,7 @@ Usage
 Quick example
   $ volt get tyru/caw.vim     # will install tyru/caw.vim plugin
   $ volt get -u tyru/caw.vim  # will upgrade tyru/caw.vim plugin
-  $ volt get -l -u            # will upgrade all installed plugins
+  $ volt get -l -u            # will upgrade all plugins in current profile
   $ VOLT_DEBUG=1 volt get tyru/caw.vim  # will output more verbosely
 
   $ mkdir -p ~/volt/repos/localhost/local/hello/plugin
@@ -80,7 +80,7 @@ Description
 
 Repository List
   {repository} list (=target to perform installing, upgrading, and so on) is determined as followings:
-  * If -l option is specified, all installed vim plugins (regardless current profile) are used
+  * If -l option is specified, all plugins in current profile are used
   * If one or more {repository} arguments are specified, the arguments are used
 
 Action
@@ -118,8 +118,8 @@ Repository path
   4. http://{site}/{user}/{name}
 
 Options
-  -l    use all installed repositories as targets
-  -u    upgrade repositories
+  -l    use all plugins in current profile as targets
+  -u    upgrade plugins
 ```
 
 # volt list
@@ -173,9 +173,6 @@ Structures
     // lock.json structure compatibility version
     "version": <int64>,
 
-    // Unique number of transaction
-    "trx_id": <int64>,
-
     // Current profile name (e.g. "default")
     "current_profile_name": <string>,
 
@@ -186,9 +183,6 @@ Structures
         // "git" (git repository) or "static" (static repository)
         "type": <string>,
 
-        // Unique number of transaction
-        "trx_id": <int64>,
-
         // Repository path like "github.com/vim-volt/vim-volt"
         "path": <string>,
 
@@ -217,12 +211,17 @@ Description
 
 ```
 Usage
-  volt migrate [-help]
+  volt migrate [-help] {migration operation}
 
 Description
-    Perform migration of $VOLTPATH/lock.json, which means volt converts old version lock.json structure into the latest version. This is always done automatically when reading lock.json content. For example, 'volt get <repos>' will install plugin, and migrate lock.json structure, and write it to lock.json after all. so the migrated content is written to lock.json automatically.
-    But, for example, 'volt list' does not write to lock.json but does read, so every time when running 'volt list' shows warning about lock.json is old.
-    To suppress this, running this command simply reads and writes migrated structure to lock.json.
+  Perform miscellaneous migration operations.
+  See detailed help for 'volt migrate -help {migration operation}'.
+
+Available operations
+  lockjson
+    converts old lock.json format to the latest format
+  plugconf/config-func
+    converts s:config() function name to s:on_load_pre() in all plugconf files
 ```
 
 # volt profile

Gopkg.lock

@@ -21,8 +21,6 @@
 #  version = "2.4.0"
 
 
-required = ["github.com/golang/dep/cmd/dep"]
-
 [[constraint]]
   name = "gopkg.in/src-d/go-git.v4"
   version = "=v4.0.0-rc15"

Gopkg.toml

@@ -66,8 +66,9 @@ Command
   build [-full]
     Build ~/.vim/pack/volt/ directory
 
-  migrate
-    Convert old version $VOLTPATH/lock.json structure into the latest version
+  migrate {migration operation}
+    Perform miscellaneous migration operations.
+    See 'volt migrate -help' for all available operations
 
   self-upgrade [-check]
     Upgrade to the latest volt command, or if -check was given, it only checks the newer version is available
@@ -205,7 +206,9 @@ You can update all plugins as follows:
 $ volt get -l -u
 ```
 
-`-l` works like all installed plugins are specified (the repositories list is read from `$VOLTPATH/lock.json`).
+`-l` works like all plugins in current profile are specified (the repositories list is read from `$VOLTPATH/lock.json`).
+If you do not use profile feature, or `enable` and `disable` commands, you can
+think that `-l` specifies all plugins what you have installed.
 `-u` updates specified plugins.
 
 Or, update only specified plugin(s) as follows:
@@ -249,7 +252,7 @@ Normally `volt build` synchronizes correctly, but if you met the bug, try `volt
 If you want to install set of plugins which you have installed by `volt get`, you can use `volt get -l`.
 
 ```
-$ volt get -l   # install plugins listed in $VOLTPATH/lock.json
+$ volt get -l   # install missing plugins in current profile in $VOLTPATH/lock.json
 ```
 
 First, you have to manage the following files under `$VOLTPATH`.
@@ -416,6 +419,8 @@ You can create a vimrc & gvimrc file for each profile:
 * vimrc: `$VOLTPATH/rc/<profile name>/vimrc.vim`
 * gvimrc: `$VOLTPATH/rc/<profile name>/gvimrc.vim`
 
+NOTE: If the path(s) exists, `$MYVIMRC` and `$MYGVIMRC` are set. So `:edit $MYVIMRC` does not open generated vimrc (`~/.vim/vimrc`), but above vimrc/gvimrc.
+
 This file is copied to `~/.vim/vimrc` and `~/.vim/gvimrc` with magic comment (shows error if existing vimrc/gvimrc files exist with no magic comment).
 
 And you can enable/disable vimrc by `volt profile use` (or you can simply remove `$VOLTPATH/rc/<profile name>/vimrc.vim` file if you don't want vimrc for the profile).

README.md

@@ -11,11 +11,11 @@ import (
 )
 
 func main() {
-	os.Exit(Main())
+	os.Exit(doMain())
 }
 
 // Update CMDREF.md "volt help" output in the first code block (lines surrounded by ```)
-func Main() int {
+func doMain() int {
 	if len(os.Args) <= 1 {
 		fmt.Fprintln(os.Stderr, "[WARN] Specify CMDREF.md path")
 		return 1

_scripts/update-cmdref.go

@@ -12,12 +12,12 @@ import (
 )
 
 func main() {
-	os.Exit(Main())
+	os.Exit(doMain())
 }
 
 // Embeds "volt help" output in the first code block (lines surrounded by ```)
 // of README.md
-func Main() int {
+func doMain() int {
 	if len(os.Args) <= 1 {
 		fmt.Fprintln(os.Stderr, "[WARN] Specify README.md path")
 		return 1