Docs build 2024-11-16

Author: github-actions

en/latest/_sources/facts/git.rst.txt

@@ -20,7 +20,7 @@ See also: :doc:`../operations/git`.
 
 .. code:: python
 
-    host.get_fact(GitConfig, repo=None)
+    host.get_fact(GitConfig, repo=None, system=False)
 
 
 .. _facts:git.GitTrackingBranch:

en/latest/_sources/operations/git.rst.txt

@@ -38,26 +38,42 @@ Create bare git repositories.
 :code:`git.config`
 ~~~~~~~~~~~~~~~~~~
 
-Manage git config for a repository or globally.
+Manage git config at repository, user or system level.
 
 .. code:: python
 
-    git.config(key, value, multi_value=False, repo=None)
+    git.config(key, value, multi_value=False, repo=None, system=False)
 
 + **key**: the key of the config to ensure
 + **value**: the value this key should have
 + **multi_value**: Add the value rather than set it for settings that can have multiple values
 + **repo**: specify the git repo path to edit local config (defaults to global)
++ **system**: whether, when ``repo`` is unspecified, to work at system level (or default to global)
 
-**Example:**
+**Examples:**
 
 .. code:: python
 
     git.config(
-        name="Ensure user name is set for a repo",
+        name="Always prune specified repo",
+        key="fetch.prune",
+        value="true",
+        repo="/usr/local/src/pyinfra",
+    )
+
+    git.config(
+        name="Ensure user name is set for all repos of specified user",
         key="user.name",
         value="Anon E. Mouse",
-        repo="/usr/local/src/pyinfra",
+        _sudo=True,
+        _sudo_user="anon"
+    )
+
+    git.config(
+        name="Ensure same date format for all users",
+        key="log.date",
+        value="iso",
+        system=True
     )
 
 

en/latest/facts/git.html

@@ -194,7 +194,7 @@ <h1>Git Facts<a class="headerlink" href="#git-facts" title="Permalink to this he
 </div>
 <div class="section" id="git-gitconfig">
 <span id="facts-git-gitconfig"></span><h2><code class="code docutils literal notranslate"><span class="pre">git.GitConfig</span></code><a class="headerlink" href="#git-gitconfig" title="Permalink to this heading">¶</a></h2>
