Skip to content

Commit f5c0718

Browse files
author
John Haley
committed
Bump to 0.16.0 and 0.17.0
1 parent 990337f commit f5c0718

File tree

113 files changed

+587
-217
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

113 files changed

+587
-217
lines changed

‎_config.yml

+3-1
Original file line numberDiff line numberDiff line change
@@ -3,9 +3,11 @@ title: NodeGit
33
description: Asynchronous native Node bindings to libgit2
44
url: "http://nodegit.org"
55
date_format: "ordinal"
6-
current_nodegit_version: 0.15.1
6+
current_nodegit_version: 0.17.0
77
other_nodegit_versions:
88
- HEAD
9+
- 0.17.0
10+
- 0.16.0
911
- 0.15.1
1012
- 0.14.1
1113
- 0.14.0

‎api/annotated_commit/index.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
layout: default
33
menu_item: api
44
title: AnnotatedCommit
5-
description: Version 0.15.1
5+
description: Version 0.17.0
66
menu_item: api
77
return_to:
88
"API Documentation Index": /api/

‎api/attr/index.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
layout: default
33
menu_item: api
44
title: Attr
5-
description: Version 0.15.1
5+
description: Version 0.17.0
66
menu_item: api
77
return_to:
88
"API Documentation Index": /api/

‎api/blame/index.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
layout: default
33
menu_item: api
44
title: Blame
5-
description: Version 0.15.1
5+
description: Version 0.17.0
66
menu_item: api
77
return_to:
88
"API Documentation Index": /api/

‎api/blame_hunk/index.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
layout: default
33
menu_item: api
44
title: BlameHunk
5-
description: Version 0.15.1
5+
description: Version 0.17.0
66
menu_item: api
77
return_to:
88
"API Documentation Index": /api/

‎api/blame_options/index.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
layout: default
33
menu_item: api
44
title: BlameOptions
5-
description: Version 0.15.1
5+
description: Version 0.17.0
66
menu_item: api
77
return_to:
88
"API Documentation Index": /api/

‎api/blob/index.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
layout: default
33
menu_item: api
44
title: Blob
5-
description: Version 0.15.1
5+
description: Version 0.17.0
66
menu_item: api
77
return_to:
88
"API Documentation Index": /api/

‎api/branch/index.md

