Skip to content

Commit 0bf776c

Browse files
author
John Haley
committed
Update page to 0.6.3 docs
1 parent 2a02612 commit 0bf776c

File tree

18 files changed

+346
-171
lines changed

18 files changed

+346
-171
lines changed

‎api/annotated_commit/index.md‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ sections:
1515
"#id": "#id"
1616
---
1717

18-
## <a name="fromFetchhead"></a><span>AnnotatedCommit.</span>fromFetchhead <span class="tags"><span class="async">Async</span><span class="experimental">Experimental</span></span>
18+
## <a name="fromFetchhead"></a><span>AnnotatedCommit.</span>fromFetchhead <span class="tags"><span class="async">Async</span></span>
1919

2020
```js
2121
AnnotatedCommit.fromFetchhead(repo, branch_name, remote_url, id).then(function(annotatedCommit) {
@@ -34,7 +34,7 @@ AnnotatedCommit.fromFetchhead(repo, branch_name, remote_url, id).then(function(a
3434
| --- | --- |
3535
| [AnnotatedCommit](/api/annotated_commit/) | |
3636

37-
## <a name="fromRef"></a><span>AnnotatedCommit.</span>fromRef <span class="tags"><span class="async">Async</span><span class="experimental">Experimental</span></span>
37+
## <a name="fromRef"></a><span>AnnotatedCommit.</span>fromRef <span class="tags"><span class="async">Async</span></span>
3838

3939
```js
4040
AnnotatedCommit.fromRef(repo, ref).then(function(annotatedCommit) {
@@ -51,7 +51,7 @@ AnnotatedCommit.fromRef(repo, ref).then(function(annotatedCommit) {
5151
| --- | --- |
5252
| [AnnotatedCommit](/api/annotated_commit/) | |
5353

54-
## <a name="fromRevspec"></a><span>AnnotatedCommit.</span>fromRevspec <span class="tags"><span class="async">Async</span><span class="experimental">Experimental</span></span>
54+
## <a name="fromRevspec"></a><span>AnnotatedCommit.</span>fromRevspec <span class="tags"><span class="async">Async</span></span>
5555

5656
```js
5757
AnnotatedCommit.fromRevspec(repo, revspec).then(function(annotatedCommit) {
@@ -68,7 +68,7 @@ AnnotatedCommit.fromRevspec(repo, revspec).then(function(annotatedCommit) {
6868
| --- | --- |
6969
| [AnnotatedCommit](/api/annotated_commit/) | |
7070

71-
## <a name="lookup"></a><span>AnnotatedCommit.</span>lookup <span class="tags"><span class="async">Async</span><span class="experimental">Experimental</span></span>
71+
## <a name="lookup"></a><span>AnnotatedCommit.</span>lookup <span class="tags"><span class="async">Async</span></span>
7272

7373
```js
7474
AnnotatedCommit.lookup(repo, id).then(function(annotatedCommit) {
@@ -85,13 +85,13 @@ AnnotatedCommit.lookup(repo, id).then(function(annotatedCommit) {
8585
| --- | --- |
8686
| [AnnotatedCommit](/api/annotated_commit/) | |
8787

88-
## <a name="free"></a><span>AnnotatedCommit#</span>free <span class="tags"><span class="sync">Sync</span><span class="experimental">Experimental</span></span>
88+
## <a name="free"></a><span>AnnotatedCommit#</span>free <span class="tags"><span class="sync">Sync</span></span>
8989

9090
```js
9191
annotatedCommit.free();
9292
```
9393

94-
## <a name="id"></a><span>AnnotatedCommit#</span>id <span class="tags"><span class="sync">Sync</span><span class="experimental">Experimental</span></span>
94+
## <a name="id"></a><span>AnnotatedCommit#</span>id <span class="tags"><span class="sync">Sync</span></span>
9595

9696
```js
9797
var oid = annotatedCommit.id();

‎api/blame/index.md‎

Lines changed: 13 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -17,25 +17,21 @@ sections:
1717
"FLAG": "#FLAG"
1818
---
1919

20-
## <a name="file"></a><span>Blame.</span>file <span class="tags"><span class="async">Async</span><span class="experimental">Experimental</span></span>
20+
## <a name="file"></a><span>Blame.</span>file <span class="tags"><span class="sync">Sync</span></span>
2121

2222
```js
23-
Blame.file(repo, path, options).then(function(blame) {
24-
// Use blame
25-
});
23+
Blame.file(repo, path, [options]);
2624
```
2725

26+
Retrieve the blame of a file
27+
2828
| Parameters | Type | |
2929
| --- | --- | --- |
30-
| repo | [Repository](/api/repository/) | repository whose history is to be walked |
31-
| path | String | path to file to consider |
32-
| options | [BlameOptions](/api/blame_options/) | options for the blame operation. If NULL, this is treated as though GIT_BLAME_OPTIONS_INIT were passed. |
33-
34-
| Returns | |
35-
| --- | --- |
36-
| [Blame](/api/blame/) | |
30+
| repo | [Repository](/api/repository/) | that contains the file |
31+
| path | String | to the file to get the blame of |
32+
| [options] | [BlameOptions](/api/blame_options/) | Options for the blame |
3733

38-
## <a name="initOptions"></a><span>Blame.</span>initOptions <span class="tags"><span class="sync">Sync</span><span class="experimental">Experimental</span></span>
34+
## <a name="initOptions"></a><span>Blame.</span>initOptions <span class="tags"><span class="sync">Sync</span></span>
3935

4036
```js
4137
var result = Blame.initOptions(opts, version);
@@ -50,7 +46,7 @@ var result = Blame.initOptions(opts, version);
5046
| --- | --- |
5147
| Number | Zero on success; -1 on failure. |
5248

53-
## <a name="buffer"></a><span>Blame#</span>buffer <span class="tags"><span class="async">Async</span><span class="experimental">Experimental</span></span>
49+
## <a name="buffer"></a><span>Blame#</span>buffer <span class="tags"><span class="async">Async</span></span>
5450

5551
```js
5652
blame.buffer(buffer, buffer_len).then(function(blame) {
@@ -67,13 +63,13 @@ blame.buffer(buffer, buffer_len).then(function(blame) {
6763
| --- | --- |
6864
| [Blame](/api/blame/) | |
6965

70-
## <a name="free"></a><span>Blame#</span>free <span class="tags"><span class="sync">Sync</span><span class="experimental">Experimental</span></span>
66+
## <a name="free"></a><span>Blame#</span>free <span class="tags"><span class="sync">Sync</span></span>
7167

7268
```js
7369
blame.free();
7470
```
7571

76-
## <a name="getHunkByIndex"></a><span>Blame#</span>getHunkByIndex <span class="tags"><span class="sync">Sync</span><span class="experimental">Experimental</span></span>
72+
## <a name="getHunkByIndex"></a><span>Blame#</span>getHunkByIndex <span class="tags"><span class="sync">Sync</span></span>
7773

7874
```js
7975
var blameHunk = blame.getHunkByIndex(index);
@@ -87,7 +83,7 @@ var blameHunk = blame.getHunkByIndex(index);
8783
| --- | --- |
8884
| [BlameHunk](/api/blame_hunk/) | the hunk at the given index, or NULL on error |
8985

90-
## <a name="getHunkByLine"></a><span>Blame#</span>getHunkByLine <span class="tags"><span class="sync">Sync</span><span class="experimental">Experimental</span></span>
86+
## <a name="getHunkByLine"></a><span>Blame#</span>getHunkByLine <span class="tags"><span class="sync">Sync</span></span>
9187

9288
```js
9389
var blameHunk = blame.getHunkByLine(lineno);
@@ -101,7 +97,7 @@ var blameHunk = blame.getHunkByLine(lineno);
10197
| --- | --- |
10298
| [BlameHunk](/api/blame_hunk/) | the hunk that contains the given line, or NULL on error |
10399

104-
## <a name="getHunkCount"></a><span>Blame#</span>getHunkCount <span class="tags"><span class="sync">Sync</span><span class="experimental">Experimental</span></span>
100+
## <a name="getHunkCount"></a><span>Blame#</span>getHunkCount <span class="tags"><span class="sync">Sync</span></span>
105101

106102
```js
107103
var result = blame.getHunkCount();

‎api/branch/index.md‎

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -154,10 +154,12 @@ Branch.name(ref).then(function(string) {
154154
| --- | --- |
155155
| String | |
156156

157-
## <a name="setUpstream"></a><span>Branch.</span>setUpstream <span class="tags"><span class="sync">Sync</span></span>
157+
## <a name="setUpstream"></a><span>Branch.</span>setUpstream <span class="tags"><span class="async">Async</span></span>
158158

159159
```js
160-
var result = Branch.setUpstream(branch, upstream_name);
160+
Branch.setUpstream(branch, upstream_name).then(function(result) {
161+
// Use result
162+
});
161163
```
162164

163165
| Parameters | Type | |
@@ -169,10 +171,12 @@ var result = Branch.setUpstream(branch, upstream_name);
169171
| --- | --- |
170172
| Number | 0 or an error code |
171173

172-
## <a name="upstream"></a><span>Branch.</span>upstream <span class="tags"><span class="sync">Sync</span></span>
174+
## <a name="upstream"></a><span>Branch.</span>upstream <span class="tags"><span class="async">Async</span></span>
173175

174176
```js
175-
var reference = Branch.upstream(branch);
177+
Branch.upstream(branch).then(function(reference) {
178+
// Use reference
179+
});
176180
```
177181

178182
| Parameters | Type | |

‎api/commit/index.md‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,7 @@ sections:
1717
"#date": "#date"
1818
"#free": "#free"
1919
"#getDiff": "#getDiff"
20+
"#getDiffWithOptions": "#getDiffWithOptions"
2021
"#getEntry": "#getEntry"
2122
"#getParents": "#getParents"
2223
"#getTree": "#getTree"
@@ -200,6 +201,26 @@ and its parent(s).
200201
| --- | --- |
201202
| Array&lt;[Diff](/api/diff/)&gt; | an array of diffs |
202203

204+
## <a name="getDiffWithOptions"></a><span>Commit#</span>getDiffWithOptions <span class="tags"><span class="async">Async</span></span>
205+
206+
```js
207+
commit.getDiffWithOptions(options, callback).then(function(arrayDiff) {
208+
// Use arrayDiff
209+
});
210+
```
211+
212+
Generate an array of diff trees showing changes between this commit
213+
and its parent(s).
214+
215+
| Parameters | Type |
216+
| --- | --- | --- |
217+
| options | [Object](/api/object/) | |
218+
| callback | Function | |
219+
220+
| Returns | |
221+
| --- | --- |
222+
| Array&lt;[Diff](/api/diff/)&gt; | an array of diffs |
223+
203224
## <a name="getEntry"></a><span>Commit#</span>getEntry <span class="tags"><span class="async">Async</span></span>
204225

205226
```js

‎api/convenient_patch/index.md‎

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,7 @@ sections:
1919
"#isUnmodified": "#isUnmodified"
2020
"#isUnreadable": "#isUnreadable"
2121
"#isUntracked": "#isUntracked"
22+
"#lineStats": "#lineStats"
2223
"#newFile": "#newFile"
2324
"#oldFile": "#oldFile"
2425
"#size": "#size"
@@ -171,6 +172,18 @@ Is this an untracked patch?
171172
| --- | --- |
172173
| Boolean | |
173174

175+
## <a name="lineStats"></a><span>ConvenientPatch#</span>lineStats <span class="tags"><span class="sync">Sync</span></span>
176+
177+
```js
178+
var lineStats = convenientPatch.lineStats();
179+
```
180+
181+
The line statistics of this patch (#contexts, #added, #deleted)
182+
183+
| Returns | |
184+
| --- | --- |
185+
| lineStats | |
186+
174187
## <a name="newFile"></a><span>ConvenientPatch#</span>newFile <span class="tags"><span class="sync">Sync</span></span>
175188

176189
```js

‎api/error/index.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -38,6 +38,7 @@ sections:
3838
| <span>Error.CODE.</span>EEOF | -20 |
3939
| <span>Error.CODE.</span>EINVALID | -21 |
4040
| <span>Error.CODE.</span>EUNCOMMITTED | -22 |
41+
| <span>Error.CODE.</span>EDIRECTORY | -23 |
4142
| <span>Error.CODE.</span>PASSTHROUGH | -30 |
4243
| <span>Error.CODE.</span>ITEROVER | -31 |
4344

‎api/hashsig/index.md‎

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -52,9 +52,13 @@ Hashsig.createFromFile(path, opts).then(function(hashsig) {
5252
## <a name="compare"></a><span>Hashsig#</span>compare <span class="tags"><span class="sync">Sync</span><span class="experimental">Experimental</span></span>
5353

5454
```js
55-
var result = hashsig.compare();
55+
var result = hashsig.compare(b);
5656
```
5757

58+
| Parameters | Type |
59+
| --- | --- | --- |
60+
| b | [Hashsig](/api/hashsig/) | The second similarity signature to compare. |
61+
5862
| Returns | |
5963
| --- | --- |
6064
| Number | [0 to 100] on success as the similarity score, or error code. |

0 commit comments

Comments
 (0)