Skip to content

Commit 7138232

Browse files
committed
Regen Luadocs.
1 parent 25084c8 commit 7138232

29 files changed

+1352
-1479
lines changed

docs/git2/Blob.luadoc

+8-10
Original file line numberDiff line numberDiff line change
@@ -20,24 +20,22 @@ end
2020

2121
--- module function.
2222
--
23-
-- <p>Calls <a href="http://libgit2.github.com/libgit2/#HEAD/group/blob/git_blob_create_fromfile">git_blob_create_fromfile</a>:<p><p>
24-
-- @param repo repository where the blob will be written. this repository cannot be bare. Must be of type <a href="Repository.html">Repository</a>.
25-
-- @param path file from which the blob will be created, relative to the repository's working dir. Must be of type <code>string</code>.
23+
-- @param repo Must be of type <a href="Repository.html">Repository</a>.
24+
-- @param path Must be of type <code>string</code>.
2625
-- @return <a href="OID.html">OID</a> or <code>nil</code> on error.
2726
-- @return Error string.
28-
-- @name Blob.fromfile
29-
function Blob.fromfile(repo, path)
27+
-- @name Blob.from_disk
28+
function Blob.from_disk(repo, path)
3029
end
3130

3231
--- module function.
3332
--
34-
-- <p>Calls <a href="http://libgit2.github.com/libgit2/#HEAD/group/blob/git_blob_create_frombuffer">git_blob_create_frombuffer</a>:<p><p>
35-
-- @param repo repository where to blob will be written. Must be of type <a href="Repository.html">Repository</a>.
36-
-- @param buffer data to be written into the blob. Must be of type <code>string</code>.
33+
-- @param repo Must be of type <a href="Repository.html">Repository</a>.
34+
-- @param buffer Must be of type <code>string</code>.
3735
-- @return <a href="OID.html">OID</a> or <code>nil</code> on error.
3836
-- @return Error string.
39-
-- @name Blob.frombuffer
40-
function Blob.frombuffer(repo, buffer)
37+
-- @name Blob.from_buffer
38+
function Blob.from_buffer(repo, buffer)
4139
end
4240

4341
--- object method.

docs/git2/Config.luadoc

+17-6
Original file line numberDiff line numberDiff line change
@@ -45,11 +45,13 @@ end
4545
-- of the config file instances in order (instances with
4646
-- a higher priority will be accessed first).
4747
-- @param path path to the configuration file (backend) to add. Must be of type <code>string</code>.
48-
-- @param priority the priority the backend should have. Must be of type <code>integer</code>.
48+
-- @param level Must be of type <code>integer</code>.
49+
-- @param repo Must be of type <a href="Repository.html">Repository</a>.
50+
-- @param force Must be of type <code>integer</code>.
4951
-- @return <code>true</code> if no error.
5052
-- @return Error string.
5153
-- @name Config:add_file_ondisk
52-
function Config:add_file_ondisk(path, priority)
54+
function Config:add_file_ondisk(path, level, repo, force)
5355
end
5456

5557
--- object method.
@@ -137,11 +139,20 @@ end
137139

138140
--- object method.
139141
--
140-
-- <p>Calls <a href="http://libgit2.github.com/libgit2/#HEAD/group/config/git_config_delete">git_config_delete</a>:<p><p>
141-
-- @param name the variable to delete. Must be of type <code>string</code>.
142+
-- @param name Must be of type <code>string</code>.
143+
-- @return <code>true</code> if no error.
144+
-- @return Error string.
145+
-- @name Config:delete_entry
146+
function Config:delete_entry(name)
147+
end
148+
149+
--- object method.
150+
--
151+
-- @param name Must be of type <code>string</code>.
152+
-- @param regexp Must be of type <code>string</code>.
142153
-- @return <code>true</code> if no error.
143154
-- @return Error string.
144-
-- @name Config:delete
145-
function Config:delete(name)
155+
-- @name Config:delete_multivar
156+
function Config:delete_multivar(name, regexp)
146157
end
147158

docs/git2/Index.luadoc

+32-58
Original file line numberDiff line numberDiff line change
@@ -29,10 +29,11 @@ end
2929
--- object method.
3030
--
3131
-- <p>Calls <a href="http://libgit2.github.com/libgit2/#HEAD/group/index/git_index_read">git_index_read</a>:<p><p>
32+
-- @param force Must be of type <code>integer</code>.
3233
-- @return <code>true</code> if no error.
3334
-- @return Error string.
3435
-- @name Index:read
35-
function Index:read()
36+
function Index:read(force)
3637
end
3738

