FazBrowse GitHub Viewer | Trending |
URL:
| Home
Tools: [Download Repo ZIP]   [Original HTTPS Page]

Styled blockquote and updated guides · dawnsgithub/nodegit.github.com@59dff1b · GitHub

/ nodegit.github.com Public
forked from nodegit/nodegit.github.com

Commit 59dff1b

Browse files
tbranyen
committed
Styled blockquote and updated guides
1 parent e814a4c commit 59dff1b

35 files changed

Lines changed: 377 additions & 59 deletions

File tree

‎api/blame/index.md‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@ sections:
1010
"file": "#file"
1111
"initOptions": "#initOptions"
1212
"#buffer": "#buffer"
13+
"#free": "#free"
1314
"#getHunkByIndex": "#getHunkByIndex"
1415
"#getHunkByLine": "#getHunkByLine"
1516
"#getHunkCount": "#getHunkCount"
@@ -66,6 +67,12 @@ blame.buffer(buffer, buffer_len).then(function(blame) {
6667
| --- | --- |
6768
| [Blame](/api/blame/) | |
6869

70+
## <a name="free"></a><span>Blame#</span>free <span class="tags"><span class="sync">Sync</span><span class="experimental">Experimental</span></span>
71+
72+
```js
73+
blame.free();
74+
```
75+
6976
## <a name="getHunkByIndex"></a><span>Blame#</span>getHunkByIndex <span class="tags"><span class="sync">Sync</span><span class="experimental">Experimental</span></span>
7077

7178
```js

‎api/blob/index.md‎

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,7 @@ sections:
1414
"lookupPrefix": "#lookupPrefix"
1515
"#content": "#content"
1616
"#filemode": "#filemode"
17+
"#free": "#free"
1718
"#id": "#id"
1819
"#isBinary": "#isBinary"
1920
"#owner": "#owner"
@@ -25,19 +26,18 @@ sections:
2526
## <a name="createFromBuffer"></a><span>Blob.</span>createFromBuffer <span class="tags"><span class="sync">Sync</span></span>
2627

2728
```js
28-
var result = Blob.createFromBuffer(id, repo, buffer, len);
29+
var oid = Blob.createFromBuffer(repo, buffer, len);
2930
```
3031

3132
| Parameters | Type | |
3233
| --- | --- | --- |
33-
| id | [Oid](/api/oid/) | return the id of the written blob |
3434
| repo | [Repository](/api/repository/) | repository where to blob will be written |
3535
| buffer | Buffer | data to be written into the blob |
3636
| len | Number | length of the data |
3737

3838
| Returns | |
3939
| --- | --- |
40-
| Number | 0 or an error code |
40+
| [Oid](/api/oid/) | return the id of the written blob |
4141

4242
## <a name="createFromDisk"></a><span>Blob.</span>createFromDisk <span class="tags"><span class="sync">Sync</span></span>
4343

@@ -134,6 +134,12 @@ Retrieve the Blob's type.
134134
| --- | --- |
135135
| Number | The filemode of the blob. |
136136

137+
## <a name="free"></a><span>Blob#</span>free <span class="tags"><span class="sync">Sync</span></span>
138+
139+
```js
140+
blob.free();
141+
```
142+
137143
## <a name="id"></a><span>Blob#</span>id <span class="tags"><span class="sync">Sync</span></span>
138144

139145
```js

‎api/buf/index.md‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@ return_to:
88
"API Documentation Index": /api/
99
sections:
1010
"#containsNul": "#containsNul"
11+
"#free": "#free"
1112
"#grow": "#grow"
1213
"#isBinary": "#isBinary"
1314
"#set": "#set"
@@ -24,6 +25,12 @@ var result = buf.containsNul();
2425
| --- | --- |
2526
| Number | 1 if buffer contains a NUL byte |
2627

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+
2734
## <a name="grow"></a><span>Buf#</span>grow <span class="tags"><span class="async">Async</span><span class="experimental">Experimental</span></span>
2835

2936
```js

‎api/commit/index.md‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,7 @@ sections:
1515
"#author": "#author"
1616
"#committer": "#committer"
1717
"#date": "#date"
18+
"#free": "#free"
1819
"#getEntry": "#getEntry"
1920
"#getParents": "#getParents"
2021
"#getTree": "#getTree"
@@ -172,6 +173,12 @@ Retrieve the commit time as a Date object.
172173
| --- | --- |
173174
| Date | |
174175

176+
## <a name="free"></a><span>Commit#</span>free <span class="tags"><span class="sync">Sync</span></span>
177+
178+
```js
179+
commit.free();
180+
```
181+
175182
## <a name="getEntry"></a><span>Commit#</span>getEntry <span class="tags"><span class="async">Async</span></span>
176183

177184
```js

‎api/hashsig/index.md‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@ sections:
1010
"create": "#create"
1111
"createFromFile": "#createFromFile"
1212
"#compare": "#compare"
13+
"#free": "#free"
1314
"OPTION": "#OPTION"
1415
---
1516

@@ -60,6 +61,12 @@ var result = hashsig.compare();
6061
<
6162
0 for error, [0 to 100] as similarity score |
6263

64+
## <a name="free"></a><span>Hashsig#</span>free <span class="tags"><span class="sync">Sync</span><span class="experimental">Experimental</span></span>
65+
66+
```js
67+
hashsig.free();
68+
```
69+
6370
## <a name="OPTION"></a><span>Hashsig.</span>OPTION <span class="tags"><span class="enum">ENUM</span></span>
6471

6572
| Flag | Value |

‎api/index.md‎

Lines changed: 40 additions & 8 deletions
Large diffs are not rendered by default.

‎api/index/index.md‎

Lines changed: 58 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@ sections:
1010
"entryStage": "#entryStage"
1111
"open": "#open"
1212
"#add": "#add"
13+
"#addAll": "#addAll"
1314
"#addByPath": "#addByPath"
1415
"#caps": "#caps"
1516
"#clear": "#clear"
@@ -26,9 +27,11 @@ sections:
2627
"#read": "#read"
2728
"#readTree": "#readTree"
2829
"#remove": "#remove"
30+
"#removeAll": "#removeAll"
2931
"#removeByPath": "#removeByPath"
3032
"#removeDirectory": "#removeDirectory"
3133
"#setCaps": "#setCaps"
34+
"#updateAll": "#updateAll"
3235
"#write": "#write"
3336
"#writeTree": "#writeTree"
3437
"#writeTreeTo": "#writeTreeTo"
@@ -80,6 +83,25 @@ var result = index.add(source_entry);
8083
| --- | --- |
8184
| Number | 0 or an error code |
8285

86+
## <a name="addAll"></a><span>Index#</span>addAll <span class="tags"><span class="async">Async</span></span>
87+
88+
```js
89+
index.addAll(pathspec, flags, callback, payload).then(function(result) {
90+
// Use result
91+
});
92+
```
93+
94+
| Parameters | Type |
95+
| --- | --- | --- |
96+
| pathspec | [Strarray](/api/strarray/) | array of path patterns |
97+
| flags | Number | combination of git_index_add_option_t flags |
98+
| callback | IndexMatchedPathCb | notification callback for each added/updated path (also gets index of matching pathspec entry); can be NULL; return 0 to add, >0 to skip, <0 to abort scan. |
99+
| payload | Void | payload passed through to callback function |
100+
101+
| Returns | |
102+
| --- | --- |
103+
| Number | 0 on success, negative callback return value, or error code |
104+
83105
## <a name="addByPath"></a><span>Index#</span>addByPath <span class="tags"><span class="sync">Sync</span></span>
84106

85107
```js
@@ -280,6 +302,24 @@ var result = index.remove(path, stage);
280302
| --- | --- |
281303
| Number | 0 or an error code |
282304

305+
## <a name="removeAll"></a><span>Index#</span>removeAll <span class="tags"><span class="async">Async</span></span>
306+
307+
```js
308+
index.removeAll(pathspec, callback, payload).then(function(result) {
309+
// Use result
310+
});
311+
```
312+
313+
| Parameters | Type |
314+
| --- | --- | --- |
315+
| pathspec | [Strarray](/api/strarray/) | array of path patterns |
316+
| callback | IndexMatchedPathCb | notification callback for each removed path (also gets index of matching pathspec entry); can be NULL; return 0 to add, >0 to skip, <0 to abort scan. |
317+
| payload | Void | payload passed through to callback function |
318+
319+
| Returns | |
320+
| --- | --- |
321+
| Number | 0 on success, negative callback return value, or error code |
322+
283323
## <a name="removeByPath"></a><span>Index#</span>removeByPath <span class="tags"><span class="sync">Sync</span></span>
284324

285325
```js
@@ -323,6 +363,24 @@ var result = index.setCaps(caps);
323363
| --- | --- |
324364
| Number | 0 on success, -1 on failure |
325365

366+
## <a name="updateAll"></a><span>Index#</span>updateAll <span class="tags"><span class="async">Async</span></span>
367+
368+
```js
369+
index.updateAll(pathspec, callback, payload).then(function(result) {
370+
// Use result
371+
});
372+
```
373+
374+
| Parameters | Type |
375+
| --- | --- | --- |
376+
| pathspec | [Strarray](/api/strarray/) | array of path patterns |
377+
| callback | IndexMatchedPathCb | notification callback for each updated path (also gets index of matching pathspec entry); can be NULL; return 0 to add, >0 to skip, <0 to abort scan. |
378+
| payload | Void | payload passed through to callback function |
379+
380+
| Returns | |
381+
| --- | --- |
382+
| Number | 0 on success, negative callback return value, or error code |
383+
326384
## <a name="write"></a><span>Index#</span>write <span class="tags"><span class="sync">Sync</span></span>
327385

328386
```js

‎api/index_entry/index.md‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,10 @@ sections:
1010
"Instance Variables": "#ivars"
1111
---
1212

13+
```js
14+
var indexEntry = new IndexEntry();
15+
```
16+
1317
## <a name="ivars"></a>Instance Variables
1418

1519
| Variable | Type |

‎api/indexer/index.md‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@ return_to:
88
"API Documentation Index": /api/
99
sections:
1010
"#commit": "#commit"
11+
"#free": "#free"
1112
"#hash": "#hash"
1213
---
1314

@@ -25,6 +26,12 @@ var result = indexer.commit(stats);
2526
| --- | --- |
2627
| Number | |
2728

29+
## <a name="free"></a><span>Indexer#</span>free <span class="tags"><span class="sync">Sync</span><span class="experimental">Experimental</span></span>
30+
31+
```js
32+
indexer.free();
33+
```
34+
2835
## <a name="hash"></a><span>Indexer#</span>hash <span class="tags"><span class="sync">Sync</span><span class="experimental">Experimental</span></span>
2936

3037
```js

‎api/note/index.md‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,7 @@ sections:
1515
"remove": "#remove"
1616
"#author": "#author"
1717
"#committer": "#committer"
18+
"#free": "#free"
1819
"#id": "#id"
1920
"#message": "#message"
2021
---
@@ -147,6 +148,12 @@ var signature = note.committer();
147148
| --- | --- |
148149
| [Signature](/api/signature/) | the committer |
149150

151+
## <a name="free"></a><span>Note#</span>free <span class="tags"><span class="sync">Sync</span><span class="experimental">Experimental</span></span>
152+
153+
```js
154+
note.free();
155+
```
156+
150157
## <a name="id"></a><span>Note#</span>id <span class="tags"><span class="sync">Sync</span><span class="experimental">Experimental</span></span>
151158

152159
```js

0 commit comments

Comments
 (0)
Back | FazBrowse Home | New Git URL