Skip to content

Commit ee34658

Browse files
committed
Update docs.
1 parent 6aa325f commit ee34658

36 files changed

+520
-671
lines changed

git2.luadoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55
--- Module git2.
66
--
7-
-- See <a href="http://libgit2.github.com/libgit2/#HEAD">libgit2 API docs</a>.
7+
-- See <a href="http://libgit2.github.io/libgit2/#HEAD">libgit2 API docs</a>.
88
--
99
-- <br />Class <a href="StrArray.html">StrArray</a>
1010
-- <br />Class <a href="Repository.html">Repository</a>

git2/Blob.luadoc

Lines changed: 16 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ module("Blob")
99

1010
--- Create a new Blob object.
1111
--
12-
-- <p>Calls <a href="http://libgit2.github.com/libgit2/#HEAD/group/blob/git_blob_lookup">git_blob_lookup</a>:<p><p>
12+
-- <p>Calls <a href="http://libgit2.github.io/libgit2/#HEAD/group/blob/git_blob_lookup">git_blob_lookup</a>:<p><p>
1313
-- @param repo the repo to use when locating the blob.. Must be of type <a href="Repository.html">Repository</a>.
1414
-- @param id identity of the blob to locate.. Must be of type <a href="OID.html">OID</a>.
1515
-- @return <a href="Blob.html">Blob</a> or <code>nil</code> on error.
@@ -20,49 +20,47 @@ 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.
4442
--
45-
-- <p>Calls <a href="http://libgit2.github.com/libgit2/#HEAD/group/blob/git_blob_rawcontent">git_blob_rawcontent</a>:<p><p>A pointer to the raw content of a blob is returned;
43+
-- <p>Calls <a href="http://libgit2.github.io/libgit2/#HEAD/group/blob/git_blob_rawcontent">git_blob_rawcontent</a>:<p><p>A pointer to the raw content of a blob is returned;
4644
-- this pointer is owned internally by the object and shall
4745
-- not be free'd. The pointer may be invalidated at a later
4846
-- time.
49-
-- <p>Calls <a href="http://libgit2.github.com/libgit2/#HEAD/group/blob/git_blob_rawsize">git_blob_rawsize</a>:<p><p>
47+
-- <p>Calls <a href="http://libgit2.github.io/libgit2/#HEAD/group/blob/git_blob_rawsize">git_blob_rawsize</a>:<p><p>
5048
-- @return <code>string</code>.
5149
-- @name Blob:rawcontent
5250
function Blob:rawcontent()
5351
end
5452

5553
--- object method.
5654
--
57-
-- <p>Calls <a href="http://libgit2.github.com/libgit2/#HEAD/group/blob/git_blob_rawsize">git_blob_rawsize</a>:<p><p>
55+
-- <p>Calls <a href="http://libgit2.github.io/libgit2/#HEAD/group/blob/git_blob_rawsize">git_blob_rawsize</a>:<p><p>
5856
-- @return <code>integer</code>.
5957
-- @name Blob:rawsize
6058
function Blob:rawsize()
6159
end
6260

6361
--- Destroy this object (will be called by Garbage Collector).
6462
--
65-
-- <p>Calls <a href="http://libgit2.github.com/libgit2/#HEAD/group/object/git_object_free">git_object_free</a>:<p><p>This method instructs the library to close an existing
63+
-- <p>Calls <a href="http://libgit2.github.io/libgit2/#HEAD/group/object/git_object_free">git_object_free</a>:<p><p>This method instructs the library to close an existing
6664
-- object; note that git_objects are owned and cached by the repository
6765
-- so the object may or may not be freed after this library call,
6866
-- depending on how agressive is the caching mechanism used
@@ -75,23 +73,23 @@ end
7573

7674
--- object method.
7775
--
78-
-- <p>Calls <a href="http://libgit2.github.com/libgit2/#HEAD/group/object/git_object_id">git_object_id</a>:<p><p>
76+
-- <p>Calls <a href="http://libgit2.github.io/libgit2/#HEAD/group/object/git_object_id">git_object_id</a>:<p><p>
7977
-- @return <a href="OID.html">OID</a>.
8078
-- @name Object:id
8179
function Object:id()
8280
end
8381

8482
--- object method.
8583
--
86-
-- <p>Calls <a href="http://libgit2.github.com/libgit2/#HEAD/group/object/git_object_type">git_object_type</a>:<p><p>
84+
-- <p>Calls <a href="http://libgit2.github.io/libgit2/#HEAD/group/object/git_object_type">git_object_type</a>:<p><p>
8785
-- @return <code>string</code>.
8886
-- @name Object:type
8987
function Object:type()
9088
end
9189

