RubyGems - wayfarer - Versions diffs - 0.4.8 → 0.4.10 - Mend

wayfarer 0.4.8 → 0.4.10

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (615) hide show

data/spec/support/static/git-scm.com/book/en/v2/Appendix-B:-Embedding-Git-in-your-Applications-Libgit2.html DELETED Viewed

@@ -1,1003 +0,0 @@
-<!DOCTYPE html>
-<html lang="en">
-<head>
-  <!-- Global site tag (gtag.js) - Google Analytics -->
-  <script async src="https://www.googletagmanager.com/gtag/js?id=UA-49925874-3"></script>
-  <script>
-    window.dataLayer = window.dataLayer || [];
-    function gtag(){dataLayer.push(arguments);}
-    gtag('js', new Date());
-    gtag('config', 'UA-49925874-3');
-  </script>
-  <meta charset='utf-8'>
-  <meta content='IE=edge,chrome=1' http-equiv='X-UA-Compatible'>
-  <meta name="viewport" content="width=device-width, initial-scale=1">
-  <title>Git - Libgit2</title>
-  <link href='../../../favicon.ico' rel='shortcut icon' type='image/x-icon'>
-  <link rel="stylesheet" media="screen" href="../../../assets/application-cafcf280f67db0e6d8168ba98a38da878769a9d5f37793b68ffb963a02d185e0.css" />
-  <script src="../../../assets/modernize-b3ebe0c31c24f230dc62179d3e1030d2e57a53b1668d9382c0a27dbd44a94beb.js"></script>
-  <!--[if (gte IE 6)&(lte IE 8)]>
-  <script src="/javascripts/selectivizr-min.js"></script>
-  <![endif]-->
-</head>
-<body id="documentation">
-  <div class="inner">
-    <header>
-  <a href="https://git-scm.com/"><img src="../../../images/logo@2x.png" width="110" height="46" alt="Git" /></a>
-  <span id="tagline"></span>
-  <script type="text/javascript">
-    var taglines = ["fast-version-control","everything-is-local","distributed-even-if-your-workflow-isnt","local-branching-on-the-cheap","distributed-is-the-new-centralized"];
-    var tagline = taglines[Math.floor(Math.random() * taglines.length)];
-    document.getElementById('tagline').innerHTML = '--' + tagline;
-  </script>
-  <form id="search" action="https://git-scm.com/search/results">
-    <input id="search-text" name="search" placeholder="Search entire site..." autocomplete="off" type="text" />
-  </form>
-  <div id="search-results"></div>
-</header>
-  </div> <!-- .inner -->
-    <div class="inner">
-      <div id="content-wrapper">
-        <button class="sidebar-btn"></button>
-<aside class="sidebar" id="sidebar">
-  <nav>
-    <ul>
-      <li>
-        <a href="https://git-scm.com/about">About</a>
-        <ul class="">
-          <li>
-            <a href="https://git-scm.com/about">Branching and Merging</a>
-          </li>
-          <li>
-            <a href="https://git-scm.com/about/small-and-fast">Small and Fast</a>
-          </li>
-          <li>
-            <a href="https://git-scm.com/about/distributed">Distributed</a>
-          </li>
-          <li>
-            <a href="https://git-scm.com/about/info-assurance">Data Assurance</a>
-          </li>
-          <li>
-            <a href="https://git-scm.com/about/staging-area">Staging Area</a>
-          </li>
-          <li>
-            <a href="https://git-scm.com/about/free-and-open-source">Free and Open Source</a>
-          </li>
-          <li>
-            <a href="https://git-scm.com/about/trademark">Trademark</a>
-          </li>
-        </ul>
-      </li>
-      <li>
-        <a class="active" href="https://git-scm.com/doc">Documentation</a>
-        <ul class="expanded">
-          <li>
-            <a href="https://git-scm.com/docs">Reference</a>
-          </li>
-          <li>
-            <a class="active" href="https://git-scm.com/book">Book</a>
-          </li>
-          <li>
-            <a href="https://git-scm.com/videos">Videos</a>
-          </li>
-          <li>
-            <a href="https://git-scm.com/doc/ext">External Links</a>
-          </li>
-        </ul>
-      </li>
-      <li>
-        <a href="https://git-scm.com/downloads">Downloads</a>
-        <ul class="">
-          <li>
-            <a href="https://git-scm.com/downloads/guis">GUI Clients</a>
-          </li>
-          <li>
-            <a href="https://git-scm.com/downloads/logos">Logos</a>
-          </li>
-        </ul>
-      </li>
-      <li>
-        <a href="https://git-scm.com/community">Community</a>
-      </li>
-    </ul>
-      <hr class="sidebar">
-        <p>
-This book is available in
-  <a href="https://git-scm.com/book/en">English</a>.
-</p>
-<p>
-  Full translation available in
-  <table>
-    <tr><td><a href="https://git-scm.com/book/az">azərbaycan dili</a>,</td></tr>
-    <tr><td><a href="https://git-scm.com/book/bg">български език</a>,</td></tr>
-    <tr><td><a href="https://git-scm.com/book/de">Deutsch</a>,</td></tr>
-    <tr><td><a href="https://git-scm.com/book/es">Español</a>,</td></tr>
-    <tr><td><a href="https://git-scm.com/book/fr">Français</a>,</td></tr>
-    <tr><td><a href="https://git-scm.com/book/gr">Ελληνικά</a>,</td></tr>
-    <tr><td><a href="https://git-scm.com/book/ja">日本語</a>,</td></tr>
-    <tr><td><a href="https://git-scm.com/book/ko">한국어</a>,</td></tr>
-    <tr><td><a href="https://git-scm.com/book/nl">Nederlands</a>,</td></tr>
-    <tr><td><a href="https://git-scm.com/book/ru">Русский</a>,</td></tr>
-    <tr><td><a href="https://git-scm.com/book/sl">Slovenščina</a>,</td></tr>
-    <tr><td><a href="https://git-scm.com/book/tl">Tagalog</a>,</td></tr>
-    <tr><td><a href="https://git-scm.com/book/uk">Українська</a></td></tr>
-    <tr><td><a href="https://git-scm.com/book/zh">简体中文</a>,</td></tr>
-  </table>
-</p>
-<p>
-  Partial translations available in
-  <table>
-    <tr><td><a href="https://git-scm.com/book/cs">Čeština</a>,</td></tr>
-    <tr><td><a href="https://git-scm.com/book/mk">Македонски</a>,</td></tr>
-    <tr><td><a href="https://git-scm.com/book/pl">Polski</a>,</td></tr>
-    <tr><td><a href="https://git-scm.com/book/sr">Српски</a>,</td></tr>
-    <tr><td><a href="https://git-scm.com/book/uz">Ўзбекча</a>,</td></tr>
-    <tr><td><a href="https://git-scm.com/book/zh-tw">繁體中文</a>,</td></tr>
-  </table>
-</p>
-<p>
-  Translations started for
-  <table>
-    <tr><td><a href="https://git-scm.com/book/be">Беларуская</a>,</td></tr>
-    <tr><td><a href="https://git-scm.com/book/fa" dir="rtl">فارسی</a>,</td></tr>
-    <tr><td><a href="https://git-scm.com/book/id">Indonesian</a>,</td></tr>
-    <tr><td><a href="https://git-scm.com/book/it">Italiano</a>,</td></tr>
-    <tr><td><a href="https://git-scm.com/book/ms">Bahasa Melayu</a>,</td></tr>
-    <tr><td><a href="https://git-scm.com/book/pt-br">Português (Brasil)</a>,</td></tr>
-    <tr><td><a href="https://git-scm.com/book/pt-pt">Português (Portugal)</a>,</td></tr>
-    <tr><td><a href="https://git-scm.com/book/sv">Svenska</a>,</td></tr>
-    <tr><td><a href="https://git-scm.com/book/tr">Türkçe</a>.</td></tr>
-  </table>
-</p>
-<hr class="sidebar"/>
-<p>
-The source of this book is <a href="https://github.com/progit/progit2">hosted on GitHub.</a></br>
-Patches, suggestions and comments are welcome.
-</p>
-  </nav>
-</aside>
-        <div id="content">
-<div id='book-chapters'>
-  <a class="dropdown-trigger" id="book-chapters-trigger" data-panel-id="chapters-dropdown" href="ch00/_libgit2_bindings.html#">Chapters ▾</a>
-<div class='dropdown-panel' id='chapters-dropdown'>
-  <div class="three-column">
-    <div class='column-left'>
-      <ol class='book-toc'>
-  <li class='chapter'>
-  <h2>1. <a href="ch00/ch01-getting-started.html">Getting Started</a></h2>
-    <ol>
-        <li>
-          1.1
-          <a href="ch00/ch01-getting-started.html" >About Version Control </a>
-        </li>
-        <li>
-          1.2
-          <a href="Getting-Started-A-Short-History-of-Git.html" >A Short History of Git </a>
-        </li>
-        <li>
-          1.3
-          <a href="ch00/what_is_git_section.html" >What is Git? </a>
-        </li>
-        <li>
-          1.4
-          <a href="Getting-Started-The-Command-Line.html" >The Command Line </a>
-        </li>
-        <li>
-          1.5
-          <a href="Getting-Started-Installing-Git.html" >Installing Git </a>
-        </li>
-        <li>
-          1.6
-          <a href="ch00/_editor.html" >First-Time Git Setup </a>
-        </li>
-        <li>
-          1.7
-          <a href="ch00/_git_help.html" >Getting Help </a>
-        </li>
-        <li>
-          1.8
-          <a href="Getting-Started-Summary.html" >Summary </a>
-        </li>
-    </ol>
-  </li>
-  <li class='chapter'>
-  <h2>2. <a href="ch00/_git_cloning.html">Git Basics</a></h2>
-    <ol>
-        <li>
-          2.1
-          <a href="ch00/_git_cloning.html" >Getting a Git Repository </a>
-        </li>
-        <li>
-          2.2
-          <a href="ch00/_git_mv.html" >Recording Changes to the Repository </a>
-        </li>
-        <li>
-          2.3
-          <a href="ch00/_viewing_history.html" >Viewing the Commit History </a>
-        </li>
-        <li>
-          2.4
-          <a href="ch00/_unstaging.html" >Undoing Things </a>
-        </li>
-        <li>
-          2.5
-          <a href="ch00/_remote_repos.html" >Working with Remotes </a>
-        </li>
-        <li>
-          2.6
-          <a href="ch00/_annotated_tags.html" >Tagging </a>
-        </li>
-        <li>
-          2.7
-          <a href="ch00/_git_aliases.html" >Git Aliases </a>
-        </li>
-        <li>
-          2.8
-          <a href="Git-Basics-Summary.html" >Summary </a>
-        </li>
-    </ol>
-  </li>
-  <li class='chapter'>
-  <h2>3. <a href="ch00/_switching_branches.html">Git Branching</a></h2>
-    <ol>
-        <li>
-          3.1
-          <a href="ch00/_switching_branches.html" >Branches in a Nutshell </a>
-        </li>
-        <li>
-          3.2
-          <a href="ch00/_basic_branching.html" >Basic Branching and Merging </a>
-        </li>
-        <li>
-          3.3
-          <a href="ch00/_branch_management.html" >Branch Management </a>
-        </li>
-        <li>
-          3.4
-          <a href="ch00/_topic_branch.html" >Branching Workflows </a>
-        </li>
-        <li>
-          3.5
-          <a href="ch00/_delete_branches.html" >Remote Branches </a>
-        </li>
-        <li>
-          3.6
-          <a href="ch00/_rebase_rebase.html" >Rebasing </a>
-        </li>
-        <li>
-          3.7
-          <a href="Git-Branching-Summary.html" >Summary </a>
-        </li>
-    </ol>
-  </li>
-  <li class='chapter'>
-  <h2>4. <a href="Git-on-the-Server-The-Protocols.html">Git on the Server</a></h2>
-    <ol>
-        <li>
-          4.1
-          <a href="Git-on-the-Server-The-Protocols.html" >The Protocols </a>
-        </li>
-        <li>
-          4.2
-          <a href="ch00/_bare_repo.html" >Getting Git on a Server </a>
-        </li>
-        <li>
-          4.3
-          <a href="ch00/_generate_ssh_key.html" >Generating Your SSH Public Key </a>
-        </li>
-        <li>
-          4.4
-          <a href="ch00/_setting_up_server.html" >Setting Up the Server </a>
-        </li>
-        <li>
-          4.5
-          <a href="Git-on-the-Server-Git-Daemon.html" >Git Daemon </a>
-        </li>
-        <li>
-          4.6
-          <a href="Git-on-the-Server-Smart-HTTP.html" >Smart HTTP </a>
-        </li>
-        <li>
-          4.7
-          <a href="Git-on-the-Server-GitWeb.html" >GitWeb </a>
-        </li>
-        <li>
-          4.8
-          <a href="ch00/_gitlab_groups_section.html" >GitLab </a>
-        </li>
-        <li>
-          4.9
-          <a href="Git-on-the-Server-Third-Party-Hosted-Options.html" >Third Party Hosted Options </a>
-        </li>
-        <li>
-          4.10
-          <a href="Git-on-the-Server-Summary.html" >Summary </a>
-        </li>
-    </ol>
-  </li>
-  <li class='chapter'>
-  <h2>5. <a href="ch00/_integration_manager.html">Distributed Git</a></h2>
-    <ol>
-        <li>
-          5.1
-          <a href="ch00/_integration_manager.html" >Distributed Workflows </a>
-        </li>
-        <li>
-          5.2
-          <a href="ch00/_project_over_email.html" >Contributing to a Project </a>
-        </li>
-        <li>
-          5.3
-          <a href="ch00/_git_am.html" >Maintaining a Project </a>
-        </li>
-        <li>
-          5.4
-          <a href="Distributed-Git-Summary.html" >Summary </a>
-        </li>
-    </ol>
-  </li>
-</ol>
-    </div>
-    <div class='column-middle'>
-      <ol class='book-toc'>
-  <li class='chapter'>
-  <h2>6. <a href="ch00/_personal_avatar.html">GitHub</a></h2>
-    <ol>
-        <li>
-          6.1
-          <a href="ch00/_personal_avatar.html" >Account Setup and Configuration </a>
-        </li>
-        <li>
-          6.2
-          <a href="ch00/_fetch_and_push_on_different_repositories.html" >Contributing to a Project </a>
-        </li>
-        <li>
-          6.3
-          <a href="ch00/_email_notifications.html" >Maintaining a Project </a>
-        </li>
-        <li>
-          6.4
-          <a href="ch00/_team_page.html" >Managing an organization </a>
-        </li>
-        <li>
-          6.5
-          <a href="ch00/_commit_status.html" >Scripting GitHub </a>
-        </li>
-        <li>
-          6.6
-          <a href="GitHub-Summary.html" >Summary </a>
-        </li>
-    </ol>
-  </li>
-  <li class='chapter'>
-  <h2>7. <a href="ch00/_git_reflog.html">Git Tools</a></h2>
-    <ol>
-        <li>
-          7.1
-          <a href="ch00/_git_reflog.html" >Revision Selection </a>
-        </li>
-        <li>
-          7.2
-          <a href="ch00/_interactive_staging.html" >Interactive Staging </a>
-        </li>
-        <li>
-          7.3
-          <a href="ch00/_git_clean.html" >Stashing and Cleaning </a>
-        </li>
-        <li>
-          7.4
-          <a href="ch00/_signing_commits.html" >Signing Your Work </a>
-        </li>
-        <li>
-          7.5
-          <a href="ch00/_git_grep.html" >Searching </a>
-        </li>
-        <li>
-          7.6
-          <a href="ch00/_removing_file_every_commit.html" >Rewriting History </a>
-        </li>
-        <li>
-          7.7
-          <a href="ch00/_the_index.html" >Reset Demystified </a>
-        </li>
-        <li>
-          7.8
-          <a href="ch00/_reverse_commit.html" >Advanced Merging </a>
-        </li>
-        <li>
-          7.9
-          <a href="ch00/ref_rerere.html" >Rerere </a>
-        </li>
-        <li>
-          7.10
-          <a href="ch00/_file_annotation.html" >Debugging with Git </a>
-        </li>
-        <li>
-          7.11
-          <a href="ch00/_publishing_submodules.html" >Submodules </a>
-        </li>
-        <li>
-          7.12
-          <a href="ch00/_bundling.html" >Bundling </a>
-        </li>
-        <li>
-          7.13
-          <a href="ch00/_replace.html" >Replace </a>
-        </li>
-        <li>
-          7.14
-          <a href="ch00/_credential_caching.html" >Credential Storage </a>
-        </li>
-        <li>
-          7.15
-          <a href="Git-Tools-Summary.html" >Summary </a>
-        </li>
-    </ol>
-  </li>
-  <li class='chapter'>
-  <h2>8. <a href="ch00/_external_merge_tools.html">Customizing Git</a></h2>
-    <ol>
-        <li>
-          8.1
-          <a href="ch00/_external_merge_tools.html" >Git Configuration </a>
-        </li>
-        <li>
-          8.2
-          <a href="ch00/_keyword_expansion.html" >Git Attributes </a>
-        </li>
-        <li>
-          8.3
-          <a href="ch00/_email_hooks.html" >Git Hooks </a>
-        </li>
-        <li>
-          8.4
-          <a href="ch00/_enforcing_commit_message_format.html" >An Example Git-Enforced Policy </a>
-        </li>
-        <li>
-          8.5
-          <a href="Customizing-Git-Summary.html" >Summary </a>
-        </li>
-    </ol>
-  </li>
-  <li class='chapter'>
-  <h2>9. <a href="ch00/_git_svn.html">Git and Other Systems</a></h2>
-    <ol>
-        <li>
-          9.1
-          <a href="ch00/_git_svn.html" >Git as a Client </a>
-        </li>
-        <li>
-          9.2
-          <a href="ch00/_git_p4.html" >Migrating to Git </a>
-        </li>
-        <li>
-          9.3
-          <a href="Git-and-Other-Systems-Summary.html" >Summary </a>
-        </li>
-    </ol>
-  </li>
-  <li class='chapter'>
-  <h2>10. <a href="ch00/_plumbing_porcelain.html">Git Internals</a></h2>
-    <ol>
-        <li>
-          10.1
-          <a href="ch00/_plumbing_porcelain.html" >Plumbing and Porcelain </a>
-        </li>
-        <li>
-          10.2
-          <a href="ch00/_git_commit_objects.html" >Git Objects </a>
-        </li>
-        <li>
-          10.3
-          <a href="ch00/ref_the_ref.html" >Git References </a>
-        </li>
-        <li>
-          10.4
-          <a href="Git-Internals-Packfiles.html" >Packfiles </a>
-        </li>
-        <li>
-          10.5
-          <a href="ch00/_pushing_refspecs.html" >The Refspec </a>
-        </li>
-        <li>
-          10.6
-          <a href="Git-Internals-Transfer-Protocols.html" >Transfer Protocols </a>
-        </li>
-        <li>
-          10.7
-          <a href="ch00/_git_gc.html" >Maintenance and Data Recovery </a>
-        </li>
-        <li>
-          10.8
-          <a href="Git-Internals-Environment-Variables.html" >Environment Variables </a>
-        </li>
-        <li>
-          10.9
-          <a href="Git-Internals-Summary.html" >Summary </a>
-        </li>
-    </ol>
-  </li>
-</ol>
-    </div>
-    <div class='column-right'>
-      <ol class='book-toc'>
-  <li class='chapter'>
-  <h2>A1. <a href="./Appendix-A:-Git-in-Other-Environments-Graphical-Interfaces.html">Appendix A: Git in Other Environments</a></h2>
-    <ol>
-        <li>
-          A1.1
-          <a href="./Appendix-A:-Git-in-Other-Environments-Graphical-Interfaces.html" >Graphical Interfaces </a>
-        </li>
-        <li>
-          A1.2
-          <a href="./Appendix-A:-Git-in-Other-Environments-Git-in-Visual-Studio.html" >Git in Visual Studio </a>
-        </li>
-        <li>
-          A1.3
-          <a href="./Appendix-A:-Git-in-Other-Environments-Git-in-Visual-Studio-Code.html" >Git in Visual Studio Code </a>
-        </li>
-        <li>
-          A1.4
-          <a href="./Appendix-A:-Git-in-Other-Environments-Git-in-IntelliJ-%252F-PyCharm-%252F-WebStorm-%252F-PhpStorm-%252F-RubyMine.html" >Git in IntelliJ / PyCharm / WebStorm / PhpStorm / RubyMine </a>
-        </li>
-        <li>
-          A1.5
-          <a href="./Appendix-A:-Git-in-Other-Environments-Git-in-Sublime-Text.html" >Git in Sublime Text </a>
-        </li>
-        <li>
-          A1.6
-          <a href="./Appendix-A:-Git-in-Other-Environments-Git-in-Bash.html" >Git in Bash </a>
-        </li>
-        <li>
-          A1.7
-          <a href="ch00/oh_my_zsh_git.html" >Git in Zsh </a>
-        </li>
-        <li>
-          A1.8
-          <a href="./Appendix-A:-Git-in-Other-Environments-Git-in-PowerShell.html" >Git in PowerShell </a>
-        </li>
-        <li>
-          A1.9
-          <a href="./Appendix-A:-Git-in-Other-Environments-Summary.html" >Summary </a>
-        </li>
-    </ol>
-  </li>
-  <li class='chapter'>
-  <h2>A2. <a href="./Appendix-B:-Embedding-Git-in-your-Applications-Command-line-Git.html">Appendix B: Embedding Git in your Applications</a></h2>
-    <ol>
-        <li>
-          A2.1
-          <a href="./Appendix-B:-Embedding-Git-in-your-Applications-Command-line-Git.html" >Command-line Git </a>
-        </li>
-        <li>
-          A2.2
-          <a href="ch00/_libgit2_bindings.html" class=active>Libgit2 </a>
-        </li>
-        <li>
-          A2.3
-          <a href="./Appendix-B:-Embedding-Git-in-your-Applications-JGit.html" >JGit </a>
-        </li>
-        <li>
-          A2.4
-          <a href="./Appendix-B:-Embedding-Git-in-your-Applications-go-git.html" >go-git </a>
-        </li>
-        <li>
-          A2.5
-          <a href="./Appendix-B:-Embedding-Git-in-your-Applications-Dulwich.html" >Dulwich </a>
-        </li>
-    </ol>
-  </li>
-  <li class='chapter'>
-  <h2>A3. <a href="ch00/ch_core_editor.html">Appendix C: Git Commands</a></h2>
-    <ol>
-        <li>
-          A3.1
-          <a href="ch00/ch_core_editor.html" >Setup and Config </a>
-        </li>
-        <li>
-          A3.2
-          <a href="./Appendix-C:-Git-Commands-Getting-and-Creating-Projects.html" >Getting and Creating Projects </a>
-        </li>
-        <li>
-          A3.3
-          <a href="./Appendix-C:-Git-Commands-Basic-Snapshotting.html" >Basic Snapshotting </a>
-        </li>
-        <li>
-          A3.4
-          <a href="./Appendix-C:-Git-Commands-Branching-and-Merging.html" >Branching and Merging </a>
-        </li>
-        <li>
-          A3.5
-          <a href="./Appendix-C:-Git-Commands-Sharing-and-Updating-Projects.html" >Sharing and Updating Projects </a>
-        </li>
-        <li>
-          A3.6
-          <a href="./Appendix-C:-Git-Commands-Inspection-and-Comparison.html" >Inspection and Comparison </a>
-        </li>
-        <li>
-          A3.7
-          <a href="./Appendix-C:-Git-Commands-Debugging.html" >Debugging </a>
-        </li>
-        <li>
-          A3.8
-          <a href="./Appendix-C:-Git-Commands-Patching.html" >Patching </a>
-        </li>
-        <li>
-          A3.9
-          <a href="./Appendix-C:-Git-Commands-Email.html" >Email </a>
-        </li>
-        <li>
-          A3.10
-          <a href="./Appendix-C:-Git-Commands-External-Systems.html" >External Systems </a>
-        </li>
-        <li>
-          A3.11
-          <a href="./Appendix-C:-Git-Commands-Administration.html" >Administration </a>
-        </li>
-        <li>
-          A3.12
-          <a href="./Appendix-C:-Git-Commands-Plumbing-Commands.html" >Plumbing Commands </a>
-        </li>
-    </ol>
-  </li>
-</ol>
-    </div>
-  </div>
- </div>
-    <span class="light" id="edition">
-      2nd Edition
-    </span>
-</div>
-<div id='main' class="book edition2">
-    <h1>A2.2 Appendix B: Embedding Git in your Applications - Libgit2</h1>
-  <div>
-<h2 id="_libgit2">Libgit2</h2>
-<div class="paragraph">
-<p>
-Another option at your disposal is to use Libgit2.
-Libgit2 is a dependency-free implementation of Git, with a focus on having a nice API for use within other programs.
-You can find it at <a href="https://libgit2.org" class="bare">https://libgit2.org</a>.</p>
-</div>
-<div class="paragraph">
-<p>First, let’s take a look at what the C API looks like.
-Here’s a whirlwind tour:</p>
-</div>
-<div class="listingblock">
-<div class="content">
-<pre class="highlight"><code class="language-c" data-lang="c">// Open a repository
-git_repository *repo;
-int error = git_repository_open(&amp;repo, "/path/to/repository");
-// Dereference HEAD to a commit
-git_object *head_commit;
-error = git_revparse_single(&amp;head_commit, repo, "HEAD^{commit}");
-git_commit *commit = (git_commit*)head_commit;
-// Print some of the commit's properties
-printf("%s", git_commit_message(commit));
-const git_signature *author = git_commit_author(commit);
-printf("%s &lt;%s&gt;\n", author-&gt;name, author-&gt;email);
-const git_oid *tree_id = git_commit_tree_id(commit);
-// Cleanup
-git_commit_free(commit);
-git_repository_free(repo);</code></pre>
-</div>
-</div>
-<div class="paragraph">
-<p>The first couple of lines open a Git repository.
-The <code>git_repository</code> type represents a handle to a repository with a cache in memory.
-This is the simplest method, for when you know the exact path to a repository’s working directory or <code>.git</code> folder.
-There’s also the <code>git_repository_open_ext</code> which includes options for searching, <code>git_clone</code> and friends for making a local clone of a remote repository, and <code>git_repository_init</code> for creating an entirely new repository.</p>
-</div>
-<div class="paragraph">
-<p>The second chunk of code uses rev-parse syntax (see <a href="ch00/_branch_references.html">Branch References</a> for more on this) to get the commit that HEAD eventually points to.
-The type returned is a <code>git_object</code> pointer, which represents something that exists in the Git object database for a repository.
-<code>git_object</code> is actually a “parent” type for several different kinds of objects; the memory layout for each of the “child” types is the same as for <code>git_object</code>, so you can safely cast to the right one.
-In this case, <code>git_object_type(commit)</code> would return <code>GIT_OBJ_COMMIT</code>, so it’s safe to cast to a <code>git_commit</code> pointer.</p>
-</div>
-<div class="paragraph">
-<p>The next chunk shows how to access the commit’s properties.
-The last line here uses a <code>git_oid</code> type; this is Libgit2’s representation for a SHA-1 hash.</p>
-</div>
-<div class="paragraph">
-<p>From this sample, a couple of patterns have started to emerge:</p>
-</div>
-<div class="ulist">
-<ul>
-<li>
-<p>If you declare a pointer and pass a reference to it into a Libgit2 call, that call will probably return an integer error code.
-A <code>0</code> value indicates success; anything less is an error.</p>
-</li>
-<li>
-<p>If Libgit2 populates a pointer for you, you’re responsible for freeing it.</p>
-</li>
-<li>
-<p>If Libgit2 returns a <code>const</code> pointer from a call, you don’t have to free it, but it will become invalid when the object it belongs to is freed.</p>
-</li>
-<li>
-<p>Writing C is a bit painful.</p>
-</li>
-</ul>
-</div>
-<div class="paragraph">
-<p>
-That last one means it isn’t very probable that you’ll be writing C when using Libgit2.
-Fortunately, there are a number of language-specific bindings available that make it fairly easy to work with Git repositories from your specific language and environment.
-Let’s take a look at the above example written using the Ruby bindings for Libgit2, which are named Rugged, and can be found at <a href="https://github.com/libgit2/rugged" class="bare">https://github.com/libgit2/rugged</a>.</p>
-</div>
-<div class="listingblock">
-<div class="content">
-<pre class="highlight"><code class="language-ruby" data-lang="ruby">repo = Rugged::Repository.new('path/to/repository')
-commit = repo.head.target
-puts commit.message
-puts "#{commit.author[:name]} &lt;#{commit.author[:email]}&gt;"
-tree = commit.tree</code></pre>
-</div>
-</div>
-<div class="paragraph">
-<p>As you can see, the code is much less cluttered.
-Firstly, Rugged uses exceptions; it can raise things like <code>ConfigError</code> or <code>ObjectError</code> to signal error conditions.
-Secondly, there’s no explicit freeing of resources, since Ruby is garbage-collected.
-Let’s take a look at a slightly more complicated example: crafting a commit from scratch</p>
-</div>
-<div class="listingblock">
-<div class="content">
-<pre class="highlight"><code class="language-ruby" data-lang="ruby">blob_id = repo.write("Blob contents", :blob) # <b class="conum">(1)</b>
-index = repo.index
-index.read_tree(repo.head.target.tree)
-index.add(:path =&gt; 'newfile.txt', :oid =&gt; blob_id) # <b class="conum">(2)</b>
-sig = {
-    :email =&gt; "bob@example.com",
-    :name =&gt; "Bob User",
-    :time =&gt; Time.now,
-}
-commit_id = Rugged::Commit.create(repo,
-    :tree =&gt; index.write_tree(repo), # <b class="conum">(3)</b>
-    :author =&gt; sig,
-    :committer =&gt; sig, # <b class="conum">(4)</b>
-    :message =&gt; "Add newfile.txt", # <b class="conum">(5)</b>
-    :parents =&gt; repo.empty? ? [] : [ repo.head.target ].compact, # <b class="conum">(6)</b>
-    :update_ref =&gt; 'HEAD', # <b class="conum">(7)</b>
-)
-commit = repo.lookup(commit_id) # <b class="conum">(8)</b></code></pre>
-</div>
-</div>
-<div class="colist arabic">
-<ol>
-<li>
-<p>Create a new blob, which contains the contents of a new file.</p>
-</li>
-<li>
-<p>Populate the index with the head commit’s tree, and add the new file at the path <code>newfile.txt</code>.</p>
-</li>
-<li>
-<p>This creates a new tree in the ODB, and uses it for the new commit.</p>
-</li>
-<li>
-<p>We use the same signature for both the author and committer fields.</p>
-</li>
-<li>
-<p>The commit message.</p>
-</li>
-<li>
-<p>When creating a commit, you have to specify the new commit’s parents.
-This uses the tip of HEAD for the single parent.</p>
-</li>
-<li>
-<p>Rugged (and Libgit2) can optionally update a reference when making a commit.</p>
-</li>
-<li>
-<p>The return value is the SHA-1 hash of a new commit object, which you can then use to get a <code>Commit</code> object.</p>
-</li>
-</ol>
-</div>
-<div class="paragraph">
-<p>The Ruby code is nice and clean, but since Libgit2 is doing the heavy lifting, this code will run pretty fast, too.
-If you’re not a rubyist, we touch on some other bindings in <a href="ch00/_libgit2_bindings.html">Other Bindings</a>.</p>
-</div>
-<div class="sect3">
-<h3 id="_advanced_functionality">Advanced Functionality</h3>
-<div class="paragraph">
-<p>Libgit2 has a couple of capabilities that are outside the scope of core Git.
-One example is pluggability: Libgit2 allows you to provide custom “backends” for several types of operation, so you can store things in a different way than stock Git does.
-Libgit2 allows custom backends for configuration, ref storage, and the object database, among other things.</p>
-</div>
-<div class="paragraph">
-<p>Let’s take a look at how this works.
-The code below is borrowed from the set of backend examples provided by the Libgit2 team (which can be found at <a href="https://github.com/libgit2/libgit2-backends" class="bare">https://github.com/libgit2/libgit2-backends</a>).
-Here’s how a custom backend for the object database is set up:</p>
-</div>
-<div class="listingblock">
-<div class="content">
-<pre class="highlight"><code class="language-c" data-lang="c">git_odb *odb;
-int error = git_odb_new(&amp;odb); // <b class="conum">(1)</b>
-git_odb_backend *my_backend;
-error = git_odb_backend_mine(&amp;my_backend, /*…*/); // <b class="conum">(2)</b>
-error = git_odb_add_backend(odb, my_backend, 1); // <b class="conum">(3)</b>
-git_repository *repo;
-error = git_repository_open(&amp;repo, "some-path");
-error = git_repository_set_odb(repo, odb); // <b class="conum">(4)</b></code></pre>
-</div>
-</div>
-<div class="paragraph">
-<p><em>Note that errors are captured, but not handled. We hope your code is better than ours.</em></p>
-</div>
-<div class="colist arabic">
-<ol>
-<li>
-<p>Initialize an empty object database (ODB) “frontend,” which will act as a container for the “backends” which are the ones doing the real work.</p>
-</li>
-<li>
-<p>Initialize a custom ODB backend.</p>
-</li>
-<li>
-<p>Add the backend to the frontend.</p>
-</li>
-<li>
-<p>Open a repository, and set it to use our ODB to look up objects.</p>
-</li>
-</ol>
-</div>
-<div class="paragraph">
-<p>But what is this <code>git_odb_backend_mine</code> thing?
-Well, that’s the constructor for your own ODB implementation, and you can do whatever you want in there, so long as you fill in the <code>git_odb_backend</code> structure properly.
-Here’s what it <em>could</em> look like:</p>
-</div>
-<div class="listingblock">
-<div class="content">
-<pre class="highlight"><code class="language-c" data-lang="c">typedef struct {
-    git_odb_backend parent;
-    // Some other stuff
-    void *custom_context;
-} my_backend_struct;
-int git_odb_backend_mine(git_odb_backend **backend_out, /*…*/)
-{
-    my_backend_struct *backend;
-    backend = calloc(1, sizeof (my_backend_struct));
-    backend-&gt;custom_context = …;
-    backend-&gt;parent.read = &amp;my_backend__read;
-    backend-&gt;parent.read_prefix = &amp;my_backend__read_prefix;
-    backend-&gt;parent.read_header = &amp;my_backend__read_header;
-    // …
-    *backend_out = (git_odb_backend *) backend;
-    return GIT_SUCCESS;
-}</code></pre>
-</div>
-</div>
-<div class="paragraph">
-<p>The subtlest constraint here is that <code>my_backend_struct’s first member must be a `git_odb_backend</code> structure; this ensures that the memory layout is what the Libgit2 code expects it to be.
-The rest of it is arbitrary; this structure can be as large or small as you need it to be.</p>
-</div>
-<div class="paragraph">
-<p>The initialization function allocates some memory for the structure, sets up the custom context, and then fills in the members of the <code>parent</code> structure that it supports.
-Take a look at the <code>include/git2/sys/odb_backend.h</code> file in the Libgit2 source for a complete set of call signatures; your particular use case will help determine which of these you’ll want to support.</p>
-</div>
-</div>
-<div class="sect3">
-<h3 id="_libgit2_bindings">Other Bindings</h3>
-<div class="paragraph">
-<p>Libgit2 has bindings for many languages.
-Here we show a small example using a few of the more complete bindings packages as of this writing; libraries exist for many other languages, including C++, Go, Node.js, Erlang, and the JVM, all in various stages of maturity.
-The official collection of bindings can be found by browsing the repositories at <a href="https://github.com/libgit2" class="bare">https://github.com/libgit2</a>.
-The code we’ll write will return the commit message from the commit eventually pointed to by HEAD (sort of like <code>git log -1</code>).</p>
-</div>
-<div class="sect4">
-<h4 id="_libgit2sharp">LibGit2Sharp</h4>
-<div class="paragraph">
-<p>
-If you’re writing a .NET or Mono application, LibGit2Sharp (<a href="https://github.com/libgit2/libgit2sharp" class="bare">https://github.com/libgit2/libgit2sharp</a>) is what you’re looking for.
-The bindings are written in C#, and great care has been taken to wrap the raw Libgit2 calls with native-feeling CLR APIs.
-Here’s what our example program looks like:</p>
-</div>
-<div class="listingblock">
-<div class="content">
-<pre class="highlight"><code class="language-csharp" data-lang="csharp">new Repository(@"C:\path\to\repo").Head.Tip.Message;</code></pre>
-</div>
-</div>
-<div class="paragraph">
-<p>For desktop Windows applications, there’s even a NuGet package that will help you get started quickly.</p>
-</div>
-</div>
-<div class="sect4">
-<h4 id="_objective_git">objective-git</h4>
-<div class="paragraph">
-<p>
-If your application is running on an Apple platform, you’re likely using Objective-C as your implementation language.
-Objective-Git (<a href="https://github.com/libgit2/objective-git" class="bare">https://github.com/libgit2/objective-git</a>) is the name of the Libgit2 bindings for that environment.
-The example program looks like this:</p>
-</div>
-<div class="listingblock">
-<div class="content">
-<pre class="highlight"><code class="language-objc" data-lang="objc">GTRepository *repo =
-    [[GTRepository alloc] initWithURL:[NSURL fileURLWithPath: @"/path/to/repo"] error:NULL];
-NSString *msg = [[[repo headReferenceWithError:NULL] resolvedTarget] message];</code></pre>
-</div>
-</div>
-<div class="paragraph">
-<p>Objective-git is fully interoperable with Swift, so don’t fear if you’ve left Objective-C behind.</p>
-</div>
-</div>
-<div class="sect4">
-<h4 id="_pygit2">pygit2</h4>
-<div class="paragraph">
-<p>
-The bindings for Libgit2 in Python are called Pygit2, and can be found at <a href="https://www.pygit2.org" class="bare">https://www.pygit2.org</a>.
-Our example program:</p>
-</div>
-<div class="listingblock">
-<div class="content">
-<pre class="highlight"><code class="language-python" data-lang="python">pygit2.Repository("/path/to/repo") # open repository
-    .head                          # get the current branch
-    .peel(pygit2.Commit)           # walk down to the commit
-    .message                       # read the message</code></pre>
-</div>
-</div>
-</div>
-</div>
-<div class="sect3">
-<h3 id="_further_reading">Further Reading</h3>
-<div class="paragraph">
-<p>Of course, a full treatment of Libgit2’s capabilities is outside the scope of this book.
-If you want more information on Libgit2 itself, there’s API documentation at <a href="https://libgit2.github.com/libgit2" class="bare">https://libgit2.github.com/libgit2</a>, and a set of guides at <a href="https://libgit2.github.com/docs" class="bare">https://libgit2.github.com/docs</a>.
-For the other bindings, check the bundled README and tests; there are often small tutorials and pointers to further reading there.</p>
-</div>
-</div>
-<div id="nav"><a href="./Appendix-B:-Embedding-Git-in-your-Applications-Command-line-Git.html">prev</a> | <a href="./Appendix-B:-Embedding-Git-in-your-Applications-JGit.html">next</a></div></div>
-</div>
-        </div>
-      </div>
-      <footer>
-  <div class="site-source">
-    <a href="https://git-scm.com/site">About this site</a><br>
-    Patches, suggestions, and comments are welcome.
-  </div>
-  <div class="sfc-member">
-    Git is a member of <a href="https://git-scm.com/sfc">Software Freedom Conservancy</a>
-  </div>
-</footer>
-<a href="ch00/_libgit2_bindings.html#top" class="no-js scrollToTop" id="scrollToTop" data-label="Scroll to top">
-  <img src="../../../images/icons/chevron-up@2x.png" width="20" height="20" alt="scroll-to-top"/>
-</a>
-<script src="../../../assets/application-38b0d42ff05ffea45841edebbd14b75b89585646153808e82907c2c5c11f324b.js"></script>
-    </div>
-</body>
-</html>