3839
--- object method.
@@ -47,17 +48,20 @@ end
4748
--- object method.
4849
--
4950
-- <p>Calls <a href="http://libgit2.github.com/libgit2/#HEAD/group/index/git_index_find">git_index_find</a>:<p><p>
51+
-- @param at_pos Must be of type <code>lightuserdata</code>.
5052
-- @param path path to search. Must be of type <code>string</code>.
5153
-- @return <code>integer</code>.
5254
-- @name Index:find
53-
function Index:find(path)
55+
function Index:find(at_pos, path)
5456
end
5557

5658
--- object method.
5759
--
58-
-- <p>Calls <a href="http://libgit2.github.com/libgit2/#HEAD/group/index/git_index_uniq">git_index_uniq</a>:<p><p>
59-
-- @name Index:uniq
60-
function Index:uniq()
60+
-- @param path Must be of type <code>string</code>.
61+
-- @return <code>true</code> if no error.
62+
-- @return Error string.
63+
-- @name Index:add_bypath
64+
function Index:add_bypath(path)
6165
end
6266

6367
--- object method.
@@ -66,64 +70,39 @@ end
6670
-- working folder and must be readable.<p> This method will fail in bare index instances.<p> This forces the file to be added to the index, not looking
6771
-- at gitignore rules. Those rules can be evaluated through
6872
-- the git_status APIs (in status.h) before calling this.
69-
-- @param path filename to add. Must be of type <code>string</code>.
70-
-- @param stage stage for the entry. Must be of type <code>integer</code>.
71-
-- @return <code>true</code> if no error.
72-
-- @return Error string.
73-
-- @name Index:add
74-
function Index:add(path, stage)
75-
end
76-
77-
--- object method.
78-
--
7973
-- @param source_entry Must be of type <a href="IndexEntry.html">IndexEntry</a>.
8074
-- @return <code>true</code> if no error.
8175
-- @return Error string.
82-
-- @name Index:add2
83-
function Index:add2(source_entry)
84-
end
85-
86-
--- object method.
87-
--
88-
-- <p>Calls <a href="http://libgit2.github.com/libgit2/#HEAD/group/index/git_index_append">git_index_append</a>:<p><p>A new entry will always be inserted into the index;
89-
-- if the index already contains an entry for such
90-
-- path, the old entry will **not** be replaced.<p> The file `path` must be relative to the repository's
91-
-- working folder and must be readable.<p> This method will fail in bare index instances.
92-
-- @param path filename to add. Must be of type <code>string</code>.
93-
-- @param stage stage for the entry. Must be of type <code>integer</code>.
94-
-- @return <code>true</code> if no error.
95-
-- @return Error string.
96-
-- @name Index:append
97-
function Index:append(path, stage)
76+
-- @name Index:add
77+
function Index:add(source_entry)
9878
end
9979

10080
--- object method.
10181
--
102-
-- @param source_entry Must be of type <a href="IndexEntry.html">IndexEntry</a>.
82+
-- <p>Calls <a href="http://libgit2.github.com/libgit2/#HEAD/group/index/git_index_remove">git_index_remove</a>:<p><p>
83+
-- @param path Must be of type <code>string</code>.
84+
-- @param stage Must be of type <code>integer</code>.
10385
-- @return <code>true</code> if no error.
10486
-- @return Error string.
105-
-- @name Index:append2
106-
function Index:append2(source_entry)
87+
-- @name Index:remove
88+
function Index:remove(path, stage)
10789
end
10890

10991
--- object method.
11092
--
111-
-- <p>Calls <a href="http://libgit2.github.com/libgit2/#HEAD/group/index/git_index_remove">git_index_remove</a>:<p><p>
112-
-- @param position position of the entry to remove. Must be of type <code>integer</code>.
113-
-- @return <code>true</code> if no error.
114-
-- @return Error string.
115-
-- @name Index:remove
116-
function Index:remove(position)
93+
-- @param n Must be of type <code>integer</code>.
94+
-- @return <a href="IndexEntry.html">IndexEntry</a>.
95+
-- @name Index:get_byindex
96+
function Index:get_byindex(n)
11797
end
11898

11999
--- object method.
120100
--
121-
-- <p>Calls <a href="http://libgit2.github.com/libgit2/#HEAD/group/index/git_index_get">git_index_get</a>:<p><p>This entry can be modified, and the changes will be written
122-
-- back to disk on the next write() call.<p> The entry should not be freed by the caller.
123-
-- @param n the position of the entry. Must be of type <code>integer</code>.
101+
-- @param path Must be of type <code>string</code>.
102+
-- @param stage Must be of type <code>integer</code>.
124103
-- @return <a href="IndexEntry.html">IndexEntry</a>.
125-
-- @name Index:get
126-
function Index:get(n)
104+
-- @name Index:get_bypath
105+
function Index:get_bypath(path, stage)
127106
end
128107