9290
--- object method.
9391
--
94-
-- <p>Calls <a href="http://libgit2.github.com/libgit2/#HEAD/group/object/git_object_owner">git_object_owner</a>:<p><p>Freeing or calling `git_repository_close` on the
92+
-- <p>Calls <a href="http://libgit2.github.io/libgit2/#HEAD/group/object/git_object_owner">git_object_owner</a>:<p><p>Freeing or calling `git_repository_close` on the
9593
-- returned pointer will invalidate the actual object.<p> Any other operation may be run on the repository without
9694
-- affecting the object.
9795
-- @return <a href="Repository.html">Repository</a>.

git2/Commit.luadoc

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ module("Commit")
99

1010
--- Create a new Commit object.
1111
--
12-
-- <p>Calls <a href="http://libgit2.github.com/libgit2/#HEAD/group/commit/git_commit_lookup">git_commit_lookup</a>:<p><p>
12+
-- <p>Calls <a href="http://libgit2.github.io/libgit2/#HEAD/group/commit/git_commit_lookup">git_commit_lookup</a>:<p><p>
1313
-- @param repo the repo to use when locating the commit.. Must be of type <a href="Repository.html">Repository</a>.
1414
-- @param id identity of the commit to locate. If the object is an annotated tag it will be peeled back to the commit.. Must be of type <a href="OID.html">OID</a>.
1515
-- @return <a href="Commit.html">Commit</a> or <code>nil</code> on error.
@@ -37,15 +37,15 @@ end
3737

3838
--- object method.
3939
--
40-
-- <p>Calls <a href="http://libgit2.github.com/libgit2/#HEAD/group/commit/git_commit_id">git_commit_id</a>:<p><p>
40+
-- <p>Calls <a href="http://libgit2.github.io/libgit2/#HEAD/group/commit/git_commit_id">git_commit_id</a>:<p><p>
4141
-- @return <a href="OID.html">OID</a>.
4242
-- @name Commit:id
4343
function Commit:id()
4444
end
4545

4646
--- object method.
4747
--
48-
-- <p>Calls <a href="http://libgit2.github.com/libgit2/#HEAD/group/commit/git_commit_message_encoding">git_commit_message_encoding</a>:<p><p>The encoding may be NULL if the `encoding` header
48+
-- <p>Calls <a href="http://libgit2.github.io/libgit2/#HEAD/group/commit/git_commit_message_encoding">git_commit_message_encoding</a>:<p><p>The encoding may be NULL if the `encoding` header
4949
-- in the commit is missing; in that case UTF-8 is assumed.
5050
-- @return <code>string</code>.
5151
-- @name Commit:message_encoding
@@ -54,47 +54,47 @@ end
5454

5555
--- object method.
5656
--
57-
-- <p>Calls <a href="http://libgit2.github.com/libgit2/#HEAD/group/commit/git_commit_message">git_commit_message</a>:<p><p>
57+
-- <p>Calls <a href="http://libgit2.github.io/libgit2/#HEAD/group/commit/git_commit_message">git_commit_message</a>:<p><p>
5858
-- @return <code>string</code>.
5959
-- @name Commit:message
6060
function Commit:message()
6161
end
6262

6363
--- object method.
6464
--
65-
-- <p>Calls <a href="http://libgit2.github.com/libgit2/#HEAD/group/commit/git_commit_time">git_commit_time</a>:<p><p>
65+
-- <p>Calls <a href="http://libgit2.github.io/libgit2/#HEAD/group/commit/git_commit_time">git_commit_time</a>:<p><p>
6666
-- @return <code>integer</code>.
6767
-- @name Commit:time
6868
function Commit:time()
6969
end
7070

7171
--- object method.
7272
--
73-
-- <p>Calls <a href="http://libgit2.github.com/libgit2/#HEAD/group/commit/git_commit_time_offset">git_commit_time_offset</a>:<p><p>
73+
-- <p>Calls <a href="http://libgit2.github.io/libgit2/#HEAD/group/commit/git_commit_time_offset">git_commit_time_offset</a>:<p><p>
7474
-- @return <code>integer</code>.
7575
-- @name Commit:time_offset
7676
function Commit:time_offset()
7777
end
7878

7979
--- object method.
8080
--
81-
-- <p>Calls <a href="http://libgit2.github.com/libgit2/#HEAD/group/commit/git_commit_committer">git_commit_committer</a>:<p><p>
81+
-- <p>Calls <a href="http://libgit2.github.io/libgit2/#HEAD/group/commit/git_commit_committer">git_commit_committer</a>:<p><p>
8282
-- @return <a href="Signature.html">Signature</a>.
8383
-- @name Commit:committer
8484
function Commit:committer()
8585
end
8686

