github.com/kekek/gb@v0.4.5-0.20170222120241-d4ba64b0b297/cmd/gb-vendor/alldocs.go (about) 1 // DO NOT EDIT THIS FILE. 2 //go:generate gb vendor help documentation 3 4 /* 5 gb-vendor, a gb plugin to manage your vendored dependencies. 6 7 Usage: 8 9 gb vendor command [arguments] 10 11 The commands are: 12 13 fetch fetch a remote dependency 14 update update a local dependency 15 list lists dependencies, one per line 16 delete deletes a local dependency 17 purge purges all unreferenced dependencies 18 restore restore dependencies from the manifest 19 20 Use "gb vendor help [command]" for more information about a command. 21 22 Additional help topics: 23 24 25 Use "gb vendor help [topic]" for more information about that topic. 26 27 28 Fetch a remote dependency 29 30 Usage: 31 32 gb vendor fetch [-branch branch | -revision rev | -tag tag] [-precaire] [-no-recurse] importpath 33 34 fetch vendors an upstream import path. 35 36 The import path may include a url scheme. This may be useful when fetching dependencies 37 from private repositories that cannot be probed. 38 39 Flags: 40 -branch branch 41 fetch from the name branch. If not supplied the default upstream 42 branch will be used. 43 -no-recurse 44 do not fetch recursively. 45 -tag tag 46 fetch the specified tag. If not supplied the default upstream 47 branch will be used. 48 -revision rev 49 fetch the specific revision from the branch (if supplied). If no 50 revision supplied, the latest available will be supplied. 51 -precaire 52 allow the use of insecure protocols. 53 54 55 Update a local dependency 56 57 Usage: 58 59 gb vendor update [-all] import 60 61 gb vendor update will replaces the source with the latest available from the head of the master branch. 62 63 Updating from one copy of a dependency to another comes with several restrictions. 64 The first is you can only update to the head of the branch your dependency was vendered from, switching branches is not supported. 65 The second restriction is if you have used -tag or -revision while vendoring a dependency, your dependency is "headless" 66 (to borrow a term from git) and cannot be updated. 67 68 To update across branches, or from one tag/revision to another, you must first use gb vendor delete to remove the dependency, then 69 gb vendor fetch [-tag | -revision | -branch ] [-precaire] to replace it. 70 71 Flags: 72 -all 73 will update all dependencies in the manifest, otherwise only the dependency supplied. 74 -precaire 75 allow the use of insecure protocols. 76 77 78 Lists dependencies, one per line 79 80 Usage: 81 82 gb vendor list [-f format] 83 84 gb vendor list formats lists the contents of the manifest file. 85 86 The output 87 88 Flags: 89 -f 90 controls the template used for printing each manifest entry. If not supplied 91 the default value is "{{.Importpath}}\t{{.Repository}}{{.Path}}\t{{.Branch}}\t{{.Revision}}" 92 93 94 Deletes a local dependency 95 96 Usage: 97 98 gb vendor delete [-all] importpath 99 100 delete removes a dependency from $PROJECT/vendor/src and the vendor manifest 101 102 Flags: 103 -all 104 remove all dependencies 105 106 107 Purges all unreferenced dependencies 108 109 Usage: 110 111 gb vendor purge 112 113 gb vendor purge will remove all unreferenced dependencies 114 115 116 Restore dependencies from the manifest 117 118 Usage: 119 120 gb vendor restore [-precaire] 121 122 Restore vendor dependencies. 123 124 Flags: 125 -precaire 126 allow the use of insecure protocols. 127 128 129 */ 130 package main