Skip to content

Commit c478a67

Browse files
implausibleimplausible
committed
Bump to 0.24.0
1 parent b9d2d7b commit c478a67

File tree

123 files changed

+2049
-1096
lines changed

Some content is hidden

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

123 files changed

+2049
-1096
lines changed

‎_config.yml

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,9 +3,18 @@ title: NodeGit
33
description: Asynchronous native Node bindings to libgit2
44
url: "http://nodegit.org"
55
date_format: "ordinal"
6-
current_nodegit_version: 0.21.1
6+
current_nodegit_version: 0.24.0
77
other_nodegit_versions:
88
- HEAD
9+
- 0.24.0
10+
- 0.24.0-alpha.1
11+
- 0.23.0
12+
- 0.23.0-alpha.2
13+
- 0.23.0-alpha.1
14+
- 0.22.2
15+
- 0.22.1
16+
- 0.22.0
17+
- 0.21.2
918
- 0.21.1
1019
- 0.21.0
1120
- 0.20.3

‎api/annotated_commit/index.md

Lines changed: 1 addition & 8 deletions
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.19.0
5+
description: Version 0.24.0
66
menu_item: api
77
return_to:
88
"API Documentation Index": /api/
@@ -11,7 +11,6 @@ sections:
1111
"fromRef": "#fromRef"
1212
"fromRevspec": "#fromRevspec"
1313
"lookup": "#lookup"
14-
"#free": "#free"
1514
"#id": "#id"
1615
---
1716