8787
--- object method.
8888
--
89-
-- <p>Calls <a href="http://libgit2.github.com/libgit2/#HEAD/group/commit/git_commit_author">git_commit_author</a>:<p><p>
89+
-- <p>Calls <a href="http://libgit2.github.io/libgit2/#HEAD/group/commit/git_commit_author">git_commit_author</a>:<p><p>
9090
-- @return <a href="Signature.html">Signature</a>.
9191
-- @name Commit:author
9292
function Commit:author()
9393
end
9494

9595
--- object method.
9696
--
97-
-- <p>Calls <a href="http://libgit2.github.com/libgit2/#HEAD/group/commit/git_commit_tree">git_commit_tree</a>:<p><p>
97+
-- <p>Calls <a href="http://libgit2.github.io/libgit2/#HEAD/group/commit/git_commit_tree">git_commit_tree</a>:<p><p>
9898
-- @return <a href="Tree.html">Tree</a> or <code>nil</code> on error.
9999
-- @return Error string.
100100
-- @name Commit:tree
@@ -103,15 +103,15 @@ end
103103

104104
--- object method.
105105
--
106-
-- <p>Calls <a href="http://libgit2.github.com/libgit2/#HEAD/group/commit/git_commit_parentcount">git_commit_parentcount</a>:<p><p>
106+
-- <p>Calls <a href="http://libgit2.github.io/libgit2/#HEAD/group/commit/git_commit_parentcount">git_commit_parentcount</a>:<p><p>
107107
-- @return <code>integer</code>.
108108
-- @name Commit:parentcount
109109
function Commit:parentcount()
110110
end
111111

112112
--- object method.
113113
--
114-
-- <p>Calls <a href="http://libgit2.github.com/libgit2/#HEAD/group/commit/git_commit_parent">git_commit_parent</a>:<p><p>
114+
-- <p>Calls <a href="http://libgit2.github.io/libgit2/#HEAD/group/commit/git_commit_parent">git_commit_parent</a>:<p><p>
115115
-- @param n the position of the parent (from 0 to `parentcount`). Must be of type <code>integer</code>.
116116
-- @return <a href="Commit.html">Commit</a> or <code>nil</code> on error.
117117
-- @return Error string.
@@ -121,7 +121,7 @@ end
121121

122122
--- Destroy this object (will be called by Garbage Collector).
123123
--
124-
-- <p>Calls <a href="http://libgit2.github.com/libgit2/#HEAD/group/object/git_object_free">git_object_free</a>:<p><p>This method instructs the library to close an existing
124+
-- <p>Calls <a href="http://libgit2.github.io/libgit2/#HEAD/group/object/git_object_free">git_object_free</a>:<p><p>This method instructs the library to close an existing
125125
-- object; note that git_objects are owned and cached by the repository
126126
-- so the object may or may not be freed after this library call,
127127
-- depending on how agressive is the caching mechanism used
@@ -134,23 +134,23 @@ end
134134

135135
--- object method.
136136
--
137-
-- <p>Calls <a href="http://libgit2.github.com/libgit2/#HEAD/group/object/git_object_id">git_object_id</a>:<p><p>
137+
-- <p>Calls <a href="http://libgit2.github.io/libgit2/#HEAD/group/object/git_object_id">git_object_id</a>:<p><p>
138138
-- @return <a href="OID.html">OID</a>.
139139
-- @name Object:id
140140
function Object:id()
141141
end
142142

143143
--- object method.
144144
--
145-
-- <p>Calls <a href="http://libgit2.github.com/libgit2/#HEAD/group/object/git_object_type">git_object_type</a>:<p><p>
145+
-- <p>Calls <a href="http://libgit2.github.io/libgit2/#HEAD/group/object/git_object_type">git_object_type</a>:<p><p>
146146
-- @return <code>string</code>.
147147
-- @name Object:type
148148
function Object:type()
149149
end
150150

151151
--- object method.
152152
--
153-
-- <p>Calls <a href="http://libgit2.github.com/libgit2/#HEAD/group/object/git_object_owner">git_object_owner</a>:<p><p>Freeing or calling `git_repository_close` on the
153+
-- <p>Calls <a href="http://libgit2.github.io/libgit2/#HEAD/group/object/git_object_owner">git_object_owner</a>:<p><p>Freeing or calling `git_repository_close` on the
154154
-- returned pointer will invalidate the actual object.<p> Any other operation may be run on the repository without
155155
-- affecting the object.
156156
-- @return <a href="Repository.html">Repository</a>.

git2/Config.luadoc

Lines changed: 25 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ module("Config")
88

99
--- Create a new Config object.
1010
--
11-
-- <p>Calls <a href="http://libgit2.github.com/libgit2/#HEAD/group/config/git_config_new">git_config_new</a>:<p><p>This object is empty, so you have to add a file to it before you
11+
-- <p>Calls <a href="http://libgit2.github.io/libgit2/#HEAD/group/config/git_config_new">git_config_new</a>:<p><p>This object is empty, so you have to add a file to it before you
1212
-- can do anything with it.
1313
-- @return <a href="Config.html">Config</a> or <code>nil</code> on error.
1414
-- @return Error string.
@@ -18,7 +18,7 @@ end
1818

