Skip to content

Commit 11dc4ba

Browse files
committed
Bump to 0.25.0
1 parent c478a67 commit 11dc4ba

File tree

68 files changed

+2492
-637
lines changed

Some content is hidden

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

68 files changed

+2492
-637
lines changed

_config.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@ date_format: "ordinal"
66
current_nodegit_version: 0.24.0
77
other_nodegit_versions:
88
- HEAD
9+
- 0.25.0
910
- 0.24.0
1011
- 0.24.0-alpha.1
1112
- 0.23.0

api/annotated_commit/index.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,7 @@ sections:
1212
"fromRevspec": "#fromRevspec"
1313
"lookup": "#lookup"
1414
"#id": "#id"
15+
"#ref": "#ref"
1516
---
1617

1718
## <a name="fromFetchhead"></a><span>AnnotatedCommit.</span>fromFetchhead <span class="tags"><span class="async">Async</span></span>
@@ -94,3 +95,13 @@ var oid = annotatedCommit.id();
9495
| --- | --- |
9596
| [Oid](/api/oid/) | commit id |
9697

98+
## <a name="ref"></a><span>AnnotatedCommit#</span>ref <span class="tags"><span class="sync">Sync</span></span>
99+
100+
```js
101+
var string = annotatedCommit.ref();
102+
```
103+
104+
| Returns | |
105+
| --- | --- |
106+
| String | ref name. |
107+

api/apply/index.md

Lines changed: 58 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,58 @@
1+
---
2+
layout: default
3+
menu_item: api
4+
title: Apply
5+
description: Version 0.24.0
6+
menu_item: api
7+
return_to:
8+
"API Documentation Index": /api/
9+
sections:
10+
"apply": "#apply"
11+
"toTree": "#toTree"
12+
"LOCATION": "#LOCATION"
13+
---
14+
15+
## <a name="apply"></a><span>Apply.</span>apply <span class="tags"><span class="sync">Sync</span><span class="experimental">Experimental</span></span>
16+
17+
```js
18+
var result = Apply.apply(repo, diff, location, options);
19+
```
20+
21+
| Parameters | Type | |
22+
| --- | --- | --- |
23+
| repo | [Repository](/api/repository/) | the repository to apply to |
24+
| diff | [Diff](/api/diff/) | the diff to apply |
25+
| location | Number | the location to apply (workdir, index or both) |
26+
| options | [ApplyOptions](/api/apply_options/) | the options for the apply (or null for defaults) |
27+
28+
| Returns | |
29+
| --- | --- |
30+
| Number | |
31+
32+
## <a name="toTree"></a><span>Apply.</span>toTree <span class="tags"><span class="async">Async</span><span class="experimental">Experimental</span></span>
33+
34+
```js
35+
Apply.toTree(repo, preimage, diff, options).then(function(index) {
36+
// Use index
37+
});
38+
```
39+
40+
| Parameters | Type | |
41+
| --- | --- | --- |
42+
| repo | [Repository](/api/repository/) | the repository to apply |
43+
| preimage | [Tree](/api/tree/) | the tree to apply the diff to |
44+
| diff | [Diff](/api/diff/) | the diff to apply |
45+
| options | [ApplyOptions](/api/apply_options/) | the options for the apply (or null for defaults) |
46+
47+
| Returns | |
48+
| --- | --- |
49+
| [Index](/api/index/) | the postimage of the application |
50+
51+
## <a name="LOCATION"></a><span>Apply.</span>LOCATION <span class="tags"><span class="enum">ENUM</span></span>
52+
53+
| Flag | Value |
54+
| --- | --- | --- |
55+
| <span>Apply.LOCATION.</span>WORKDIR | 0 |
56+
| <span>Apply.LOCATION.</span>INDEX | 1 |
57+
| <span>Apply.LOCATION.</span>BOTH | 2 |
58+

api/apply_options/index.md

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
---
2+
layout: default
3+
menu_item: api
4+
title: ApplyOptions
5+
description: Version 0.24.0
6+
menu_item: api
7+
return_to:
8+
"API Documentation Index": /api/
9+
sections:
10+
"Instance Variables": "#ivars"
11+
---
12+
13+
```js
14+
var applyOptions = new ApplyOptions();
15+
```
16+
17+
## <a name="ivars"></a>Instance Variables
18+
19+
| Variable | Type | Description |
20+
| --- | --- | --- |
21+
| <a name="deltaCb"></a>deltaCb | ApplyDeltaCb | |
22+
| <a name="hunkCb"></a>hunkCb | ApplyHunkCb | |
23+
| <a name="payload"></a>payload | Void | |
24+
| <a name="version"></a>version | Number | |
25+

