/usr/share/gtk-doc/html/libgit2-glib-1.0/GgitIndex.html is in libgit2-glib-1.0-doc 0.26.2-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>GgitIndex: libgit2-glib Reference Manual</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
<link rel="home" href="index.html" title="libgit2-glib Reference Manual">
<link rel="up" href="rn01.html" title="API reference">
<link rel="prev" href="libgit2-glib-1.0-GgitError.html" title="GgitError">
<link rel="next" href="GgitIndexEntry.html" title="GgitIndexEntry">
<meta name="generator" content="GTK-Doc V1.25 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="5"><tr valign="middle">
<td width="100%" align="left" class="shortcuts">
<a href="#" class="shortcut">Top</a><span id="nav_description"> <span class="dim">|</span>
<a href="#GgitIndex.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span>
<a href="#GgitIndex.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_interfaces"> <span class="dim">|</span>
<a href="#GgitIndex.implemented-interfaces" class="shortcut">Implemented Interfaces</a></span><span id="nav_properties"> <span class="dim">|</span>
<a href="#GgitIndex.properties" class="shortcut">Properties</a></span>
</td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
<td><a accesskey="u" href="rn01.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="libgit2-glib-1.0-GgitError.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="GgitIndexEntry.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="GgitIndex"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="GgitIndex.top_of_page"></a>GgitIndex</span></h2>
<p>GgitIndex</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="GgitIndex.functions"></a><h2>Functions</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="functions_return">
<col class="functions_name">
</colgroup>
<tbody>
<tr>
<td class="function_type">
<a class="link" href="GgitIndex.html" title="GgitIndex"><span class="returnvalue">GgitIndex</span></a> *
</td>
<td class="function_name">
<a class="link" href="GgitIndex.html#ggit-index-open" title="ggit_index_open ()">ggit_index_open</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gboolean</span>
</td>
<td class="function_name">
<a class="link" href="GgitIndex.html#ggit-index-read" title="ggit_index_read ()">ggit_index_read</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gboolean</span>
</td>
<td class="function_name">
<a class="link" href="GgitIndex.html#ggit-index-write" title="ggit_index_write ()">ggit_index_write</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="GgitOId.html" title="GgitOId"><span class="returnvalue">GgitOId</span></a> *
</td>
<td class="function_name">
<a class="link" href="GgitIndex.html#ggit-index-write-tree" title="ggit_index_write_tree ()">ggit_index_write_tree</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gboolean</span>
</td>
<td class="function_name">
<a class="link" href="GgitIndex.html#ggit-index-remove" title="ggit_index_remove ()">ggit_index_remove</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gboolean</span>
</td>
<td class="function_name">
<a class="link" href="GgitIndex.html#ggit-index-add" title="ggit_index_add ()">ggit_index_add</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gboolean</span>
</td>
<td class="function_name">
<a class="link" href="GgitIndex.html#ggit-index-add-file" title="ggit_index_add_file ()">ggit_index_add_file</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gboolean</span>
</td>
<td class="function_name">
<a class="link" href="GgitIndex.html#ggit-index-add-path" title="ggit_index_add_path ()">ggit_index_add_path</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="GgitRepository.html" title="GgitRepository"><span class="returnvalue">GgitRepository</span></a> *
</td>
<td class="function_name">
<a class="link" href="GgitIndex.html#ggit-index-get-owner" title="ggit_index_get_owner ()">ggit_index_get_owner</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="GgitIndexEntry.html#GgitIndexEntries"><span class="returnvalue">GgitIndexEntries</span></a> *
</td>
<td class="function_name">
<a class="link" href="GgitIndex.html#ggit-index-get-entries" title="ggit_index_get_entries ()">ggit_index_get_entries</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="GgitIndexEntryResolveUndo.html#GgitIndexEntriesResolveUndo"><span class="returnvalue">GgitIndexEntriesResolveUndo</span></a> *
</td>
<td class="function_name">
<a class="link" href="GgitIndex.html#ggit-index-get-entries-resolve-undo" title="ggit_index_get_entries_resolve_undo ()">ggit_index_get_entries_resolve_undo</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="GgitIndex.properties"></a><h2>Properties</h2>
<div class="informaltable"><table class="informaltable" border="0">
<colgroup>
<col width="150px" class="properties_type">
<col width="300px" class="properties_name">
<col width="200px" class="properties_flags">
</colgroup>
<tbody><tr>
<td class="property_type">
<span class="type">GFile</span> *</td>
<td class="property_name"><a class="link" href="GgitIndex.html#GgitIndex--file" title="The “file” property">file</a></td>
<td class="property_flags">Read / Write / Construct Only</td>
</tr></tbody>
</table></div>
</div>
<div class="refsect1">
<a name="GgitIndex.other"></a><h2>Types and Values</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="name">
<col class="description">
</colgroup>
<tbody><tr>
<td class="datatype_keyword"> </td>
<td class="function_name"><a class="link" href="GgitIndex.html#GgitIndex-struct" title="GgitIndex">GgitIndex</a></td>
</tr></tbody>
</table></div>
</div>
<div class="refsect1">
<a name="GgitIndex.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="screen"> GObject
<span class="lineart">╰──</span> <a class="link" href="GgitObjectFactoryBase.html" title="GgitObjectFactoryBase">GgitObjectFactoryBase</a>
<span class="lineart">╰──</span> <a class="link" href="GgitNative.html" title="GgitNative">GgitNative</a>
<span class="lineart">╰──</span> GgitIndex
</pre>
</div>
<div class="refsect1">
<a name="GgitIndex.implemented-interfaces"></a><h2>Implemented Interfaces</h2>
<p>
GgitIndex implements
GInitable.</p>
</div>
<div class="refsect1">
<a name="GgitIndex.description"></a><h2>Description</h2>
</div>
<div class="refsect1">
<a name="GgitIndex.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="ggit-index-open"></a><h3>ggit_index_open ()</h3>
<pre class="programlisting"><a class="link" href="GgitIndex.html" title="GgitIndex"><span class="returnvalue">GgitIndex</span></a> *
ggit_index_open (<em class="parameter"><code><span class="type">GFile</span> *file</code></em>,
<em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
<p>Create a new bare Git index object as a memory representation of the Git
index file in <em class="parameter"><code>file</code></em>
, without a repository to back it.</p>
<div class="refsect3">
<a name="ggit-index-open.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>file</p></td>
<td class="parameter_description"><p>a <span class="type">GFile</span>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>error</p></td>
<td class="parameter_description"><p>a <span class="type">GError</span> for error reporting, or <code class="literal">NULL</code>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="ggit-index-open.returns"></a><h4>Returns</h4>
<p> a <a class="link" href="GgitIndex.html" title="GgitIndex"><span class="type">GgitIndex</span></a> or <code class="literal">NULL</code> if an error occurred. </p>
<p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>][<acronym title="NULL may be passed as the value in, out, in-out; or as a return value."><span class="acronym">nullable</span></acronym>]</span></p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="ggit-index-read"></a><h3>ggit_index_read ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>
ggit_index_read (<em class="parameter"><code><a class="link" href="GgitIndex.html" title="GgitIndex"><span class="type">GgitIndex</span></a> *idx</code></em>,
<em class="parameter"><code><span class="type">gboolean</span> force</code></em>,
<em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
<p>Update the contents of an existing index object in memory by reading from
the hard disk.</p>
<p>If <em class="parameter"><code>force</code></em>
is true, this performs a "hard" read that discards in-memory
changes and always reloads the on-disk index data. If there is no on-disk
version, the index will be cleared.</p>
<p>If <em class="parameter"><code>force</code></em>
is false, this does a "soft" read that reloads the index data from
disk only if it has changed since the last time it was loaded. Purely
in-memory index data will be untouched. Be aware: if there are changes on
disk, unwritten in-memory changes are discarded.</p>
<div class="refsect3">
<a name="ggit-index-read.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>idx</p></td>
<td class="parameter_description"><p>a <a class="link" href="GgitIndex.html" title="GgitIndex"><span class="type">GgitIndex</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>force</p></td>
<td class="parameter_description"><p>force read even if there are in-memory changes.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>error</p></td>
<td class="parameter_description"><p>a <span class="type">GError</span> for error reporting, or <code class="literal">NULL</code>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="ggit-index-read.returns"></a><h4>Returns</h4>
<p> <code class="literal">TRUE</code> if the index could be read from the file associated with the
index, <code class="literal">FALSE</code> otherwise.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="ggit-index-write"></a><h3>ggit_index_write ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>
ggit_index_write (<em class="parameter"><code><a class="link" href="GgitIndex.html" title="GgitIndex"><span class="type">GgitIndex</span></a> *idx</code></em>,
<em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
<p>Write an existing index object from memory back to disk using an atomic file
lock.</p>
<div class="refsect3">
<a name="ggit-index-write.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>idx</p></td>
<td class="parameter_description"><p>a <a class="link" href="GgitIndex.html" title="GgitIndex"><span class="type">GgitIndex</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>error</p></td>
<td class="parameter_description"><p>a <span class="type">GError</span> for error reporting, or <code class="literal">NULL</code>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="ggit-index-write.returns"></a><h4>Returns</h4>
<p> <code class="literal">TRUE</code> if the index was successfully written to disk, <code class="literal">FALSE</code> otherwise.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="ggit-index-write-tree"></a><h3>ggit_index_write_tree ()</h3>
<pre class="programlisting"><a class="link" href="GgitOId.html" title="GgitOId"><span class="returnvalue">GgitOId</span></a> *
ggit_index_write_tree (<em class="parameter"><code><a class="link" href="GgitIndex.html" title="GgitIndex"><span class="type">GgitIndex</span></a> *idx</code></em>,
<em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
<p>Write a new tree object to disk containing a representation of the current
state of the index. The index must be associated to an existing repository
and must not contain any files in conflict. You can use the resulting tree
to for instance create a commit.</p>
<div class="refsect3">
<a name="ggit-index-write-tree.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>idx</p></td>
<td class="parameter_description"><p>a <a class="link" href="GgitIndex.html" title="GgitIndex"><span class="type">GgitIndex</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>error</p></td>
<td class="parameter_description"><p>a <span class="type">GError</span> for error reporting, or <code class="literal">NULL</code>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="ggit-index-write-tree.returns"></a><h4>Returns</h4>
<p> a <a class="link" href="GgitOId.html" title="GgitOId"><span class="type">GgitOId</span></a> or <code class="literal">NULL</code> in case of an error. </p>
<p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>][<acronym title="NULL may be passed as the value in, out, in-out; or as a return value."><span class="acronym">nullable</span></acronym>]</span></p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="ggit-index-remove"></a><h3>ggit_index_remove ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>
ggit_index_remove (<em class="parameter"><code><a class="link" href="GgitIndex.html" title="GgitIndex"><span class="type">GgitIndex</span></a> *idx</code></em>,
<em class="parameter"><code><span class="type">GFile</span> *file</code></em>,
<em class="parameter"><code><span class="type">gint</span> stage</code></em>,
<em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
<p>Remove a file from the index (specified by position).</p>
<div class="refsect3">
<a name="ggit-index-remove.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>idx</p></td>
<td class="parameter_description"><p>a <a class="link" href="GgitIndex.html" title="GgitIndex"><span class="type">GgitIndex</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>file</p></td>
<td class="parameter_description"><p>the file to search.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>stage</p></td>
<td class="parameter_description"><p>the stage to search.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>error</p></td>
<td class="parameter_description"><p>a <span class="type">GError</span> for error reporting, or <code class="literal">NULL</code>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="ggit-index-remove.returns"></a><h4>Returns</h4>
<p> <code class="literal">TRUE</code> if the file was successfully removed, <code class="literal">FALSE</code> otherwise.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="ggit-index-add"></a><h3>ggit_index_add ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>
ggit_index_add (<em class="parameter"><code><a class="link" href="GgitIndex.html" title="GgitIndex"><span class="type">GgitIndex</span></a> *idx</code></em>,
<em class="parameter"><code><a class="link" href="GgitIndexEntry.html" title="GgitIndexEntry"><span class="type">GgitIndexEntry</span></a> *entry</code></em>,
<em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
<p>Add a file to the index.</p>
<div class="refsect3">
<a name="ggit-index-add.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>idx</p></td>
<td class="parameter_description"><p>a <a class="link" href="GgitIndex.html" title="GgitIndex"><span class="type">GgitIndex</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>entry</p></td>
<td class="parameter_description"><p>a <a class="link" href="GgitIndexEntry.html" title="GgitIndexEntry"><span class="type">GgitIndexEntry</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>error</p></td>
<td class="parameter_description"><p>a <span class="type">GError</span> for error reporting, or <code class="literal">NULL</code>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="ggit-index-add.returns"></a><h4>Returns</h4>
<p> <code class="literal">TRUE</code> if the file was successfully added, <code class="literal">FALSE</code> otherwise.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="ggit-index-add-file"></a><h3>ggit_index_add_file ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>
ggit_index_add_file (<em class="parameter"><code><a class="link" href="GgitIndex.html" title="GgitIndex"><span class="type">GgitIndex</span></a> *idx</code></em>,
<em class="parameter"><code><span class="type">GFile</span> *file</code></em>,
<em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
<p>Add a file to the index. The specified file must be in the working directory
and must exist and be readable.</p>
<div class="refsect3">
<a name="ggit-index-add-file.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>idx</p></td>
<td class="parameter_description"><p>a <a class="link" href="GgitIndex.html" title="GgitIndex"><span class="type">GgitIndex</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>file</p></td>
<td class="parameter_description"><p>file to add.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>error</p></td>
<td class="parameter_description"><p>a <span class="type">GError</span> for error reporting, or <code class="literal">NULL</code>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="ggit-index-add-file.returns"></a><h4>Returns</h4>
<p> <code class="literal">TRUE</code> if the file was added to the index or <code class="literal">FALSE</code> if there was an error.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="ggit-index-add-path"></a><h3>ggit_index_add_path ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>
ggit_index_add_path (<em class="parameter"><code><a class="link" href="GgitIndex.html" title="GgitIndex"><span class="type">GgitIndex</span></a> *idx</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *path</code></em>,
<em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
<p>Add a file to the index by path. You can specify both relative paths
(to the working directory) and absolute paths. Absolute paths however must
reside in the working directory. The specified path must exist and must be
readable.</p>
<div class="refsect3">
<a name="ggit-index-add-path.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>idx</p></td>
<td class="parameter_description"><p>a <a class="link" href="GgitIndex.html" title="GgitIndex"><span class="type">GgitIndex</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>path</p></td>
<td class="parameter_description"><p>path to the file to add.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>error</p></td>
<td class="parameter_description"><p>a <span class="type">GError</span> for error reporting, or <code class="literal">NULL</code>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="ggit-index-add-path.returns"></a><h4>Returns</h4>
<p> <code class="literal">TRUE</code> if the file was added to the index or <code class="literal">FALSE</code> if there was an error.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="ggit-index-get-owner"></a><h3>ggit_index_get_owner ()</h3>
<pre class="programlisting"><a class="link" href="GgitRepository.html" title="GgitRepository"><span class="returnvalue">GgitRepository</span></a> *
ggit_index_get_owner (<em class="parameter"><code><a class="link" href="GgitIndex.html" title="GgitIndex"><span class="type">GgitIndex</span></a> *idx</code></em>);</pre>
<p>Get the <a class="link" href="GgitRepository.html" title="GgitRepository"><span class="type">GgitRepository</span></a> that owns the index.</p>
<div class="refsect3">
<a name="ggit-index-get-owner.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>idx</p></td>
<td class="parameter_description"><p>a <a class="link" href="GgitIndex.html" title="GgitIndex"><span class="type">GgitIndex</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="ggit-index-get-owner.returns"></a><h4>Returns</h4>
<p> the <a class="link" href="GgitRepository.html" title="GgitRepository"><span class="type">GgitRepository</span></a> that owns this index or <code class="literal">NULL</code>. </p>
<p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>][<acronym title="NULL may be passed as the value in, out, in-out; or as a return value."><span class="acronym">nullable</span></acronym>]</span></p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="ggit-index-get-entries"></a><h3>ggit_index_get_entries ()</h3>
<pre class="programlisting"><a class="link" href="GgitIndexEntry.html#GgitIndexEntries"><span class="returnvalue">GgitIndexEntries</span></a> *
ggit_index_get_entries (<em class="parameter"><code><a class="link" href="GgitIndex.html" title="GgitIndex"><span class="type">GgitIndex</span></a> *idx</code></em>);</pre>
<p>Get the index entries enumerator.</p>
<div class="refsect3">
<a name="ggit-index-get-entries.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>idx</p></td>
<td class="parameter_description"><p>a <a class="link" href="GgitIndex.html" title="GgitIndex"><span class="type">GgitIndex</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="ggit-index-get-entries.returns"></a><h4>Returns</h4>
<p> a <a class="link" href="GgitIndexEntry.html#GgitIndexEntries"><span class="type">GgitIndexEntries</span></a> or <code class="literal">NULL</code>. </p>
<p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>][<acronym title="NULL may be passed as the value in, out, in-out; or as a return value."><span class="acronym">nullable</span></acronym>]</span></p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="ggit-index-get-entries-resolve-undo"></a><h3>ggit_index_get_entries_resolve_undo ()</h3>
<pre class="programlisting"><a class="link" href="GgitIndexEntryResolveUndo.html#GgitIndexEntriesResolveUndo"><span class="returnvalue">GgitIndexEntriesResolveUndo</span></a> *
ggit_index_get_entries_resolve_undo (<em class="parameter"><code><a class="link" href="GgitIndex.html" title="GgitIndex"><span class="type">GgitIndex</span></a> *idx</code></em>);</pre>
<p>Get the resolve undo entries enumerator.</p>
<div class="refsect3">
<a name="ggit-index-get-entries-resolve-undo.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>idx</p></td>
<td class="parameter_description"><p>a <a class="link" href="GgitIndex.html" title="GgitIndex"><span class="type">GgitIndex</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="ggit-index-get-entries-resolve-undo.returns"></a><h4>Returns</h4>
<p> a <a class="link" href="GgitIndexEntryResolveUndo.html#GgitIndexEntriesResolveUndo"><span class="type">GgitIndexEntriesResolveUndo</span></a> or <code class="literal">NULL</code>. </p>
<p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>][<acronym title="NULL may be passed as the value in, out, in-out; or as a return value."><span class="acronym">nullable</span></acronym>]</span></p>
</div>
</div>
</div>
<div class="refsect1">
<a name="GgitIndex.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="GgitIndex-struct"></a><h3>GgitIndex</h3>
<pre class="programlisting">typedef struct _GgitIndex GgitIndex;</pre>
<p>Represents an index object.</p>
</div>
</div>
<div class="refsect1">
<a name="GgitIndex.property-details"></a><h2>Property Details</h2>
<div class="refsect2">
<a name="GgitIndex--file"></a><h3>The <code class="literal">“file”</code> property</h3>
<pre class="programlisting"> “file” <span class="type">GFile</span> *</pre>
<p>File.</p>
<p>Flags: Read / Write / Construct Only</p>
</div>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.25</div>
</body>
</html>
|