1919
--- Create a new Config object.
2020
--
21-
-- <p>Calls <a href="http://libgit2.github.com/libgit2/#HEAD/group/config/git_config_open_ondisk">git_config_open_ondisk</a>:<p><p>This method is a simple utility wrapper for the following sequence
21+
-- <p>Calls <a href="http://libgit2.github.io/libgit2/#HEAD/group/config/git_config_open_ondisk">git_config_open_ondisk</a>:<p><p>This method is a simple utility wrapper for the following sequence
2222
-- of calls:
2323
-- - git_config_new
2424
-- - git_config_add_file_ondisk
@@ -31,25 +31,27 @@ end
3131

3232
--- Destroy this object (will be called by Garbage Collector).
3333
--
34-
-- <p>Calls <a href="http://libgit2.github.com/libgit2/#HEAD/group/config/git_config_free">git_config_free</a>:<p><p>
34+
-- <p>Calls <a href="http://libgit2.github.io/libgit2/#HEAD/group/config/git_config_free">git_config_free</a>:<p><p>
3535
-- @name Config:free
3636
function Config:free()
3737
end
3838

3939
--- object method.
4040
--
41-
-- <p>Calls <a href="http://libgit2.github.com/libgit2/#HEAD/group/config/git_config_add_file_ondisk">git_config_add_file_ondisk</a>:<p><p>The on-disk file pointed at by `path` will be opened and
41+
-- <p>Calls <a href="http://libgit2.github.io/libgit2/#HEAD/group/config/git_config_add_file_ondisk">git_config_add_file_ondisk</a>:<p><p>The on-disk file pointed at by `path` will be opened and
4242
-- parsed; it's expected to be a native Git config file following
4343
-- the default Git config syntax (see man git-config).<p> Note that the configuration object will free the file
4444
-- automatically.<p> Further queries on this config object will access each
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.
@@ -92,7 +94,7 @@ end
9294

9395
--- object method.
9496
--
95-
-- <p>Calls <a href="http://libgit2.github.com/libgit2/#HEAD/group/config/git_config_get_bool">git_config_get_bool</a>:<p><p>This function uses the usual C convention of 0 being false and
97+
-- <p>Calls <a href="http://libgit2.github.io/libgit2/#HEAD/group/config/git_config_get_bool">git_config_get_bool</a>:<p><p>This function uses the usual C convention of 0 being false and
9698
-- anything else true.
9799
-- @param name the variable's name. Must be of type <code>string</code>.
98100
-- @return <code>boolean</code> or <code>nil</code> on error.
@@ -103,7 +105,7 @@ end
103105

104106
--- object method.
105107
--
106-
-- <p>Calls <a href="http://libgit2.github.com/libgit2/#HEAD/group/config/git_config_set_bool">git_config_set_bool</a>:<p><p>
108+
-- <p>Calls <a href="http://libgit2.github.io/libgit2/#HEAD/group/config/git_config_set_bool">git_config_set_bool</a>:<p><p>
107109
-- @param value the value to store. Must be of type <code>boolean</code>.
108110
-- @param name the variable's name. Must be of type <code>string</code>.
109111
-- @return <code>true</code> if no error.
@@ -114,7 +116,7 @@ end
114116

115117
--- object method.
116118
--
117-
-- <p>Calls <a href="http://libgit2.github.com/libgit2/#HEAD/group/config/git_config_get_string">git_config_get_string</a>:<p><p>The string is owned by the variable and should not be freed by the
119+
-- <p>Calls <a href="http://libgit2.github.io/libgit2/#HEAD/group/config/git_config_get_string">git_config_get_string</a>:<p><p>The string is owned by the variable and should not be freed by the
118120
-- user.
119121
-- @param name the variable's name. Must be of type <code>string</code>.
120122
-- @return <code>string</code> or <code>nil</code> on error.
@@ -125,7 +127,7 @@ end
125127

126128
--- object method.
127129
--
128-
-- <p>Calls <a href="http://libgit2.github.com/libgit2/#HEAD/group/config/git_config_set_string">git_config_set_string</a>:<p><p>A copy of the string is made and the user is free to use it
130+
-- <p>Calls <a href="http://libgit2.github.io/libgit2/#HEAD/group/config/git_config_set_string">git_config_set_string</a>:<p><p>A copy of the string is made and the user is free to use it
129131
-- afterwards.
130132
-- @param name the variable's name. Must be of type <code>string</code>.
131133
-- @param value the string to store.. Must be of type <code>string</code>.
@@ -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

0 commit comments

Comments
 (0)