api/attr/index.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ sections:
1212
"get": "#get"
1313
"getMany": "#getMany"
1414
"value": "#value"
15-
"STATES": "#STATES"
15+
"VALUE": "#VALUE"
1616
---
1717

1818
## <a name="addMacro"></a><span>Attr.</span>addMacro <span class="tags"><span class="sync">Sync</span></span>
@@ -97,12 +97,12 @@ var result = Attr.value(attr);
9797
| --- | --- |
9898
| Number | the value type for the attribute |
9999

100-
## <a name="STATES"></a><span>Attr.</span>STATES <span class="tags"><span class="enum">ENUM</span></span>
100+
## <a name="VALUE"></a><span>Attr.</span>VALUE <span class="tags"><span class="enum">ENUM</span></span>
101101

102102
| Flag | Value |
103103
| --- | --- | --- |
104-
| <span>Attr.STATES.</span>UNSPECIFIED_T | 0 |
105-
| <span>Attr.STATES.</span>TRUE_T | 1 |
106-
| <span>Attr.STATES.</span>FALSE_T | 2 |
107-
| <span>Attr.STATES.</span>VALUE_T | 3 |
104+
| <span>Attr.VALUE.</span>UNSPECIFIED | 0 |
105+
| <span>Attr.VALUE.</span>TRUE | 1 |
106+
| <span>Attr.VALUE.</span>FALSE | 2 |
107+
| <span>Attr.VALUE.</span>STRING | 3 |
108108

api/blame/index.md

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,8 +18,9 @@ sections:
1818
## <a name="file"></a><span>Blame.</span>file <span class="tags"><span class="async">Async</span></span>
1919

2020
```js
21-
Blame.file(repo, path, [options]).then(function() {
22-
// method complete});
21+
Blame.file(repo, path, [options]).then(function(blame) {
22+
// Use blame
23+
});
2324
```
2425

2526
Retrieve the blame of a file
@@ -30,6 +31,10 @@ Retrieve the blame of a file
3031
| path | String | to the file to get the blame of |
3132
| [options] | [BlameOptions](/api/blame_options/) | Options for the blame |
3233

34+
| Returns | |
35+
| --- | --- |
36+
| [Blame](/api/blame/) | the blame |
37+
3338
## <a name="buffer"></a><span>Blame#</span>buffer <span class="tags"><span class="async">Async</span></span>
3439