129108
--- object method.
@@ -136,30 +115,25 @@ end
136115

137116
--- object method.
138117
--
139-
-- <p>Calls <a href="http://libgit2.github.com/libgit2/#HEAD/group/index/git_index_entrycount_unmerged">git_index_entrycount_unmerged</a>:<p><p>
140118
-- @return <code>integer</code>.
141-
-- @name Index:entrycount_unmerged
142-
function Index:entrycount_unmerged()
119+
-- @name Index:reuc_entrycount
120+
function Index:reuc_entrycount()
143121
end
144122

145123
--- object method.
146124
--
147-
-- <p>Calls <a href="http://libgit2.github.com/libgit2/#HEAD/group/index/git_index_get_unmerged_bypath">git_index_get_unmerged_bypath</a>:<p><p>The returned entry is read-only and should not be modified
148-
-- of freed by the caller.
149-
-- @param path path to search. Must be of type <code>string</code>.
125+
-- @param path Must be of type <code>string</code>.
150126
-- @return <a href="IndexEntryUnmerged.html">IndexEntryUnmerged</a>.
151-
-- @name Index:get_unmerged_bypath
152-
function Index:get_unmerged_bypath(path)
127+
-- @name Index:reuc_get_bypath
128+
function Index:reuc_get_bypath(path)
153129
end
154130

155131
--- object method.
156132
--
157-
-- <p>Calls <a href="http://libgit2.github.com/libgit2/#HEAD/group/index/git_index_get_unmerged_byindex">git_index_get_unmerged_byindex</a>:<p><p>The returned entry is read-only and should not be modified
158-
-- of freed by the caller.
159-
-- @param n the position of the entry. Must be of type <code>integer</code>.
133+
-- @param n Must be of type <code>integer</code>.
160134
-- @return <a href="IndexEntryUnmerged.html">IndexEntryUnmerged</a>.
161-
-- @name Index:get_unmerged_byindex
162-
function Index:get_unmerged_byindex(n)
135+
-- @name Index:reuc_get_byindex
136+
function Index:reuc_get_byindex(n)
163137
end
164138

165139
--- object method.

docs/git2/IndexEntry.luadoc

+2-2
Original file line numberDiff line numberDiff line change
@@ -113,8 +113,8 @@ end
113113
--- object method.
114114
--
115115
-- @return <a href="OID.html">OID</a>.
116-
-- @name IndexEntry:oid
117-
function IndexEntry:oid()
116+
-- @name IndexEntry:id
117+
function IndexEntry:id()
118118
end
119119

120120
--- object method.

docs/git2/Reference.luadoc

+10-42
Original file line numberDiff line numberDiff line change
@@ -17,30 +17,10 @@ module("Reference")
1717
function Reference.lookup(repo, name)
1818
end
1919

20-
--- object method.
21-
--
22-
-- <p>Calls <a href="http://libgit2.github.com/libgit2/#HEAD/group/reference/git_reference_oid">git_reference_oid</a>:<p><p>Only available if the reference is direct (i.e. not symbolic)
23-
-- @return <a href="OID.html">OID</a>.
24-
-- @name Reference:oid
25-
function Reference:oid()
26-
end
27-
28-
--- object method.
29-
--
30-
-- <p>Calls <a href="http://libgit2.github.com/libgit2/#HEAD/group/reference/git_reference_set_oid">git_reference_set_oid</a>:<p><p>The reference must be a direct reference, otherwise
31-
-- this method will fail.<p> The reference will be automatically updated in
32-
-- memory and on disk.
33-
-- @param oid Must be of type <a href="OID.html">OID</a>.
34-
-- @return <code>true</code> if no error.
35-
-- @return Error string.
36-
-- @name Reference:set_oid
37-
function Reference:set_oid(oid)
38-
end
39-
4020
--- object method.
4121
--
4222
-- <p>Calls <a href="http://libgit2.github.com/libgit2/#HEAD/group/reference/git_reference_target">git_reference_target</a>:<p><p>Only available if the reference is symbolic
43-
-- @return <code>string</code>.
23+
-- @return <a href="OID.html">OID</a>.
4424
-- @name Reference:target
4525
function Reference:target()
4626
end
@@ -50,11 +30,12 @@ end
5030
-- <p>Calls <a href="http://libgit2.github.com/libgit2/#HEAD/group/reference/git_reference_set_target">git_reference_set_target</a>:<p><p>The reference must be a symbolic reference, otherwise
5131
-- this method will fail.<p> The reference will be automatically updated in
5232
-- memory and on disk.
53-
-- @param target The new target for the reference. Must be of type <code>string</code>.
54-
-- @return <code>true</code> if no error.
33+
-- @param oid Must be of type <a href="OID.html">OID</a>.
34+
-- @param log_message Must be of type <code>string</code>.
35+
-- @return <a href="Reference.html">Reference</a> or <code>nil</code> on error.
5536
-- @return Error string.
5637
-- @name Reference:set_target
57-
function Reference:set_target(target)
38+
function Reference:set_target(oid, log_message)
5839
end
5940