@@ -85,12 +84,6 @@ AnnotatedCommit.lookup(repo, id).then(function(annotatedCommit) {
8584
| --- | --- |
8685
| [AnnotatedCommit](/api/annotated_commit/) | |
8786

88-
## <a name="free"></a><span>AnnotatedCommit#</span>free <span class="tags"><span class="sync">Sync</span></span>
89-
90-
```js
91-
annotatedCommit.free();
92-
```
93-
9487
## <a name="id"></a><span>AnnotatedCommit#</span>id <span class="tags"><span class="sync">Sync</span></span>
9588

9689
```js

‎api/attr/index.md

Lines changed: 5 additions & 3 deletions
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.19.0
5+
description: Version 0.24.0
66
menu_item: api
77
return_to:
88
"API Documentation Index": /api/
@@ -63,10 +63,12 @@ Attr.get(repo, flags, path, name).then(function(string) {
6363
use the string value for attributes set to a value. You
6464
should NOT modify or free this value. |
6565

66-
## <a name="getMany"></a><span>Attr.</span>getMany <span class="tags"><span class="sync">Sync</span></span>
66+
## <a name="getMany"></a><span>Attr.</span>getMany <span class="tags"><span class="async">Async</span></span>
6767

6868
```js
69-
var array = Attr.getMany(repo, flags, path, num_attr, names);
69+
Attr.getMany(repo, flags, path, num_attr, names).then(function(array) {
70+
// Use array
71+
});
7072
```
7173

7274
| Parameters | Type | |

‎api/blame/index.md

Lines changed: 1 addition & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -2,15 +2,13 @@
22
layout: default
33
menu_item: api
44
title: Blame
5-
description: Version 0.19.0
5+
description: Version 0.24.0
66
menu_item: api
77
return_to:
88
"API Documentation Index": /api/
99
sections:
1010
"file": "#file"
11-
"initOptions": "#initOptions"
1211
"#buffer": "#buffer"
13-
"#free": "#free"
1412
"#getHunkByIndex": "#getHunkByIndex"
1513
"#getHunkByLine": "#getHunkByLine"
1614
"#getHunkCount": "#getHunkCount"
@@ -32,21 +30,6 @@ Retrieve the blame of a file
3230
| path | String | to the file to get the blame of |
3331
| [options] | [BlameOptions](/api/blame_options/) | Options for the blame |
3432
35-
## <a name="initOptions"></a><span>Blame.</span>initOptions <span class="tags"><span class="sync">Sync</span></span>
36-
37-
```js
38-
var result = Blame.initOptions(opts, version);
39-
```
40-
41-
| Parameters | Type | |
42-
| --- | --- | --- |
43-
| opts | [BlameOptions](/api/blame_options/) | The `git_blame_options` struct to initialize |
44-
| version | Number | Version of struct; pass `GIT_BLAME_OPTIONS_VERSION` |
45-
46-
| Returns | |
47-
| --- | --- |
48-
| Number | Zero on success; -1 on failure. |
49-
5033
## <a name="buffer"></a><span>Blame#</span>buffer <span class="tags"><span class="async">Async</span></span>
5134
5235
```js
@@ -64,12 +47,6 @@ blame.buffer(buffer, buffer_len).then(function(blame) {
6447
| --- | --- |
6548
| [Blame](/api/blame/) | |
6649
67-
## <a name="free"></a><span>Blame#</span>free <span class="tags"><span class="sync">Sync</span></span>
68-
69-
```js
70-
blame.free();
71-
```
72-
7350
## <a name="getHunkByIndex"></a><span>Blame#</span>getHunkByIndex <span class="tags"><span class="sync">Sync</span></span>
7451
7552
```js

‎api/blame_hunk/index.md

Lines changed: 1 addition & 1 deletion
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.19.0
5+
description: Version 0.24.0
66
menu_item: api
77
return_to:
88
"API Documentation Index": /api/

‎api/blame_options/index.md

Lines changed: 1 addition & 1 deletion
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.19.0
5+
description: Version 0.24.0
66
menu_item: api
77
return_to:
88
"API Documentation Index": /api/

‎api/blob/index.md

Lines changed: 1 addition & 43 deletions
Original file line numberDiff line numberDiff line change
@@ -2,23 +2,20 @@
22
layout: default
33
menu_item: api
44
title: Blob
5-
description: Version 0.19.0
5+
description: Version 0.24.0
66
menu_item: api
77
return_to:
88
"API Documentation Index": /api/
99
sections:
1010
"createFromBuffer": "#createFromBuffer"
1111
"createFromDisk": "#createFromDisk"
12-
"createFromStream": "#createFromStream"
1312
"createFromWorkdir": "#createFromWorkdir"
14-
"createFromstreamCommit": "#createFromstreamCommit"
1513
"filteredContent": "#filteredContent"
1614
"lookup": "#lookup"
1715
"lookupPrefix": "#lookupPrefix"
1816
"#content": "#content"
1917
"#dup": "#dup"
2018
"#filemode": "#filemode"
21-
"#free": "#free"
2219
"#id": "#id"
2320
"#isBinary": "#isBinary"
2421
"#owner": "#owner"
@@ -62,23 +59,6 @@ Blob.createFromDisk(repo, path).then(function(oid) {
6259
| --- | --- |
6360
| [Oid](/api/oid/) | return the id of the written blob |
6461

65-
## <a name="createFromStream"></a><span>Blob.</span>createFromStream <span class="tags"><span class="async">Async</span></span>
66-
67-
```js
68-
Blob.createFromStream(repo, hintpath).then(function(writestream) {
69-
// Use writestream
70-
});
71-
```
72-
73-
| Parameters | Type | |
74-
| --- | --- | --- |
75-
| repo | [Repository](/api/repository/) | Repository where the blob will be written. This repository can be bare or not. |
76-
| hintpath | String | If not NULL, will be used to select data filters to apply onto the content of the blob to be created. |
77-
78-
| Returns | |
79-
| --- | --- |
80-
| [Writestream](/api/writestream/) | the stream into which to write |
81-
8262
## <a name="createFromWorkdir"></a><span>Blob.</span>createFromWorkdir <span class="tags"><span class="async">Async</span></span>
8363

8464
```js
@@ -96,22 +76,6 @@ Blob.createFromWorkdir(repo, relative_path).then(function(oid) {
9676
| --- | --- |
9777
| [Oid](/api/oid/) | return the id of the written blob |
9878

99-
## <a name="createFromstreamCommit"></a><span>Blob.</span>createFromstreamCommit <span class="tags"><span class="async">Async</span></span>
100-
101-
```js
102-
Blob.createFromstreamCommit(stream).then(function(oid) {
103-
// Use oid
104-
});
105-
```
106-
107-
| Parameters | Type | |
108-
| --- | --- | --- |
109-
| stream | [Writestream](/api/writestream/) | the stream to close |
110-
111-
| Returns | |
112-
| --- | --- |
113-
| [Oid](/api/oid/) | the id of the new blob |
114-
11579
## <a name="filteredContent"></a><span>Blob.</span>filteredContent <span class="tags"><span class="async">Async</span></span>
11680

11781
```js
@@ -203,12 +167,6 @@ Retrieve the Blob's type.
203167
| --- | --- |
204168
| Number | The filemode of the blob. |
205169

206-
## <a name="free"></a><span>Blob#</span>free <span class="tags"><span class="sync">Sync</span></span>
207-
208-
```js
209-
blob.free();
210-
```
211-
212170
## <a name="id"></a><span>Blob#</span>id <span class="tags"><span class="sync">Sync</span></span>
213171

214172
```js

‎api/branch/index.md

Lines changed: 11 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -2,16 +2,16 @@
22
layout: default
33
menu_item: api
44
title: Branch
5-
description: Version 0.19.0
5+
description: Version 0.24.0
66
menu_item: api
77
return_to:
88
"API Documentation Index": /api/
99
sections:
1010
"create": "#create"
1111
"createFromAnnotated": "#createFromAnnotated"
1212
"delete": "#delete"
13+
"isCheckedOut": "#isCheckedOut"
1314
"isHead": "#isHead"
14-
"iteratorNew": "#iteratorNew"
1515
"lookup": "#lookup"
1616
"move": "#move"
1717
"name": "#name"
@@ -73,37 +73,35 @@ var result = Branch.delete(branch);
7373
| --- | --- |
7474
| Number | 0 on success, or an error code. |
7575

76-
## <a name="isHead"></a><span>Branch.</span>isHead <span class="tags"><span class="sync">Sync</span></span>
76+
## <a name="isCheckedOut"></a><span>Branch.</span>isCheckedOut <span class="tags"><span class="sync">Sync</span></span>
7777

7878
```js
79-
var result = Branch.isHead(branch);
79+
var result = Branch.isCheckedOut(branch);
8080
```
8181

8282
| Parameters | Type | |
8383
| --- | --- | --- |
84-
| branch | [Reference](/api/reference/) | Current underlying reference of the branch. |
84+
| branch | [Reference](/api/reference/) | Reference to the branch. |
8585

8686
| Returns | |
8787
| --- | --- |
88-
| Number | 1 if HEAD points at the branch, 0 if it isn't,
88+
| Number | 1 if branch is checked out, 0 if it isn't,
8989
error code otherwise. |
9090

91-
## <a name="iteratorNew"></a><span>Branch.</span>iteratorNew <span class="tags"><span class="async">Async</span></span>
91+
## <a name="isHead"></a><span>Branch.</span>isHead <span class="tags"><span class="sync">Sync</span></span>
9292

9393
```js
94-
Branch.iteratorNew(repo, list_flags).then(function(branchIterator) {
95-
// Use branchIterator
96-
});
94+
var result = Branch.isHead(branch);
9795
```
9896

9997
| Parameters | Type | |
10098
| --- | --- | --- |
101-
| repo | [Repository](/api/repository/) | Repository where to find the branches. |
102-
| list_flags | Number | Filtering flags for the branch listing. Valid values are GIT_BRANCH_LOCAL, GIT_BRANCH_REMOTE or GIT_BRANCH_ALL. |
99+
| branch | [Reference](/api/reference/) | Current underlying reference of the branch. |
103100

104101
| Returns | |
105102
| --- | --- |
106-
| [BranchIterator](/api/branch_iterator/) | the iterator |
103+
| Number | 1 if HEAD points at the branch, 0 if it isn't,
104+
error code otherwise. |
107105

108106
## <a name="lookup"></a><span>Branch.</span>lookup <span class="tags"><span class="async">Async</span></span>
109107

‎api/buf/index.md

Lines changed: 1 addition & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -2,13 +2,12 @@
22
layout: default
33
menu_item: api
44
title: Buf
5-
description: Version 0.19.0
5+
description: Version 0.24.0
66
menu_item: api
77
return_to:
88
"API Documentation Index": /api/
99
sections:
1010
"#containsNul": "#containsNul"
11-
"#free": "#free"
1211
"#grow": "#grow"
1312
"#isBinary": "#isBinary"
1413
"#set": "#set"
@@ -25,12 +24,6 @@ var result = buf.containsNul();
2524
| --- | --- |
2625
| Number | 1 if buffer contains a NUL byte |
2726

28-
## <a name="free"></a><span>Buf#</span>free <span class="tags"><span class="sync">Sync</span><span class="experimental">Experimental</span></span>
29-
30-
```js
31-
buf.free();
32-
```
33-
3427
## <a name="grow"></a><span>Buf#</span>grow <span class="tags"><span class="async">Async</span><span class="experimental">Experimental</span></span>
3528

3629
```js

‎api/cert/index.md

Lines changed: 1 addition & 1 deletion
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.19.0
5+
description: Version 0.24.0
66
menu_item: api
77
return_to:
88
"API Documentation Index": /api/

0 commit comments

Comments
 (0)