-<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="n">host</span><span class="o">.</span><span class="n">get_fact</span><span class="p">(</span><span class="n">GitConfig</span><span class="p">,</span> <span class="n">repo</span><span class="o">=</span><span class="kc">None</span><span class="p">)</span>
+<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="n">host</span><span class="o">.</span><span class="n">get_fact</span><span class="p">(</span><span class="n">GitConfig</span><span class="p">,</span> <span class="n">repo</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">system</span><span class="o">=</span><span class="kc">False</span><span class="p">)</span>
 </pre></div>
 </div>
 </div>

en/latest/operations/git.html

@@ -209,22 +209,38 @@ <h1>Git Operations<a class="headerlink" href="#git-operations" title="Permalink
 </div>
 <div class="section" id="git-config">
 <span id="operations-git-config"></span><h2><code class="code docutils literal notranslate"><span class="pre">git.config</span></code><a class="headerlink" href="#git-config" title="Permalink to this heading">¶</a></h2>
-<p>Manage git config for a repository or globally.</p>
-<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="n">git</span><span class="o">.</span><span class="n">config</span><span class="p">(</span><span class="n">key</span><span class="p">,</span> <span class="n">value</span><span class="p">,</span> <span class="n">multi_value</span><span class="o">=</span><span class="kc">False</span><span class="p">,</span> <span class="n">repo</span><span class="o">=</span><span class="kc">None</span><span class="p">)</span>
+<p>Manage git config at repository, user or system level.</p>
+<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="n">git</span><span class="o">.</span><span class="n">config</span><span class="p">(</span><span class="n">key</span><span class="p">,</span> <span class="n">value</span><span class="p">,</span> <span class="n">multi_value</span><span class="o">=</span><span class="kc">False</span><span class="p">,</span> <span class="n">repo</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">system</span><span class="o">=</span><span class="kc">False</span><span class="p">)</span>
 </pre></div>
 </div>
 <ul class="simple">
 <li><strong>key</strong>: the key of the config to ensure</li>
 <li><strong>value</strong>: the value this key should have</li>
 <li><strong>multi_value</strong>: Add the value rather than set it for settings that can have multiple values</li>
 <li><strong>repo</strong>: specify the git repo path to edit local config (defaults to global)</li>
+<li><strong>system</strong>: whether, when <code class="docutils literal notranslate"><span class="pre">repo</span></code> is unspecified, to work at system level (or default to global)</li>
 </ul>
-<p><strong>Example:</strong></p>
+<p><strong>Examples:</strong></p>
 <div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="n">git</span><span class="o">.</span><span class="n">config</span><span class="p">(</span>
-    <span class="n">name</span><span class="o">=</span><span class="s2">&quot;Ensure user name is set for a repo&quot;</span><span class="p">,</span>
+    <span class="n">name</span><span class="o">=</span><span class="s2">&quot;Always prune specified repo&quot;</span><span class="p">,</span>
+    <span class="n">key</span><span class="o">=</span><span class="s2">&quot;fetch.prune&quot;</span><span class="p">,</span>
+    <span class="n">value</span><span class="o">=</span><span class="s2">&quot;true&quot;</span><span class="p">,</span>
+    <span class="n">repo</span><span class="o">=</span><span class="s2">&quot;/usr/local/src/pyinfra&quot;</span><span class="p">,</span>
+<span class="p">)</span>
+
+<span class="n">git</span><span class="o">.</span><span class="n">config</span><span class="p">(</span>
+    <span class="n">name</span><span class="o">=</span><span class="s2">&quot;Ensure user name is set for all repos of specified user&quot;</span><span class="p">,</span>
     <span class="n">key</span><span class="o">=</span><span class="s2">&quot;user.name&quot;</span><span class="p">,</span>
     <span class="n">value</span><span class="o">=</span><span class="s2">&quot;Anon E. Mouse&quot;</span><span class="p">,</span>
-    <span class="n">repo</span><span class="o">=</span><span class="s2">&quot;/usr/local/src/pyinfra&quot;</span><span class="p">,</span>
+    <span class="n">_sudo</span><span class="o">=</span><span class="kc">True</span><span class="p">,</span>
+    <span class="n">_sudo_user</span><span class="o">=</span><span class="s2">&quot;anon&quot;</span>
+<span class="p">)</span>
+
+<span class="n">git</span><span class="o">.</span><span class="n">config</span><span class="p">(</span>
+    <span class="n">name</span><span class="o">=</span><span class="s2">&quot;Ensure same date format for all users&quot;</span><span class="p">,</span>
+    <span class="n">key</span><span class="o">=</span><span class="s2">&quot;log.date&quot;</span><span class="p">,</span>
+    <span class="n">value</span><span class="o">=</span><span class="s2">&quot;iso&quot;</span><span class="p">,</span>
+    <span class="n">system</span><span class="o">=</span><span class="kc">True</span>
 <span class="p">)</span>
 </pre></div>
 </div>

en/latest/searchindex.js

@@ -20,7 +20,7 @@ See also: :doc:`../operations/git`.
 
 .. code:: python
 
-    host.get_fact(GitConfig, repo=None)
+    host.get_fact(GitConfig, repo=None, system=False)
 
 
 .. _facts:git.GitTrackingBranch:

en/next/_sources/facts/git.rst.txt

@@ -38,26 +38,42 @@ Create bare git repositories.
 :code:`git.config`
 ~~~~~~~~~~~~~~~~~~
 
-Manage git config for a repository or globally.
+Manage git config at repository, user or system level.
 
 .. code:: python
 
-    git.config(key, value, multi_value=False, repo=None)
+    git.config(key, value, multi_value=False, repo=None, system=False)
 
 + **key**: the key of the config to ensure
 + **value**: the value this key should have
 + **multi_value**: Add the value rather than set it for settings that can have multiple values
 + **repo**: specify the git repo path to edit local config (defaults to global)
++ **system**: whether, when ``repo`` is unspecified, to work at system level (or default to global)
 
-**Example:**
+**Examples:**
 
 .. code:: python
 
     git.config(
-        name="Ensure user name is set for a repo",
+        name="Always prune specified repo",
+        key="fetch.prune",
+        value="true",
+        repo="/usr/local/src/pyinfra",
+    )
+
+    git.config(
+        name="Ensure user name is set for all repos of specified user",
         key="user.name",
         value="Anon E. Mouse",
-        repo="/usr/local/src/pyinfra",
+        _sudo=True,
+        _sudo_user="anon"
+    )
+
+    git.config(
+        name="Ensure same date format for all users",
+        key="log.date",
+        value="iso",
+        system=True
     )
 
 

en/next/_sources/operations/git.rst.txt

@@ -194,7 +194,7 @@ <h1>Git Facts<a class="headerlink" href="#git-facts" title="Permalink to this he
 </div>
 <div class="section" id="git-gitconfig">
 <span id="facts-git-gitconfig"></span><h2><code class="code docutils literal notranslate"><span class="pre">git.GitConfig</span></code><a class="headerlink" href="#git-gitconfig" title="Permalink to this heading">¶</a></h2>
-<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="n">host</span><span class="o">.</span><span class="n">get_fact</span><span class="p">(</span><span class="n">GitConfig</span><span class="p">,</span> <span class="n">repo</span><span class="o">=</span><span class="kc">None</span><span class="p">)</span>
+<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="n">host</span><span class="o">.</span><span class="n">get_fact</span><span class="p">(</span><span class="n">GitConfig</span><span class="p">,</span> <span class="n">repo</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">system</span><span class="o">=</span><span class="kc">False</span><span class="p">)</span>
 </pre></div>
 </div>
 </div>

en/next/facts/git.html

@@ -209,22 +209,38 @@ <h1>Git Operations<a class="headerlink" href="#git-operations" title="Permalink
 </div>
 <div class="section" id="git-config">
 <span id="operations-git-config"></span><h2><code class="code docutils literal notranslate"><span class="pre">git.config</span></code><a class="headerlink" href="#git-config" title="Permalink to this heading">¶</a></h2>
-<p>Manage git config for a repository or globally.</p>
-<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="n">git</span><span class="o">.</span><span class="n">config</span><span class="p">(</span><span class="n">key</span><span class="p">,</span> <span class="n">value</span><span class="p">,</span> <span class="n">multi_value</span><span class="o">=</span><span class="kc">False</span><span class="p">,</span> <span class="n">repo</span><span class="o">=</span><span class="kc">None</span><span class="p">)</span>
+<p>Manage git config at repository, user or system level.</p>
+<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="n">git</span><span class="o">.</span><span class="n">config</span><span class="p">(</span><span class="n">key</span><span class="p">,</span> <span class="n">value</span><span class="p">,</span> <span class="n">multi_value</span><span class="o">=</span><span class="kc">False</span><span class="p">,</span> <span class="n">repo</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">system</span><span class="o">=</span><span class="kc">False</span><span class="p">)</span>
 </pre></div>
 </div>
 <ul class="simple">
 <li><strong>key</strong>: the key of the config to ensure</li>
 <li><strong>value</strong>: the value this key should have</li>
 <li><strong>multi_value</strong>: Add the value rather than set it for settings that can have multiple values</li>
 <li><strong>repo</strong>: specify the git repo path to edit local config (defaults to global)</li>
+<li><strong>system</strong>: whether, when <code class="docutils literal notranslate"><span class="pre">repo</span></code> is unspecified, to work at system level (or default to global)</li>
 </ul>
-<p><strong>Example:</strong></p>
+<p><strong>Examples:</strong></p>
 <div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="n">git</span><span class="o">.</span><span class="n">config</span><span class="p">(</span>
-    <span class="n">name</span><span class="o">=</span><span class="s2">&quot;Ensure user name is set for a repo&quot;</span><span class="p">,</span>
+    <span class="n">name</span><span class="o">=</span><span class="s2">&quot;Always prune specified repo&quot;</span><span class="p">,</span>
+    <span class="n">key</span><span class="o">=</span><span class="s2">&quot;fetch.prune&quot;</span><span class="p">,</span>
+    <span class="n">value</span><span class="o">=</span><span class="s2">&quot;true&quot;</span><span class="p">,</span>
+    <span class="n">repo</span><span class="o">=</span><span class="s2">&quot;/usr/local/src/pyinfra&quot;</span><span class="p">,</span>
+<span class="p">)</span>
+
+<span class="n">git</span><span class="o">.</span><span class="n">config</span><span class="p">(</span>
+    <span class="n">name</span><span class="o">=</span><span class="s2">&quot;Ensure user name is set for all repos of specified user&quot;</span><span class="p">,</span>
     <span class="n">key</span><span class="o">=</span><span class="s2">&quot;user.name&quot;</span><span class="p">,</span>
     <span class="n">value</span><span class="o">=</span><span class="s2">&quot;Anon E. Mouse&quot;</span><span class="p">,</span>
-    <span class="n">repo</span><span class="o">=</span><span class="s2">&quot;/usr/local/src/pyinfra&quot;</span><span class="p">,</span>
+    <span class="n">_sudo</span><span class="o">=</span><span class="kc">True</span><span class="p">,</span>
+    <span class="n">_sudo_user</span><span class="o">=</span><span class="s2">&quot;anon&quot;</span>
+<span class="p">)</span>
+
+<span class="n">git</span><span class="o">.</span><span class="n">config</span><span class="p">(</span>
+    <span class="n">name</span><span class="o">=</span><span class="s2">&quot;Ensure same date format for all users&quot;</span><span class="p">,</span>
+    <span class="n">key</span><span class="o">=</span><span class="s2">&quot;log.date&quot;</span><span class="p">,</span>
+    <span class="n">value</span><span class="o">=</span><span class="s2">&quot;iso&quot;</span><span class="p">,</span>
+    <span class="n">system</span><span class="o">=</span><span class="kc">True</span>
 <span class="p">)</span>
 </pre></div>
 </div>