diff --git a/man/git-vendor.1 b/man/git-vendor.1 index e6fd28b..b33fb3a 100644 --- a/man/git-vendor.1 +++ b/man/git-vendor.1 @@ -1,7 +1,7 @@ .\" generated with Ronn/v0.7.3 .\" http://github.com/rtomayko/ronn/tree/0.7.3 . -.TH "GIT\-VENDOR" "1" "January 2016" "" "Git Vendor" +.TH "GIT\-VENDOR" "1" "February 2016" "" "Git Vendor" . .SH "NAME" \fBgit\-vendor\fR \- manage vendored dependency subtrees @@ -13,6 +13,9 @@ \fBgit\-vendor list []\fR . .P +\fBgit\-vendor remove \fR +. +.P \fBgit\-vendor update []\fR . .SH "DESCRIPTION" @@ -31,16 +34,22 @@ add [\-\-prefix ] [] Add a new vendored dependency . .P -list [\fIname\fR] +list [] . .P List all existing vendored dependencies and their current version\. Limit show dependency to \fB\fR if provided\. . .P +remove +. +.P +Remove the named vendored dependency\. +. +.P update . .P -Update the vendored dependency to a different version +Update the vendored dependency to a different version\. . .SH "OPTIONS" \-\-prefix @@ -119,6 +128,19 @@ $ git vendor update forge .IP "" 0 . .P +Removing a dependency: +. +.IP "" 4 +. +.nf + +$ git vendor remove forge +. +.fi +. +.IP "" 0 +. +.P List all existing dependencies: . .IP "" 4 diff --git a/man/git-vendor.html b/man/git-vendor.html index 0ecd4f0..e69de29 100644 --- a/man/git-vendor.html +++ b/man/git-vendor.html @@ -1,174 +0,0 @@ - - - - - - git-vendor(1) - manage vendored dependency subtrees - - - - -
- - - -
    -
  1. git-vendor(1)
    2. -
  2. Git Vendor
    3. -
  3. git-vendor(1)
    4. -
- -

NAME

-

- git-vendor - manage vendored dependency subtrees -

- -

SYNOPSIS

- -

git-vendor add [--prefix <dir>] <name> <repository> [<ref>]

- -

git-vendor list [<name>]

- -

git-vendor update <name> [<ref>]

- -

DESCRIPTION

- -

Manage any repository dependencies with git-subtree.

- -

git-vendor follows the same vendoring pattern that is used in the Go community. Dependencies are stored under vendor/<repository_uri>. For example, the dependency of https://github.com/brettlangdon/forge.git will be stored under vendor/github.com/brettlangdon/forge by default.

- -

git-vendor is unable to list or update any dependencies it has not added, the reason is that git-vendor adds special commit messages so that it can track existing dependencies.

- -

COMMANDS

- -

add [--prefix <dir>] <name> <repository> [<ref>]

- -

Add a new vendored dependency

- -

list [name]

- -

List all existing vendored dependencies and their current version. Limit show dependency to <name> if provided.

- -

update <dir> <ref>

- -

Update the vendored dependency to a different version

- -

OPTIONS

- -

--prefix <dir>

- -

Directory to pull dependencies in under (e.g. vendor or third_party, etc). [default: vendor]

- -

<name>

- -

A name to provide the vendored dependency to use when listing/updating.

- -

<repository>

- -

The repository url to vendor. e.g. https://github.com/<username>/<repo-name> (supports http://, https:// git:// and git@ protocols).

- -

<ref>

- -

The ref to vendor. e.g. master, v1.0.2, etc. [default: master]

- -

EXAMPLES

- -

Adding a new dependency at a specific git tagged version:

- -
$ git vendor add forge https://github.com/brettlangdon/forge v0.1.4
-
- -

Adding a new dependency under a different directory than vendor/:

- -
$ git vendor add --prefix third_party forge https://github.com/brettlangdon/forge
-
- -

Updating an existing dependency to a specific git tagged version:

- -
$ git vendor update forge  v0.1.7
-
- -

Updating a dependency to master:

- -
$ git vendor update forge
-
- -

List all existing dependencies:

- -
$ git vendor list
-
- -

AUTHOR

- -

Written by Brett Langdon me@brett.is

- -

REPORTING BUGS

- -

<https://github.com/brettlangdon/git-vendor/issues>

- -

SEE ALSO

- -

<https://github.com/brettlangdon/git-vendor>

- - -
    -
  1. -
  2. January 2016
    3. -
  3. git-vendor(1)
    4. -
- -
- -