6041
--- object method.
@@ -106,11 +87,12 @@ end
10687
-- reflog is enabled for the repository. We only rename
10788
-- the reflog if it exists.
10889
-- @param new_name The new name for the reference. Must be of type <code>string</code>.
109-
-- @param force Overwrite an existing reference. Must be of type <code>boolean</code>.
110-
-- @return <code>true</code> if no error.
90+
-- @param force Overwrite an existing reference. Must be of type <code>integer</code>.
91+
-- @param log_message Must be of type <code>string</code>.
92+
-- @return <a href="Reference.html">Reference</a> or <code>nil</code> on error.
11193
-- @return Error string.
11294
-- @name Reference:rename
113-
function Reference:rename(new_name, force)
95+
function Reference:rename(new_name, force, log_message)
11496
end
11597

11698
--- object method.
@@ -123,26 +105,12 @@ end
123105
function Reference:delete()
124106
end
125107

126-
--- module function.
127-
--
128-
-- <p>Calls <a href="http://libgit2.github.com/libgit2/#HEAD/group/reference/git_reference_packall">git_reference_packall</a>:<p><p>This method will load into the cache all the loose
129-
-- references on the repository and update the
130-
-- `packed-refs` file with them.<p> Once the `packed-refs` file has been written properly,
131-
-- the loose references will be removed from disk.
132-
-- @param repo Repository where the loose refs will be packed. Must be of type <a href="Repository.html">Repository</a>.
133-
-- @return <code>true</code> if no error.
134-
-- @return Error string.
135-
-- @name Reference.packall
136-
function Reference.packall(repo)
137-
end
138-
139108
--- module function.
140109
--
141110
-- @param repo Must be of type <a href="Repository.html">Repository</a>.
142-
-- @param list_flags Must be of type <code>integer</code>.
143111
-- @return <a href="StrArray.html">StrArray</a> or <code>nil</code> on error.
144112
-- @return Error string.
145113
-- @name Reference.list
146-
function Reference.list(repo, list_flags)
114+
function Reference.list(repo)
147115
end
148116

docs/git2/Repository.luadoc

+4-5
Original file line numberDiff line numberDiff line change
@@ -50,11 +50,9 @@ end
5050

5151
--- object method.
5252
--
53-
-- <p>Calls <a href="http://libgit2.github.com/libgit2/#HEAD/group/repository/git_repository_head_orphan">git_repository_head_orphan</a>:<p><p>An orphan branch is one named from HEAD but which doesn't exist in
54-
-- the refs namespace, because it doesn't have any commit to point to.
5553
-- @return <code>boolean</code>.
56-
-- @name Repository:head_orphan
57-
function Repository:head_orphan()
54+
-- @name Repository:head_unborn
55+
function Repository:head_unborn()
5856
end
5957

6058
--- object method.
@@ -100,10 +98,11 @@ end
10098
-- all the common workdir operations (checkout, status, index
10199
-- manipulation, etc).
102100
-- @param workdir The path to a working directory. Must be of type <code>string</code>.
101+
-- @param update_gitlink Must be of type <code>integer</code>.
103102
-- @return <code>true</code> if no error.
104103
-- @return Error string.
105104
-- @name Repository:set_workdir
106-
function Repository:set_workdir(workdir)
105+
function Repository:set_workdir(workdir, update_gitlink)
107106
end
108107

109108
--- object method.

docs/git2/TreeEntry.luadoc

+2-3
Original file line numberDiff line numberDiff line change
@@ -16,10 +16,9 @@ end
1616

1717
--- object method.
1818
--
19-
-- <p>Calls <a href="http://libgit2.github.com/libgit2/#HEAD/group/tree/git_tree_entry_attributes">git_tree_entry_attributes</a>:<p><p>
2019
-- @return <code>integer</code>.
21-
-- @name TreeEntry:attributes
22-
function TreeEntry:attributes()
20+
-- @name TreeEntry:filemode
21+
function TreeEntry:filemode()
2322
end
2423

2524
--- object method.

0 commit comments

Comments
 (0)