3540
```js
@@ -95,4 +100,5 @@ var result = blame.getHunkCount();
95100
| <span>Blame.FLAG.</span>TRACK_COPIES_SAME_COMMIT_COPIES | 4 |
96101
| <span>Blame.FLAG.</span>TRACK_COPIES_ANY_COMMIT_COPIES | 8 |
97102
| <span>Blame.FLAG.</span>FIRST_PARENT | 16 |
103+
| <span>Blame.FLAG.</span>USE_MAILMAP | 32 |
98104

api/branch/index.md

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,8 @@ sections:
1818
"remoteName": "#remoteName"
1919
"setUpstream": "#setUpstream"
2020
"upstream": "#upstream"
21+
"upstreamName": "#upstreamName"
22+
"upstreamRemote": "#upstreamRemote"
2123
"BRANCH": "#BRANCH"
2224
---
2325

@@ -208,6 +210,39 @@ Branch.upstream(branch).then(function(reference) {
208210
| [Reference](/api/reference/) | the retrieved
209211
reference. |
210212

213+
## <a name="upstreamName"></a><span>Branch.</span>upstreamName <span class="tags"><span class="async">Async</span></span>
214+
215+
```js
216+
Branch.upstreamName(repo, refname).then(function(buf) {
217+
// Use buf
218+
});
219+
```
220+
221+
| Parameters | Type | |
222+
| --- | --- | --- |
223+
| repo | [Repository](/api/repository/) | the repository where the branches live |
224+
| refname | String | reference name of the local branch. |
225+
226+
| Returns | |
227+
| --- | --- |
228+
| [Buf](/api/buf/) | |
229+
230+
## <a name="upstreamRemote"></a><span>Branch.</span>upstreamRemote <span class="tags"><span class="sync">Sync</span></span>
231+
232+
```js
233+
var result = Branch.upstreamRemote(buf, repo, refname);
234+
```
235+
236+
| Parameters | Type | |
237+
| --- | --- | --- |
238+
| buf | [Buf](/api/buf/) | the buffer into which to write the name |
239+
| repo | [Repository](/api/repository/) | the repository in which to look |
240+
| refname | String | the full name of the branch |
241+
242+
| Returns | |
243+
| --- | --- |
244+
| Number | 0 or an error code |
245+
211246
## <a name="BRANCH"></a><span>Branch.</span>BRANCH <span class="tags"><span class="enum">ENUM</span></span>
212247

213248
| Flag | Value |

api/buf/index.md

Lines changed: 24 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -8,9 +8,11 @@ return_to:
88
"API Documentation Index": /api/
99
sections:
1010
"#containsNul": "#containsNul"
11+
"#dispose": "#dispose"
1112
"#grow": "#grow"
1213
"#isBinary": "#isBinary"
1314
"#set": "#set"
15+
"#setString": "#setString"
1416
"Instance Variables": "#ivars"
1517
---
1618

@@ -24,12 +26,16 @@ var result = buf.containsNul();
2426
| --- | --- |
2527
| Number | 1 if buffer contains a NUL byte |
2628

27-
## <a name="grow"></a><span>Buf#</span>grow <span class="tags"><span class="async">Async</span><span class="experimental">Experimental</span></span>
29+
## <a name="dispose"></a><span>Buf#</span>dispose <span class="tags"><span class="sync">Sync</span><span class="experimental">Experimental</span></span>
2830

2931
```js
30-
buf.grow(target_size).then(function(result) {
31-
// Use result
32-
});
32+
buf.dispose();
33+
```
34+
35+
## <a name="grow"></a><span>Buf#</span>grow <span class="tags"><span class="sync">Sync</span><span class="experimental">Experimental</span></span>
36+
37+
```js
38+
var result = buf.grow(target_size);
3339
```
3440

3541
| Parameters | Type |
@@ -50,12 +56,10 @@ var result = buf.isBinary();
5056
| --- | --- |
5157
| Number | 1 if buffer looks like non-text data |
5258

53-
## <a name="set"></a><span>Buf#</span>set <span class="tags"><span class="async">Async</span><span class="experimental">Experimental</span></span>
59+
## <a name="set"></a><span>Buf#</span>set <span class="tags"><span class="sync">Sync</span><span class="experimental">Experimental</span></span>
5460

5561
```js
56-
buf.set(data, datalen).then(function(result) {
57-
// Use result
58-
});
62+
var result = buf.set(data, datalen);
5963
```
6064

6165
| Parameters | Type |
@@ -67,6 +71,18 @@ buf.set(data, datalen).then(function(result) {
6771
| --- | --- |
6872
| Number | 0 on success, -1 on allocation failure |
6973

74+
## <a name="setString"></a><span>Buf#</span>setString <span class="tags"><span class="sync">Sync</span></span>
75+
76+
```js
77+
buf.setString(The);
78+
```
79+
80+
Sets the content of a GitBuf to a string.
81+
82+
| Parameters | Type |
83+
| --- | --- | --- |
84+
| The | string | utf8 value to set in the buffer. The string will be null terminated. |
85+
7086
## <a name="ivars"></a>Instance Variables
7187

7288
| Variable | Type | Description |

api/cert_hostkey/index.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,8 +14,8 @@ sections:
1414

1515
| Variable | Type | Description |
1616
| --- | --- | --- |
17-
| <a name="hashMd5"></a>hashMd5 | Char16 | |
18-
| <a name="hashSha1"></a>hashSha1 | Char20 | |
17+
| <a name="hashMd5"></a>hashMd5 | String | |
18+
| <a name="hashSha1"></a>hashSha1 | String | |
1919
| <a name="parent"></a>parent | Cert | |
2020
| <a name="type"></a>type | Number | |
2121

api/checkout_perfdata/index.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
---
2+
layout: default
3+
menu_item: api
4+
title: CheckoutPerfdata
5+
description: Version 0.24.0
6+
menu_item: api
7+
return_to:
8+
"API Documentation Index": /api/
9+
sections:
10+
"Instance Variables": "#ivars"
11+
---
12+
13+
## <a name="ivars"></a>Instance Variables
14+
15+
| Variable | Type | Description |
16+
| --- | --- | --- |
17+
| <a name="chmodCalls"></a>chmodCalls | Number | |
18+
| <a name="mkdirCalls"></a>mkdirCalls | Number | |
19+
| <a name="statCalls"></a>statCalls | Number | |
20+

0 commit comments

Comments
 (0)