+5-3
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
layout: default
33
menu_item: api
44
title: Branch
5-
description: Version 0.15.1
5+
description: Version 0.17.0
66
menu_item: api
77
return_to:
88
"API Documentation Index": /api/
@@ -39,10 +39,12 @@ Branch.create(repo, branch_name, target, force).then(function(reference) {
3939
| --- | --- |
4040
| [Reference](/api/reference/) | the underlying reference. |
4141

42-
## <a name="createFromAnnotated"></a><span>Branch.</span>createFromAnnotated <span class="tags"><span class="sync">Sync</span></span>
42+
## <a name="createFromAnnotated"></a><span>Branch.</span>createFromAnnotated <span class="tags"><span class="async">Async</span></span>
4343

4444
```js
45-
var reference = Branch.createFromAnnotated(repository, branch_name, commit, force);
45+
Branch.createFromAnnotated(repository, branch_name, commit, force).then(function(reference) {
46+
// Use reference
47+
});
4648
```
4749

4850
| Parameters | Type | |

‎api/buf/index.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
layout: default
33
menu_item: api
44
title: Buf
5-
description: Version 0.15.1
5+
description: Version 0.17.0
66
menu_item: api
77
return_to:
88
"API Documentation Index": /api/

‎api/cert/index.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
layout: default
33
menu_item: api
44
title: Cert
5-
description: Version 0.15.1
5+
description: Version 0.17.0
66
menu_item: api
77
return_to:
88
"API Documentation Index": /api/

‎api/cert_hostkey/index.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
layout: default
33
menu_item: api
44
title: CertHostkey
5-
description: Version 0.15.1
5+
description: Version 0.17.0
66
menu_item: api
77
return_to:
88
"API Documentation Index": /api/

‎api/cert_x509/index.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
layout: default
33
menu_item: api
44
title: CertX509
5-
description: Version 0.15.1
5+
description: Version 0.17.0
66
menu_item: api
77
return_to:
88
"API Documentation Index": /api/

‎api/checkout/index.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
layout: default
33
menu_item: api
44
title: Checkout
5-
description: Version 0.15.1
5+
description: Version 0.17.0
66
menu_item: api
77
return_to:
88
"API Documentation Index": /api/
@@ -33,7 +33,7 @@ Patch head checkout to automatically coerce objects.
3333
## <a name="index"></a><span>Checkout.</span>index <span class="tags"><span class="async">Async</span></span>
3434

3535
```js
36-
Checkout.index(repo, The, [options]).then(function() {
36+
Checkout.index(repo, index, [options]).then(function() {
3737
// checkout complete
3838
});
3939
```
@@ -43,7 +43,7 @@ Patch index checkout to automatically coerce objects.
4343
| Parameters | Type | |
4444
| --- | --- | --- |
4545
| repo | [Repository](/api/repository/) | The repo to checkout an index |
46-
| The | [Index](/api/index/) | index to checkout |
46+
| index | [Index](/api/index/) | The index to checkout |
4747
| [options] | [CheckoutOptions](/api/checkout_options/) | Options for the checkout |
4848

4949
## <a name="initOptions"></a><span>Checkout.</span>initOptions <span class="tags"><span class="sync">Sync</span></span>
@@ -74,7 +74,7 @@ Patch tree checkout to automatically coerce objects.
7474
| Parameters | Type | |
7575
| --- | --- | --- |
7676
| repo | [Repository](/api/repository/) | |
77-
| treeish | [Oid](/api/oid/), [Tree](/api/tree/), [Commit](/api/commit/), [Reference](/api/reference/) | |
77+
| treeish | String, [Tree](/api/tree/), [Commit](/api/commit/), [Reference](/api/reference/) | |
7878
| [options] | [CheckoutOptions](/api/checkout_options/) | |
7979

8080
## <a name="NOTIFY"></a><span>Checkout.</span>NOTIFY <span class="tags"><span class="enum">ENUM</span></span>

‎api/checkout_options/index.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
layout: default
33
menu_item: api
44
title: CheckoutOptions
5-
description: Version 0.15.1
5+
description: Version 0.17.0
66
menu_item: api
77
return_to:
88
"API Documentation Index": /api/

‎api/cherrypick/index.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
layout: default
33
menu_item: api
44
title: Cherrypick
5-
description: Version 0.15.1
5+
description: Version 0.17.0
66
menu_item: api
77
return_to:
88
"API Documentation Index": /api/

‎api/cherrypick_options/index.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
layout: default
33
menu_item: api
44
title: CherrypickOptions
5-
description: Version 0.15.1
5+
description: Version 0.17.0
66
menu_item: api
77
return_to:
88
"API Documentation Index": /api/

‎api/clone/index.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
layout: default
33
menu_item: api
44
title: Clone
5-
description: Version 0.15.1
5+
description: Version 0.17.0
66
menu_item: api
77
return_to:
88
"API Documentation Index": /api/

‎api/clone_options/index.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
layout: default
33
menu_item: api
44
title: CloneOptions
5-
description: Version 0.15.1
5+
description: Version 0.17.0
66
menu_item: api
77
return_to:
88
"API Documentation Index": /api/

‎api/commit/index.md

+10-14
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
layout: default
33
menu_item: api
44
title: Commit
5-
description: Version 0.15.1
5+
description: Version 0.17.0
66
menu_item: api
77
return_to:
88
"API Documentation Index": /api/
@@ -149,24 +149,24 @@ Commit.lookupPrefix(repo, id, len).then(function(commit) {
149149
| --- | --- |
150150
| [Commit](/api/commit/) | |
151151

152-
## <a name="amend"></a><span>Commit#</span>amend <span class="tags"><span class="sync">Sync</span></span>
152+
## <a name="amend"></a><span>Commit#</span>amend <span class="tags"><span class="async">Async</span></span>
153153

154154
```js
155-
var oid = commit.amend(update_ref, author, committer, message_encoding, message, tree);
155+
commit.amend(update_ref, author, committer, message_encoding, message, tree, callback).then(function() {
156+
// method complete});
156157
```
157158
159+
Amend a commit
160+
158161
| Parameters | Type |
159162
| --- | --- | --- |
160163
| update_ref | String | |
161164
| author | [Signature](/api/signature/) | |
162165
| committer | [Signature](/api/signature/) | |
163166
| message_encoding | String | |
164167
| message | String | |
165-
| tree | [Tree](/api/tree/) | |
166-
167-
| Returns | |
168-
| --- | --- |
169-
| [Oid](/api/oid/) | |
168+
| tree | [Tree](/api/tree/), [Oid](/api/oid/) | |
169+
| callback | [Oid](/api/oid/) | |
170170
171171
## <a name="author"></a><span>Commit#</span>author <span class="tags"><span class="sync">Sync</span></span>
172172
@@ -481,14 +481,10 @@ var result = commit.parentcount();
481481
## <a name="parents"></a><span>Commit#</span>parents <span class="tags"><span class="sync">Sync</span></span>
482482
483483
```js
484-
var arrayOid = commit.parents(callback);
484+
var arrayOid = commit.parents();
485485
```
486486
487-
Retrieve the commit"s parent shas.
488-
489-
| Parameters | Type |
490-
| --- | --- | --- |
491-
| callback | Function | |
487+
Retrieve the commit's parent shas.
492488
493489
| Returns | |
494490
| --- | --- |

‎api/config/index.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
layout: default
33
menu_item: api
44
title: Config
5-
description: Version 0.15.1
5+
description: Version 0.17.0
66
menu_item: api
77
return_to:
88
"API Documentation Index": /api/

‎api/config_entry/index.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
layout: default
33
menu_item: api
44
title: ConfigEntry
5-
description: Version 0.15.1
5+
description: Version 0.17.0
66
menu_item: api
77
return_to:
88
"API Documentation Index": /api/

‎api/convenient_patch/index.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
layout: default
33
menu_item: api
44
title: ConvenientPatch
5-
description: Version 0.15.1
5+
description: Version 0.17.0
66
menu_item: api
77
return_to:
88
"API Documentation Index": /api/

‎api/cred/index.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
layout: default
33
menu_item: api
44
title: Cred
5-
description: Version 0.15.1
5+
description: Version 0.17.0
66
menu_item: api
77
return_to:
88
"API Documentation Index": /api/

‎api/cred_username/index.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
layout: default
33
menu_item: api
44
title: CredUsername
5-
description: Version 0.15.1
5+
description: Version 0.17.0
66
menu_item: api
77
return_to:
88
"API Documentation Index": /api/

‎api/cred_userpass_payload/index.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
layout: default
33
menu_item: api
44
title: CredUserpassPayload
5-
description: Version 0.15.1
5+
description: Version 0.17.0
66
menu_item: api
77
return_to:
88
"API Documentation Index": /api/

‎api/cvar_map/index.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
layout: default
33
menu_item: api
44
title: CvarMap
5-
description: Version 0.15.1
5+
description: Version 0.17.0
66
menu_item: api
77
return_to:
88
"API Documentation Index": /api/

‎api/describe_format_options/index.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
layout: default
33
menu_item: api
44
title: DescribeFormatOptions
5-
description: Version 0.15.1
5+
description: Version 0.17.0
66
menu_item: api
77
return_to:
88
"API Documentation Index": /api/

‎api/describe_options/index.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
layout: default
33
menu_item: api
44
title: DescribeOptions
5-
description: Version 0.15.1
5+
description: Version 0.17.0
66
menu_item: api
77
return_to:
88
"API Documentation Index": /api/

0 commit comments

Comments
 (0)