/usr/share/gtk-doc/html/libgit2-glib-1.0/GgitRevisionWalker.html is in libgit2-glib-1.0-doc 0.0.22-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 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>libgit2-glib Reference Manual: GgitRevisionWalker</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.78.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="GgitRepository.html" title="GgitRepository">
<link rel="next" href="GgitSignature.html" title="GgitSignature">
<meta name="generator" content="GTK-Doc V1.21 (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="#GgitRevisionWalker.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span>
<a href="#GgitRevisionWalker.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_interfaces"> <span class="dim">|</span>
<a href="#GgitRevisionWalker.implemented-interfaces" class="shortcut">Implemented Interfaces</a></span><span id="nav_properties"> <span class="dim">|</span>
<a href="#GgitRevisionWalker.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="GgitRepository.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="GgitSignature.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="GgitRevisionWalker"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="GgitRevisionWalker.top_of_page"></a>GgitRevisionWalker</span></h2>
<p>GgitRevisionWalker</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="GgitRevisionWalker.functions"></a><h2>Functions</h2>
<div class="informaltable"><table 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="GgitRevisionWalker.html" title="GgitRevisionWalker"><span class="returnvalue">GgitRevisionWalker</span></a> *
</td>
<td class="function_name">
<a class="link" href="GgitRevisionWalker.html#ggit-revision-walker-new" title="ggit_revision_walker_new ()">ggit_revision_walker_new</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="GgitRevisionWalker.html#ggit-revision-walker-reset" title="ggit_revision_walker_reset ()">ggit_revision_walker_reset</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="GgitRevisionWalker.html#ggit-revision-walker-push" title="ggit_revision_walker_push ()">ggit_revision_walker_push</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="GgitRevisionWalker.html#ggit-revision-walker-hide" title="ggit_revision_walker_hide ()">ggit_revision_walker_hide</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="GgitRevisionWalker.html#ggit-revision-walker-hide-glob" title="ggit_revision_walker_hide_glob ()">ggit_revision_walker_hide_glob</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="GgitRevisionWalker.html#ggit-revision-walker-hide-head" title="ggit_revision_walker_hide_head ()">ggit_revision_walker_hide_head</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="GgitRevisionWalker.html#ggit-revision-walker-hide-ref" title="ggit_revision_walker_hide_ref ()">ggit_revision_walker_hide_ref</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="GgitRevisionWalker.html#ggit-revision-walker-push-glob" title="ggit_revision_walker_push_glob ()">ggit_revision_walker_push_glob</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="GgitRevisionWalker.html#ggit-revision-walker-push-head" title="ggit_revision_walker_push_head ()">ggit_revision_walker_push_head</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="GgitRevisionWalker.html#ggit-revision-walker-push-range" title="ggit_revision_walker_push_range ()">ggit_revision_walker_push_range</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="GgitRevisionWalker.html#ggit-revision-walker-push-ref" title="ggit_revision_walker_push_ref ()">ggit_revision_walker_push_ref</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="GgitRevisionWalker.html#ggit-revision-walker-next" title="ggit_revision_walker_next ()">ggit_revision_walker_next</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="GgitRevisionWalker.html#ggit-revision-walker-set-sort-mode" title="ggit_revision_walker_set_sort_mode ()">ggit_revision_walker_set_sort_mode</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="GgitRevisionWalker.html#ggit-revision-walker-get-repository" title="ggit_revision_walker_get_repository ()">ggit_revision_walker_get_repository</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="GgitRevisionWalker.properties"></a><h2>Properties</h2>
<div class="informaltable"><table 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">
<a class="link" href="GgitRepository.html" title="GgitRepository"><span class="type">GgitRepository</span></a> *</td>
<td class="property_name"><a class="link" href="GgitRevisionWalker.html#GgitRevisionWalker--repository" title="The “repository” property">repository</a></td>
<td class="property_flags">Read / Write / Construct</td>
</tr></tbody>
</table></div>
</div>
<div class="refsect1">
<a name="GgitRevisionWalker.other"></a><h2>Types and Values</h2>
<div class="informaltable"><table 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="GgitRevisionWalker.html#GgitRevisionWalker-struct" title="GgitRevisionWalker">GgitRevisionWalker</a></td>
</tr>
<tr>
<td class="datatype_keyword">struct</td>
<td class="function_name"><a class="link" href="GgitRevisionWalker.html#GgitRevisionWalkerClass" title="struct GgitRevisionWalkerClass">GgitRevisionWalkerClass</a></td>
</tr>
<tr>
<td class="datatype_keyword">enum</td>
<td class="function_name"><a class="link" href="GgitRevisionWalker.html#GgitSortMode" title="enum GgitSortMode">GgitSortMode</a></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="GgitRevisionWalker.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="screen"> GFlags
<span class="lineart">╰──</span> GgitSortMode
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> GgitRevisionWalker
</pre>
</div>
<div class="refsect1">
<a name="GgitRevisionWalker.implemented-interfaces"></a><h2>Implemented Interfaces</h2>
<p>
GgitRevisionWalker implements
GInitable.</p>
</div>
<div class="refsect1">
<a name="GgitRevisionWalker.description"></a><h2>Description</h2>
</div>
<div class="refsect1">
<a name="GgitRevisionWalker.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="ggit-revision-walker-new"></a><h3>ggit_revision_walker_new ()</h3>
<pre class="programlisting"><a class="link" href="GgitRevisionWalker.html" title="GgitRevisionWalker"><span class="returnvalue">GgitRevisionWalker</span></a> *
ggit_revision_walker_new (<em class="parameter"><code><a class="link" href="GgitRepository.html" title="GgitRepository"><span class="type">GgitRepository</span></a> *repository</code></em>,
<em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
<p>Creates a new revision walker to iterate through <em class="parameter"><code>repository</code></em>
.</p>
<p>This revision walker uses a custom memory pool and an internal
commit cache, so it is relatively expensive to allocate.</p>
<p>For maximum performance, this revision walker should be
reused for different walks.</p>
<p>This revision walker is *not* thread safe: it may only be
used to walk a repository on a single thread; however,
it is possible to have several revision walkers in
several different threads walking the same repository.</p>
<div class="refsect3">
<a name="id-1.2.37.9.2.8"></a><h4>Parameters</h4>
<div class="informaltable"><table 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>repository</p></td>
<td class="parameter_description"><p>a <a class="link" href="GgitRepository.html" title="GgitRepository"><span class="type">GgitRepository</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="id-1.2.37.9.2.9"></a><h4>Returns</h4>
<p> a new <a class="link" href="GgitRevisionWalker.html" title="GgitRevisionWalker"><span class="type">GgitRevisionWalker</span></a>. </p>
<p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="ggit-revision-walker-reset"></a><h3>ggit_revision_walker_reset ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
ggit_revision_walker_reset (<em class="parameter"><code><a class="link" href="GgitRevisionWalker.html" title="GgitRevisionWalker"><span class="type">GgitRevisionWalker</span></a> *walker</code></em>);</pre>
<p>Resets the revision walker for reuse.</p>
<p>This will clear all the pushed and hidden commits, and
leave the walker in a blank state (just like at
creation) ready to receive new commit pushes and
start a new walk.</p>
<p>The revision walk is automatically reset when a walk
is over.</p>
<div class="refsect3">
<a name="id-1.2.37.9.3.7"></a><h4>Parameters</h4>
<div class="informaltable"><table 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>walker</p></td>
<td class="parameter_description"><p>a <a class="link" href="GgitRevisionWalker.html" title="GgitRevisionWalker"><span class="type">GgitRevisionWalker</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="ggit-revision-walker-push"></a><h3>ggit_revision_walker_push ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
ggit_revision_walker_push (<em class="parameter"><code><a class="link" href="GgitRevisionWalker.html" title="GgitRevisionWalker"><span class="type">GgitRevisionWalker</span></a> *walker</code></em>,
<em class="parameter"><code><a class="link" href="GgitOId.html" title="GgitOId"><span class="type">GgitOId</span></a> *oid</code></em>,
<em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
<p>Marks a commit to start traversal from.</p>
<p>The given OID must belong to a commit on the walked
repository.</p>
<p>The given commit will be used as one of the roots
when starting the revision walk. At least one commit
must be pushed the repository before a walk can
be started.</p>
<div class="refsect3">
<a name="id-1.2.37.9.4.7"></a><h4>Parameters</h4>
<div class="informaltable"><table 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>walker</p></td>
<td class="parameter_description"><p>a <a class="link" href="GgitRevisionWalker.html" title="GgitRevisionWalker"><span class="type">GgitRevisionWalker</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>oid</p></td>
<td class="parameter_description"><p>a <a class="link" href="GgitOId.html" title="GgitOId"><span class="type">GgitOId</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>
<hr>
<div class="refsect2">
<a name="ggit-revision-walker-hide"></a><h3>ggit_revision_walker_hide ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
ggit_revision_walker_hide (<em class="parameter"><code><a class="link" href="GgitRevisionWalker.html" title="GgitRevisionWalker"><span class="type">GgitRevisionWalker</span></a> *walker</code></em>,
<em class="parameter"><code><a class="link" href="GgitOId.html" title="GgitOId"><span class="type">GgitOId</span></a> *oid</code></em>,
<em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
<p>Marks a commit (and its ancestors) uninteresting for the output.</p>
<p>The given OID must belong to a commit on the walked
repository.</p>
<p>The resolved commit and all its parents will be hidden from the
output on the revision walk.</p>
<div class="refsect3">
<a name="id-1.2.37.9.5.7"></a><h4>Parameters</h4>
<div class="informaltable"><table 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>walker</p></td>
<td class="parameter_description"><p>a <a class="link" href="GgitRevisionWalker.html" title="GgitRevisionWalker"><span class="type">GgitRevisionWalker</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>oid</p></td>
<td class="parameter_description"><p>a <a class="link" href="GgitOId.html" title="GgitOId"><span class="type">GgitOId</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>
<hr>
<div class="refsect2">
<a name="ggit-revision-walker-hide-glob"></a><h3>ggit_revision_walker_hide_glob ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
ggit_revision_walker_hide_glob (<em class="parameter"><code><a class="link" href="GgitRevisionWalker.html" title="GgitRevisionWalker"><span class="type">GgitRevisionWalker</span></a> *walker</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *item</code></em>,
<em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
<p>Hide all OIDs pointed to by references that match the given glob pattern
to the revsision walker. A leading 'refs/' is implied if not present, as well
as a trailing '/ \ *' if the glob lacks '?', '\ *' or '['.</p>
<div class="refsect3">
<a name="id-1.2.37.9.6.5"></a><h4>Parameters</h4>
<div class="informaltable"><table 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>walker</p></td>
<td class="parameter_description"><p>a <a class="link" href="GgitRevisionWalker.html" title="GgitRevisionWalker"><span class="type">GgitRevisionWalker</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>item</p></td>
<td class="parameter_description"><p>the glob to hide.</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>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="ggit-revision-walker-hide-head"></a><h3>ggit_revision_walker_hide_head ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
ggit_revision_walker_hide_head (<em class="parameter"><code><a class="link" href="GgitRevisionWalker.html" title="GgitRevisionWalker"><span class="type">GgitRevisionWalker</span></a> *walker</code></em>,
<em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
<p>Hide the OID of the current HEAD to the revision walker.</p>
<div class="refsect3">
<a name="id-1.2.37.9.7.5"></a><h4>Parameters</h4>
<div class="informaltable"><table 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>walker</p></td>
<td class="parameter_description"><p>a <a class="link" href="GgitRevisionWalker.html" title="GgitRevisionWalker"><span class="type">GgitRevisionWalker</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>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="ggit-revision-walker-hide-ref"></a><h3>ggit_revision_walker_hide_ref ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
ggit_revision_walker_hide_ref (<em class="parameter"><code><a class="link" href="GgitRevisionWalker.html" title="GgitRevisionWalker"><span class="type">GgitRevisionWalker</span></a> *walker</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *item</code></em>,
<em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
<p>Hide the OID pointed to by the named reference to the revision walker.</p>
<div class="refsect3">
<a name="id-1.2.37.9.8.5"></a><h4>Parameters</h4>
<div class="informaltable"><table 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>walker</p></td>
<td class="parameter_description"><p>a <a class="link" href="GgitRevisionWalker.html" title="GgitRevisionWalker"><span class="type">GgitRevisionWalker</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>item</p></td>
<td class="parameter_description"><p>the reference to hide.</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>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="ggit-revision-walker-push-glob"></a><h3>ggit_revision_walker_push_glob ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
ggit_revision_walker_push_glob (<em class="parameter"><code><a class="link" href="GgitRevisionWalker.html" title="GgitRevisionWalker"><span class="type">GgitRevisionWalker</span></a> *walker</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *item</code></em>,
<em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
<p>Push all OIDs pointed to by references that match the given glob pattern
to the revsision walker. A leading 'refs/' is implied if not present, as well
as a trailing '/ \ *' if the glob lacks '?', '\ *' or '['.</p>
<div class="refsect3">
<a name="id-1.2.37.9.9.5"></a><h4>Parameters</h4>
<div class="informaltable"><table 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>walker</p></td>
<td class="parameter_description"><p>a <a class="link" href="GgitRevisionWalker.html" title="GgitRevisionWalker"><span class="type">GgitRevisionWalker</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>item</p></td>
<td class="parameter_description"><p>the glob to push.</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>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="ggit-revision-walker-push-head"></a><h3>ggit_revision_walker_push_head ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
ggit_revision_walker_push_head (<em class="parameter"><code><a class="link" href="GgitRevisionWalker.html" title="GgitRevisionWalker"><span class="type">GgitRevisionWalker</span></a> *walker</code></em>,
<em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
<p>Push the OID of the current HEAD to the revision walker.</p>
<div class="refsect3">
<a name="id-1.2.37.9.10.5"></a><h4>Parameters</h4>
<div class="informaltable"><table 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>walker</p></td>
<td class="parameter_description"><p>a <a class="link" href="GgitRevisionWalker.html" title="GgitRevisionWalker"><span class="type">GgitRevisionWalker</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>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="ggit-revision-walker-push-range"></a><h3>ggit_revision_walker_push_range ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
ggit_revision_walker_push_range (<em class="parameter"><code><a class="link" href="GgitRevisionWalker.html" title="GgitRevisionWalker"><span class="type">GgitRevisionWalker</span></a> *walker</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *range</code></em>,
<em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
<p>Push and hide the respective endpoints of the given range. The range
should be of the form: &ltcommit&gt..<commit>, where each <commit> is in the
form accepted by revparse. The left-hand commit will be hidden and the
right-hand commit pushed.</p>
<div class="refsect3">
<a name="id-1.2.37.9.11.5"></a><h4>Parameters</h4>
<div class="informaltable"><table 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>walker</p></td>
<td class="parameter_description"><p>a <a class="link" href="GgitRevisionWalker.html" title="GgitRevisionWalker"><span class="type">GgitRevisionWalker</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>range</p></td>
<td class="parameter_description"><p>the range to push.</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>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="ggit-revision-walker-push-ref"></a><h3>ggit_revision_walker_push_ref ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
ggit_revision_walker_push_ref (<em class="parameter"><code><a class="link" href="GgitRevisionWalker.html" title="GgitRevisionWalker"><span class="type">GgitRevisionWalker</span></a> *walker</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *item</code></em>,
<em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
<p>Push the OID pointed to by the named reference to the revision walker.</p>
<div class="refsect3">
<a name="id-1.2.37.9.12.5"></a><h4>Parameters</h4>
<div class="informaltable"><table 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>walker</p></td>
<td class="parameter_description"><p>a <a class="link" href="GgitRevisionWalker.html" title="GgitRevisionWalker"><span class="type">GgitRevisionWalker</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>item</p></td>
<td class="parameter_description"><p>the reference to push.</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>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="ggit-revision-walker-next"></a><h3>ggit_revision_walker_next ()</h3>
<pre class="programlisting"><a class="link" href="GgitOId.html" title="GgitOId"><span class="returnvalue">GgitOId</span></a> *
ggit_revision_walker_next (<em class="parameter"><code><a class="link" href="GgitRevisionWalker.html" title="GgitRevisionWalker"><span class="type">GgitRevisionWalker</span></a> *walker</code></em>,
<em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
<p>Gets the next commit from the revision walk.</p>
<p>The initial call to this method is *not* blocking when
iterating through a repository with a time-sorting mode.</p>
<p>Iterating with Topological or inverted modes makes the initial
call blocking to preprocess the commit list, but this block should be
mostly unnoticeable on most repositories (topological preprocessing
times at 0.3s on the git.git repo).</p>
<p>The revision walker is reset when the walk is over.</p>
<div class="refsect3">
<a name="id-1.2.37.9.13.8"></a><h4>Parameters</h4>
<div class="informaltable"><table 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>walker</p></td>
<td class="parameter_description"><p>a <a class="link" href="GgitRevisionWalker.html" title="GgitRevisionWalker"><span class="type">GgitRevisionWalker</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="id-1.2.37.9.13.9"></a><h4>Returns</h4>
<p> the next commit from the revision walk. </p>
<p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="ggit-revision-walker-set-sort-mode"></a><h3>ggit_revision_walker_set_sort_mode ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
ggit_revision_walker_set_sort_mode (<em class="parameter"><code><a class="link" href="GgitRevisionWalker.html" title="GgitRevisionWalker"><span class="type">GgitRevisionWalker</span></a> *walker</code></em>,
<em class="parameter"><code><a class="link" href="GgitRevisionWalker.html#GgitSortMode" title="enum GgitSortMode"><span class="type">GgitSortMode</span></a> sort_mode</code></em>);</pre>
<p>Change the sorting mode when iterating through the
repository's contents.</p>
<p>Changing the sorting mode resets the walker.</p>
<div class="refsect3">
<a name="id-1.2.37.9.14.6"></a><h4>Parameters</h4>
<div class="informaltable"><table 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>walker</p></td>
<td class="parameter_description"><p>a <a class="link" href="GgitRevisionWalker.html" title="GgitRevisionWalker"><span class="type">GgitRevisionWalker</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>sort_mode</p></td>
<td class="parameter_description"><p>a <a class="link" href="GgitRevisionWalker.html#GgitSortMode" title="enum GgitSortMode"><span class="type">GgitSortMode</span></a> value.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="ggit-revision-walker-get-repository"></a><h3>ggit_revision_walker_get_repository ()</h3>
<pre class="programlisting"><a class="link" href="GgitRepository.html" title="GgitRepository"><span class="returnvalue">GgitRepository</span></a> *
ggit_revision_walker_get_repository (<em class="parameter"><code><a class="link" href="GgitRevisionWalker.html" title="GgitRevisionWalker"><span class="type">GgitRevisionWalker</span></a> *walker</code></em>);</pre>
<p>Gets the repository on which this walker is operating.</p>
<div class="refsect3">
<a name="id-1.2.37.9.15.5"></a><h4>Parameters</h4>
<div class="informaltable"><table 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>walker</p></td>
<td class="parameter_description"><p>a <a class="link" href="GgitRepository.html" title="GgitRepository"><span class="type">GgitRepository</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.2.37.9.15.6"></a><h4>Returns</h4>
<p> the repository on which this walker is operating. </p>
<p><span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></p>
</div>
</div>
</div>
<div class="refsect1">
<a name="GgitRevisionWalker.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="GgitRevisionWalker-struct"></a><h3>GgitRevisionWalker</h3>
<pre class="programlisting">typedef struct _GgitRevisionWalker GgitRevisionWalker;</pre>
<p>Represents a revision walker.</p>
</div>
<hr>
<div class="refsect2">
<a name="GgitRevisionWalkerClass"></a><h3>struct GgitRevisionWalkerClass</h3>
<pre class="programlisting">struct GgitRevisionWalkerClass {
};
</pre>
<p>The class structure for <a class="link" href="GgitRevisionWalker.html#GgitRevisionWalkerClass" title="struct GgitRevisionWalkerClass"><span class="type">GgitRevisionWalkerClass</span></a>.</p>
<div class="refsect3">
<a name="id-1.2.37.10.3.5"></a><h4>Members</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="300px" class="struct_members_name">
<col class="struct_members_description">
<col width="200px" class="struct_members_annotations">
</colgroup>
<tbody></tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="GgitSortMode"></a><h3>enum GgitSortMode</h3>
<p>The type of sorting mode for the revision walker.</p>
<div class="refsect3">
<a name="id-1.2.37.10.4.4"></a><h4>Members</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="300px" class="enum_members_name">
<col class="enum_members_description">
<col width="200px" class="enum_members_annotations">
</colgroup>
<tbody>
<tr>
<td class="enum_member_name"><p><a name="GGIT-SORT-NONE:CAPS"></a>GGIT_SORT_NONE</p></td>
<td class="enum_member_description">
<p>Sorts the repository contents in no particular ordering;
this sorting is arbitrary, implementation-specific
and subject to change at any time.</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="GGIT-SORT-TOPOLOGICAL:CAPS"></a>GGIT_SORT_TOPOLOGICAL</p></td>
<td class="enum_member_description">
<p>Sorts the repository contents in topological order
(parents before children); this sorting mode
can be combined with time sorting.</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="GGIT-SORT-TIME:CAPS"></a>GGIT_SORT_TIME</p></td>
<td class="enum_member_description">
<p>Sort the repository contents by commit time;
this sorting mode can be combined with
topological sorting.</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="GGIT-SORT-REVERSE:CAPS"></a>GGIT_SORT_REVERSE</p></td>
<td class="enum_member_description">
<p>Iterate through the repository contents in reverse
order; this sorting mode can be combined with
any of the above.</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
<div class="refsect1">
<a name="GgitRevisionWalker.property-details"></a><h2>Property Details</h2>
<div class="refsect2">
<a name="GgitRevisionWalker--repository"></a><h3>The <code class="literal">“repository”</code> property</h3>
<pre class="programlisting"> “repository” <a class="link" href="GgitRepository.html" title="GgitRepository"><span class="type">GgitRepository</span></a> *</pre>
<p>The repository where to make the walking.</p>
<p>Flags: Read / Write / Construct</p>
</div>
</div>
</div>
<div class="footer">
<hr>
Generated by GTK-Doc V1.21</div>
</body>
</html>
|