commit 6e184442deba3e78202efbacb6f85240c978cfef Author: brettlangdon Date: Fri Jan 29 10:52:24 2016 -0500 update gh-pages diff --git a/index.html b/index.html new file mode 100644 index 0000000..0ecd4f0 --- /dev/null +++ b/index.html @@ -0,0 +1,174 @@ + + + + + + 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. +
+ +
+ + diff --git a/install.sh b/install.sh new file mode 100755 index 0000000..7db8243 --- /dev/null +++ b/install.sh @@ -0,0 +1,6 @@ +#!/usr/bin/env bash +cd /tmp \ + && rm -rf git-vendor \ + && git clone https://github.com/brettlangdon/git-vendor &> /dev/null \ + && cd git-vendor \ + && make install