/usr/share/doc/python-pygit2-doc/html/config.html is in python-pygit2-doc 0.26.2-2.
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 | <!DOCTYPE html>
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>Configuration files — pygit2 0.26.2 documentation</title>
<link href='https://fonts.googleapis.com/css?family=Lato:400,700,400italic,700italic|Roboto+Slab:400,700|Inconsolata:400,700' rel='stylesheet' type='text/css'>
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
<link rel="index" title="Index"
href="genindex.html"/>
<link rel="search" title="Search" href="search.html"/>
<link rel="top" title="pygit2 0.26.2 documentation" href="index.html"/>
<link rel="next" title="Remotes" href="remotes.html"/>
<link rel="prev" title="Merge & Cherrypick" href="merge.html"/>
</head>
<body class="wy-body-for-nav" role="document">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-nav-search">
<a href="index.html" class="fa fa-home"> pygit2</a>
<div role="search">
<form id ="rtd-search-form" class="wy-form" action="search.html" method="get">
<input type="text" name="q" placeholder="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div>
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
<ul>
<li class="toctree-l1"><a class="reference internal" href="install.html">Installation</a><ul>
<li class="toctree-l2"><a class="reference internal" href="install.html#requirements">Requirements</a></li>
<li class="toctree-l2"><a class="reference internal" href="install.html#quick-install">Quick install</a></li>
<li class="toctree-l2"><a class="reference internal" href="install.html#build-options">Build options</a></li>
<li class="toctree-l2"><a class="reference internal" href="install.html#libgit2-within-a-virtual-environment">libgit2 within a virtual environment</a></li>
<li class="toctree-l2"><a class="reference internal" href="install.html#installing-on-windows">Installing on Windows</a></li>
<li class="toctree-l2"><a class="reference internal" href="install.html#installing-on-os-x">Installing on OS X</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="development.html">The development version</a><ul>
<li class="toctree-l2"><a class="reference internal" href="development.html#coding-style-documentation-strings">Coding style: documentation strings</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="recipes.html">pygit2 Recipes</a><ul>
<li class="toctree-l2"><a class="reference internal" href="recipes.html#high-level-commands">High Level Commands</a></li>
</ul>
</li>
</ul>
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="general.html">General</a><ul>
<li class="toctree-l2"><a class="reference internal" href="general.html#version">Version</a></li>
<li class="toctree-l2"><a class="reference internal" href="general.html#options">Options</a></li>
<li class="toctree-l2"><a class="reference internal" href="general.html#exceptions">Exceptions</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="repository.html">The repository</a><ul>
<li class="toctree-l2"><a class="reference internal" href="repository.html#functions">Functions</a></li>
<li class="toctree-l2"><a class="reference internal" href="repository.html#the-repository-class">The Repository class</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="oid.html">Object IDs</a><ul>
<li class="toctree-l2"><a class="reference internal" href="oid.html#the-three-forms-of-an-object-id">The three forms of an object id</a></li>
<li class="toctree-l2"><a class="reference internal" href="oid.html#the-oid-type">The Oid type</a></li>
<li class="toctree-l2"><a class="reference internal" href="oid.html#constants">Constants</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="objects.html">Git Objects</a><ul>
<li class="toctree-l2"><a class="reference internal" href="objects.html#object-lookup">Object lookup</a></li>
<li class="toctree-l2"><a class="reference internal" href="objects.html#the-object-base-type">The Object base type</a></li>
<li class="toctree-l2"><a class="reference internal" href="objects.html#blobs">Blobs</a></li>
<li class="toctree-l2"><a class="reference internal" href="objects.html#trees">Trees</a></li>
<li class="toctree-l2"><a class="reference internal" href="objects.html#commits">Commits</a></li>
<li class="toctree-l2"><a class="reference internal" href="objects.html#tags">Tags</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="references.html">References</a><ul>
<li class="toctree-l2"><a class="reference internal" href="references.html#the-reference-type">The Reference type</a></li>
<li class="toctree-l2"><a class="reference internal" href="references.html#the-head">The HEAD</a></li>
<li class="toctree-l2"><a class="reference internal" href="references.html#branches">Branches</a></li>
<li class="toctree-l2"><a class="reference internal" href="references.html#the-branch-type">The Branch type</a></li>
<li class="toctree-l2"><a class="reference internal" href="references.html#the-reference-log">The reference log</a></li>
<li class="toctree-l2"><a class="reference internal" href="references.html#notes">Notes</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="revparse.html">Revision parsing</a></li>
<li class="toctree-l1"><a class="reference internal" href="log.html">Commit log</a></li>
<li class="toctree-l1"><a class="reference internal" href="working-copy.html">The Index file and the Working copy</a><ul>
<li class="toctree-l2"><a class="reference internal" href="working-copy.html#the-index-type">The Index type</a></li>
<li class="toctree-l2"><a class="reference internal" href="working-copy.html#status">Status</a></li>
<li class="toctree-l2"><a class="reference internal" href="working-copy.html#checkout">Checkout</a></li>
<li class="toctree-l2"><a class="reference internal" href="working-copy.html#stash">Stash</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="diff.html">Diff</a><ul>
<li class="toctree-l2"><a class="reference internal" href="diff.html#the-diff-type">The Diff type</a></li>
<li class="toctree-l2"><a class="reference internal" href="diff.html#the-patch-type">The Patch type</a></li>
<li class="toctree-l2"><a class="reference internal" href="diff.html#the-diffdelta-type">The DiffDelta type</a></li>
<li class="toctree-l2"><a class="reference internal" href="diff.html#the-difffile-type">The DiffFile type</a></li>
<li class="toctree-l2"><a class="reference internal" href="diff.html#the-diffhunk-type">The DiffHunk type</a></li>
<li class="toctree-l2"><a class="reference internal" href="diff.html#the-diffstats-type">The DiffStats type</a></li>
<li class="toctree-l2"><a class="reference internal" href="diff.html#the-diffline-type">The DiffLine type</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="merge.html">Merge & Cherrypick</a><ul>
<li class="toctree-l2"><a class="reference internal" href="merge.html#the-merge-method">The merge method</a></li>
<li class="toctree-l2"><a class="reference internal" href="merge.html#cherrypick">Cherrypick</a></li>
<li class="toctree-l2"><a class="reference internal" href="merge.html#lower-level-methods">Lower-level methods</a></li>
</ul>
</li>
<li class="toctree-l1 current"><a class="current reference internal" href="#">Configuration files</a><ul>
<li class="toctree-l2"><a class="reference internal" href="#the-config-type">The Config type</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="remotes.html">Remotes</a><ul>
<li class="toctree-l2"><a class="reference internal" href="remotes.html#the-remote-collection">The remote collection</a></li>
<li class="toctree-l2"><a class="reference internal" href="remotes.html#the-remote-type">The Remote type</a></li>
<li class="toctree-l2"><a class="reference internal" href="remotes.html#the-remotecallbacks-type">The RemoteCallbacks type</a></li>
<li class="toctree-l2"><a class="reference internal" href="remotes.html#the-transferprogress-type">The TransferProgress type</a></li>
<li class="toctree-l2"><a class="reference internal" href="remotes.html#the-refspec-type">The Refspec type</a></li>
<li class="toctree-l2"><a class="reference internal" href="remotes.html#credentials">Credentials</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="submodule.html">Submodules</a><ul>
<li class="toctree-l2"><a class="reference internal" href="submodule.html#the-submodule-type">The Submodule type</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="blame.html">Blame</a><ul>
<li class="toctree-l2"><a class="reference internal" href="blame.html#the-blame-type">The Blame type</a></li>
<li class="toctree-l2"><a class="reference internal" href="blame.html#the-blamehunk-type">The BlameHunk type</a></li>
<li class="toctree-l2"><a class="reference internal" href="blame.html#constants">Constants</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="settings.html">Settings</a></li>
<li class="toctree-l1"><a class="reference internal" href="features.html">Feature detection</a></li>
<li class="toctree-l1"><a class="reference internal" href="backends.html">Custom backends</a></li>
</ul>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
<nav class="wy-nav-top" role="navigation" aria-label="top navigation">
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="index.html">pygit2</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
<li><a href="index.html">Docs</a> »</li>
<li>Configuration files</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/config.rst.txt" rel="nofollow"> View page source</a>
</li>
</ul>
<hr/>
</div>
<div role="main">
<div class="section" id="configuration-files">
<h1>Configuration files<a class="headerlink" href="#configuration-files" title="Permalink to this headline">¶</a></h1>
<dl class="attribute">
<dt id="pygit2.Repository.config">
<code class="descclassname">Repository.</code><code class="descname">config</code><a class="headerlink" href="#pygit2.Repository.config" title="Permalink to this definition">¶</a></dt>
<dd><p>The configuration file for this repository.</p>
<p>If a the configuration hasn’t been set yet, the default config for
repository will be returned, including global and system configurations
(if they are available).</p>
</dd></dl>
<div class="section" id="the-config-type">
<h2>The Config type<a class="headerlink" href="#the-config-type" title="Permalink to this headline">¶</a></h2>
<dl class="staticmethod">
<dt id="pygit2.Config.get_system_config">
<em class="property">static </em><code class="descclassname">Config.</code><code class="descname">get_system_config</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pygit2.Config.get_system_config" title="Permalink to this definition">¶</a></dt>
<dd><p>Return a <Config> object representing the system configuration file.</p>
</dd></dl>
<dl class="staticmethod">
<dt id="pygit2.Config.get_global_config">
<em class="property">static </em><code class="descclassname">Config.</code><code class="descname">get_global_config</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pygit2.Config.get_global_config" title="Permalink to this definition">¶</a></dt>
<dd><p>Return a <Config> object representing the global configuration file.</p>
</dd></dl>
<dl class="method">
<dt id="pygit2.Config.add_file">
<code class="descclassname">Config.</code><code class="descname">add_file</code><span class="sig-paren">(</span><em>path</em>, <em>level=0</em>, <em>force=0</em><span class="sig-paren">)</span><a class="headerlink" href="#pygit2.Config.add_file" title="Permalink to this definition">¶</a></dt>
<dd><p>Add a config file instance to an existing config.</p>
</dd></dl>
<dl class="method">
<dt id="pygit2.Config.get_multivar">
<code class="descclassname">Config.</code><code class="descname">get_multivar</code><span class="sig-paren">(</span><em>name</em>, <em>regex=None</em><span class="sig-paren">)</span><a class="headerlink" href="#pygit2.Config.get_multivar" title="Permalink to this definition">¶</a></dt>
<dd><p>Get each value of a multivar ‘’name’’ as a list of strings.</p>
<p>The optional ‘’regex’’ parameter is expected to be a regular expression
to filter the variables we’re interested in.</p>
</dd></dl>
<dl class="method">
<dt id="pygit2.Config.set_multivar">
<code class="descclassname">Config.</code><code class="descname">set_multivar</code><span class="sig-paren">(</span><em>name</em>, <em>regex</em>, <em>value</em><span class="sig-paren">)</span><a class="headerlink" href="#pygit2.Config.set_multivar" title="Permalink to this definition">¶</a></dt>
<dd><p>Set a multivar ‘’name’’ to ‘’value’‘. ‘’regexp’’ is a regular
expression to indicate which values to replace.</p>
</dd></dl>
<dl class="method">
<dt id="Config.__iter__">
<code class="descclassname">Config.</code><code class="descname">__iter__</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#Config.__iter__" title="Permalink to this definition">¶</a></dt>
<dd><p>The <code class="xref py py-class docutils literal"><span class="pre">Config</span></code> class has an iterator which can be used to loop
through all the entries in the configuration. Each element is a tuple
containing the name and the value of each configuration variable. Be
aware that this may return multiple versions of each entry if they are
set multiple times in the configuration files.</p>
</dd></dl>
<p>The <code class="xref py py-class docutils literal"><span class="pre">Config</span></code> Mapping interface.</p>
<p>When using the mapping interface, the value is returned as a
string. In order to apply the git-config parsing rules, you can use
<a class="reference internal" href="#pygit2.Config.get_bool" title="pygit2.Config.get_bool"><code class="xref py py-meth docutils literal"><span class="pre">Config.get_bool()</span></code></a> or <a class="reference internal" href="#pygit2.Config.get_int" title="pygit2.Config.get_int"><code class="xref py py-meth docutils literal"><span class="pre">Config.get_int()</span></code></a>.</p>
<dl class="method">
<dt id="pygit2.Config.get_bool">
<code class="descclassname">Config.</code><code class="descname">get_bool</code><span class="sig-paren">(</span><em>key</em><span class="sig-paren">)</span><a class="headerlink" href="#pygit2.Config.get_bool" title="Permalink to this definition">¶</a></dt>
<dd><p>Look up <em>key</em> and parse its value as a boolean as per the git-config
rules. Return a boolean value (True or False).</p>
<p>Truthy values are: ‘true’, 1, ‘on’ or ‘yes’. Falsy values are: ‘false’,
0, ‘off’ and ‘no’</p>
</dd></dl>
<dl class="method">
<dt id="pygit2.Config.get_int">
<code class="descclassname">Config.</code><code class="descname">get_int</code><span class="sig-paren">(</span><em>key</em><span class="sig-paren">)</span><a class="headerlink" href="#pygit2.Config.get_int" title="Permalink to this definition">¶</a></dt>
<dd><p>Look up <em>key</em> and parse its value as an integer as per the git-config
rules. Return an integer.</p>
<p>A value can have a suffix ‘k’, ‘m’ or ‘g’ which stand for ‘kilo’,
‘mega’ and ‘giga’ respectively.</p>
</dd></dl>
</div>
</div>
</div>
<footer>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="remotes.html" class="btn btn-neutral float-right" title="Remotes">Next <span class="fa fa-arrow-circle-right"></span></a>
<a href="merge.html" class="btn btn-neutral" title="Merge & Cherrypick"><span class="fa fa-arrow-circle-left"></span> Previous</a>
</div>
<hr/>
<div role="contentinfo">
<p>
© Copyright 2010-2017 The pygit2 contributors.
</p>
</div>
<a href="https://github.com/snide/sphinx_rtd_theme">Sphinx theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>
</footer>
</div>
</div>
</section>
</div>
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT:'./',
VERSION:'0.26.2',
COLLAPSE_INDEX:false,
FILE_SUFFIX:'.html',
HAS_SOURCE: true
};
</script>
<script type="text/javascript" src="_static/jquery.js"></script>
<script type="text/javascript" src="_static/underscore.js"></script>
<script type="text/javascript" src="_static/doctools.js"></script>
<script type="text/javascript" src="_static/js/theme.js"></script>
<script type="text/javascript">
jQuery(function () {
SphinxRtdTheme.StickyNav.enable();
});
</script>
</body>
</html>
|