Skip to content

Commit

Permalink
Deployed 785f012 with MkDocs version: 1.6.1
Browse files Browse the repository at this point in the history
  • Loading branch information
Unknown committed Jan 13, 2025
1 parent d862879 commit ad6bd69
Show file tree
Hide file tree
Showing 281 changed files with 1,027 additions and 953 deletions.
2 changes: 1 addition & 1 deletion 404.html
Original file line number Diff line number Diff line change
Expand Up @@ -8490,7 +8490,7 @@ <h1>404 - Not found</h1>
<div class="md-copyright">

<div class="md-copyright__highlight">
Copyright © Tom Payne 2018-2024
Copyright © Tom Payne 2018-2025
</div>


Expand Down
Binary file modified __pycache__/hooks.cpython-310.pyc
Binary file not shown.
2 changes: 1 addition & 1 deletion comparison-table/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -8796,7 +8796,7 @@ <h1 id="comparison-table">Comparison table</h1>
<div class="md-copyright">

<div class="md-copyright__highlight">
Copyright © Tom Payne 2018-2024
Copyright © Tom Payne 2018-2025
</div>


Expand Down
6 changes: 3 additions & 3 deletions developer-guide/architecture/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -8705,7 +8705,7 @@ <h1 id="architecture">Architecture</h1>
interested in contributing to chezmoi.</p>
<p>You can generate Go documentation for chezmoi's source code with <code>go doc</code>, for
example:</p>
<div class="highlight"><pre><span></span><code><span class="gp">$ </span>go<span class="w"> </span>doc<span class="w"> </span>-all<span class="w"> </span>-u<span class="w"> </span>github.com/twpayne/chezmoi/v2/internal/chezmoi
<div class="highlight"><pre><span></span><code>go<span class="w"> </span>doc<span class="w"> </span>-all<span class="w"> </span>-u<span class="w"> </span>github.com/twpayne/chezmoi/v2/internal/chezmoi
</code></pre></div>
<p>You can also <a href="https://pkg.go.dev/github.com/twpayne/chezmoi/v2">browse chezmoi's generated documentation
online</a>.</p>
Expand Down Expand Up @@ -8855,7 +8855,7 @@ <h2 id="testing">Testing</h2>
with the test scripts themselves in
<code>internal/cmd/testdata/scripts/$TEST_NAME.txtar</code>.</p>
<p>You can run individual end-to-end tests with</p>
<div class="highlight"><pre><span></span><code><span class="gp">$ </span>go<span class="w"> </span><span class="nb">test</span><span class="w"> </span>./internal/cmd<span class="w"> </span>-run<span class="o">=</span>TestScript/<span class="nv">$TEST_NAME</span>
<div class="highlight"><pre><span></span><code>go<span class="w"> </span><span class="nb">test</span><span class="w"> </span>./internal/cmd<span class="w"> </span>-run<span class="o">=</span>TestScript/<span class="nv">$TEST_NAME</span>
</code></pre></div>
<p>Tests should, if at all possible, run unmodified on all operating systems
tested in CI (Linux, macOS, Windows, and FreeBSD). Windows will sometimes need
Expand Down Expand Up @@ -8896,7 +8896,7 @@ <h2 id="testing">Testing</h2>
<div class="md-copyright">

<div class="md-copyright__highlight">
Copyright © Tom Payne 2018-2024
Copyright © Tom Payne 2018-2025
</div>


Expand Down
2 changes: 1 addition & 1 deletion developer-guide/building-on-top-of-chezmoi/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -8541,7 +8541,7 @@ <h1 id="building-on-top-of-chezmoi">Building on top of chezmoi</h1>
<div class="md-copyright">

<div class="md-copyright__highlight">
Copyright © Tom Payne 2018-2024
Copyright © Tom Payne 2018-2025
</div>


Expand Down
2 changes: 1 addition & 1 deletion developer-guide/contributing-changes/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -8588,7 +8588,7 @@ <h1 id="contributing-changes">Contributing changes</h1>
<div class="md-copyright">

<div class="md-copyright__highlight">
Copyright © Tom Payne 2018-2024
Copyright © Tom Payne 2018-2025
</div>


Expand Down
22 changes: 11 additions & 11 deletions developer-guide/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -8503,28 +8503,28 @@ <h1 id="developer-guide">Developer guide</h1>
<a href="https://github.com">GitHub</a>. chezmoi is a standard Go project, using standard
Go tooling. chezmoi requires Go 1.23 or later.</p>
<p>Checkout chezmoi:</p>
<div class="highlight"><pre><span></span><code><span class="gp">$ </span>git<span class="w"> </span>clone<span class="w"> </span>https://github.com/twpayne/chezmoi.git
<span class="gp">$ </span><span class="nb">cd</span><span class="w"> </span>chezmoi
<div class="highlight"><pre><span></span><code>git<span class="w"> </span>clone<span class="w"> </span>https://github.com/twpayne/chezmoi.git
<span class="nb">cd</span><span class="w"> </span>chezmoi
</code></pre></div>
<p>Build chezmoi:</p>
<div class="highlight"><pre><span></span><code><span class="gp">$ </span>go<span class="w"> </span>build
<div class="highlight"><pre><span></span><code>go<span class="w"> </span>build
</code></pre></div>
<p>Run all tests:</p>
<div class="highlight"><pre><span></span><code><span class="gp">$ </span>go<span class="w"> </span><span class="nb">test</span><span class="w"> </span>./...
<div class="highlight"><pre><span></span><code>go<span class="w"> </span><span class="nb">test</span><span class="w"> </span>./...
</code></pre></div>
<p>chezmoi's tests include integration tests with other software. If the other
software is not found in <code>$PATH</code> the tests will be skipped. Running the full set
of tests requires <code>age</code>, <code>base64</code>, <code>bash</code>, <code>bzip2</code>, <code>git</code>, <code>gpg</code>, <code>gzip</code>,
<code>perl</code>, <code>python3</code>, <code>rage</code>, <code>ruby</code>, <code>sed</code>, <code>sha256sum</code>, <code>tr</code>, <code>true</code>, <code>unzip</code>,
<code>xz</code>, <code>zip</code>, and <code>zstd</code>.</p>
<p>Run chezmoi:</p>
<div class="highlight"><pre><span></span><code><span class="gp">$ </span>go<span class="w"> </span>run<span class="w"> </span>.
<div class="highlight"><pre><span></span><code>go<span class="w"> </span>run<span class="w"> </span>.
</code></pre></div>
<p>Run a set of smoke tests, including cross-compilation, tests, and linting:</p>
<div class="highlight"><pre><span></span><code><span class="gp">$ </span>make<span class="w"> </span>smoke-test
<div class="highlight"><pre><span></span><code>make<span class="w"> </span>smoke-test
</code></pre></div>
<p>Test building chezmoi for all architectures:</p>
<div class="highlight"><pre><span></span><code><span class="gp">$ </span>make<span class="w"> </span>test-release
<div class="highlight"><pre><span></span><code>make<span class="w"> </span>test-release
</code></pre></div>
<div class="admonition hint">
<p class="admonition-title">Hint</p>
Expand All @@ -8536,9 +8536,9 @@ <h1 id="developer-guide">Developer guide</h1>
warning-path: Please set $HOME to a directory where you have write access.
</code></pre></div>
<p>These can be avoided with by running tests with <code>SHELL=bash</code> or <code>SHELL=zsh</code>:</p>
<div class="highlight"><pre><span></span><code><span class="gp">$ </span><span class="nv">SHELL</span><span class="o">=</span>bash<span class="w"> </span>make<span class="w"> </span><span class="nb">test</span>
<span class="gp">$ </span><span class="nv">SHELL</span><span class="o">=</span>zsh<span class="w"> </span>make<span class="w"> </span>smoke-test
<span class="gp">$ </span><span class="nv">SHELL</span><span class="o">=</span>bash<span class="w"> </span>go<span class="w"> </span><span class="nb">test</span><span class="w"> </span>./...
<div class="highlight"><pre><span></span><code><span class="nv">SHELL</span><span class="o">=</span>bash<span class="w"> </span>make<span class="w"> </span><span class="nb">test</span>
<span class="nv">SHELL</span><span class="o">=</span>zsh<span class="w"> </span>make<span class="w"> </span>smoke-test
<span class="nv">SHELL</span><span class="o">=</span>bash<span class="w"> </span>go<span class="w"> </span><span class="nb">test</span><span class="w"> </span>./...
</code></pre></div>
</div>

Expand Down Expand Up @@ -8576,7 +8576,7 @@ <h1 id="developer-guide">Developer guide</h1>
<div class="md-copyright">

<div class="md-copyright__highlight">
Copyright © Tom Payne 2018-2024
Copyright © Tom Payne 2018-2025
</div>


Expand Down
4 changes: 2 additions & 2 deletions developer-guide/install-script/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -8504,7 +8504,7 @@ <h1 id="install-script">Install script</h1>
<p>chezmoi generates the <a href="https://github.com/twpayne/chezmoi/blob/master/assets/scripts/install.sh">install
script</a>
from a single source of truth. You must run</p>
<div class="highlight"><pre><span></span><code><span class="gp">$ </span>go<span class="w"> </span>generate
<div class="highlight"><pre><span></span><code>go<span class="w"> </span>generate
</code></pre></div>
<p>if your change includes any of the following:</p>
<ul>
Expand Down Expand Up @@ -8553,7 +8553,7 @@ <h1 id="install-script">Install script</h1>
<div class="md-copyright">

<div class="md-copyright__highlight">
Copyright © Tom Payne 2018-2024
Copyright © Tom Payne 2018-2025
</div>


Expand Down
2 changes: 1 addition & 1 deletion developer-guide/packaging/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -8592,7 +8592,7 @@ <h1 id="packaging">Packaging</h1>
<div class="md-copyright">

<div class="md-copyright__highlight">
Copyright © Tom Payne 2018-2024
Copyright © Tom Payne 2018-2025
</div>


Expand Down
14 changes: 7 additions & 7 deletions developer-guide/releases/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -8597,15 +8597,15 @@ <h1 id="releases">Releases</h1>
<h2 id="testing">Testing</h2>
<p>To build a test release, without publishing, (Ubuntu Linux only) first ensure
that the <code>musl-tools</code> and <code>snapcraft</code> packages are installed:</p>
<div class="highlight"><pre><span></span><code><span class="gp">$ </span>sudo<span class="w"> </span>apt-get<span class="w"> </span>install<span class="w"> </span>musl-tools<span class="w"> </span>snapcraft
<div class="highlight"><pre><span></span><code>sudo<span class="w"> </span>apt-get<span class="w"> </span>install<span class="w"> </span>musl-tools<span class="w"> </span>snapcraft
</code></pre></div>
<p>Then run:</p>
<div class="highlight"><pre><span></span><code><span class="gp">$ </span>make<span class="w"> </span>test-release
<div class="highlight"><pre><span></span><code>make<span class="w"> </span>test-release
</code></pre></div>
<h2 id="publishing">Publishing</h2>
<p>Publish a new release by creating and pushing a tag, for example:</p>
<div class="highlight"><pre><span></span><code><span class="gp">$ </span>git<span class="w"> </span>tag<span class="w"> </span>v1.2.3
<span class="gp">$ </span>git<span class="w"> </span>push<span class="w"> </span>--tags
<div class="highlight"><pre><span></span><code>git<span class="w"> </span>tag<span class="w"> </span>v1.2.3
git<span class="w"> </span>push<span class="w"> </span>--tags
</code></pre></div>
<p>This triggers a <a href="https://github.com/twpayne/chezmoi/actions">GitHub Action</a>
that builds and publishes archives, packages, and snaps, creates a new <a href="https://github.com/twpayne/chezmoi/releases">GitHub
Expand All @@ -8618,7 +8618,7 @@ <h2 id="publishing">Publishing</h2>
secret</a>.</p>
<p>Snapcraft store credentials periodically expire. Create new snapcraft store
credentials by running:</p>
<div class="highlight"><pre><span></span><code><span class="gp">$ </span>snapcraft<span class="w"> </span>export-login<span class="w"> </span>--snaps<span class="o">=</span>chezmoi<span class="w"> </span>--channels<span class="o">=</span>stable,candidate,beta,edge<span class="w"> </span>--acls<span class="o">=</span>package_upload<span class="w"> </span>-
<div class="highlight"><pre><span></span><code>snapcraft<span class="w"> </span>export-login<span class="w"> </span>--snaps<span class="o">=</span>chezmoi<span class="w"> </span>--channels<span class="o">=</span>stable,candidate,beta,edge<span class="w"> </span>--acls<span class="o">=</span>package_upload<span class="w"> </span>-
</code></pre></div>
</div>
<div class="admonition note">
Expand All @@ -8628,7 +8628,7 @@ <h2 id="publishing">Publishing</h2>
<a href="https://github.com/Homebrew/homebrew-core">github.com/Homebrew/homebrew-core</a>
to bump the version.</p>
<p>If needed, the pull request can be created with:</p>
<div class="highlight"><pre><span></span><code><span class="gp">$ </span>brew<span class="w"> </span>bump-formula-pr<span class="w"> </span>--tag<span class="o">=</span>v1.2.3<span class="w"> </span>chezmoi
<div class="highlight"><pre><span></span><code>brew<span class="w"> </span>bump-formula-pr<span class="w"> </span>--tag<span class="o">=</span>v1.2.3<span class="w"> </span>chezmoi
</code></pre></div>
</div>
<div class="admonition note">
Expand Down Expand Up @@ -8705,7 +8705,7 @@ <h2 id="signing">Signing</h2>
<div class="md-copyright">

<div class="md-copyright__highlight">
Copyright © Tom Payne 2018-2024
Copyright © Tom Payne 2018-2025
</div>


Expand Down
2 changes: 1 addition & 1 deletion developer-guide/security/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -8642,7 +8642,7 @@ <h2 id="reporting-a-vulnerability">Reporting a vulnerability</h2>
<div class="md-copyright">

<div class="md-copyright__highlight">
Copyright © Tom Payne 2018-2024
Copyright © Tom Payne 2018-2025
</div>


Expand Down
2 changes: 1 addition & 1 deletion developer-guide/testing/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -8564,7 +8564,7 @@ <h1 id="testing">Testing</h1>
<div class="md-copyright">

<div class="md-copyright__highlight">
Copyright © Tom Payne 2018-2024
Copyright © Tom Payne 2018-2025
</div>


Expand Down
2 changes: 1 addition & 1 deletion developer-guide/using-make/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -8584,7 +8584,7 @@ <h1 id="building-and-installing-with-make">Building and installing with <code>ma
<div class="md-copyright">

<div class="md-copyright__highlight">
Copyright © Tom Payne 2018-2024
Copyright © Tom Payne 2018-2025
</div>


Expand Down
10 changes: 5 additions & 5 deletions developer-guide/website/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -8568,20 +8568,20 @@ <h1 id="website">Website</h1>
<code>uv</code>:</p>
<div class="admonition note">
<p>If Python 3.10 (or later) is not currently installed, install it with <code>uv</code>:</p>
<div class="highlight"><pre><span></span><code><span class="gp">$ </span>uv<span class="w"> </span>python<span class="w"> </span>install<span class="w"> </span><span class="m">3</span>.10
<div class="highlight"><pre><span></span><code>uv<span class="w"> </span>python<span class="w"> </span>install<span class="w"> </span><span class="m">3</span>.10
</code></pre></div>
</div>
<p>Install the dependencies (the <code>--frozen</code> is optional but recommended):</p>
<div class="highlight"><pre><span></span><code><span class="gp">$ </span>uv<span class="w"> </span>sync<span class="w"> </span>--frozen
<div class="highlight"><pre><span></span><code>uv<span class="w"> </span>sync<span class="w"> </span>--frozen
</code></pre></div>
<p>Test the website locally by running:</p>
<div class="highlight"><pre><span></span><code><span class="gp">$ </span>uv<span class="w"> </span>run<span class="w"> </span>task<span class="w"> </span>serve-docs
<div class="highlight"><pre><span></span><code>uv<span class="w"> </span>run<span class="w"> </span>task<span class="w"> </span>serve-docs
</code></pre></div>
<p>and visiting <a href="http://127.0.0.1:8000/">http://127.0.0.1:8000/</a>.</p>
<h2 id="maintainers">Maintainers</h2>
<p>The website is automatically deployed when new releases are created, but manual
deployments can be triggered by maintainers with appropriate access using:</p>
<div class="highlight"><pre><span></span><code><span class="gp">$ </span>uv<span class="w"> </span>run<span class="w"> </span>task<span class="w"> </span>mkdocs<span class="w"> </span>gh-deploy
<div class="highlight"><pre><span></span><code>uv<span class="w"> </span>run<span class="w"> </span>task<span class="w"> </span>mkdocs<span class="w"> </span>gh-deploy
</code></pre></div>


Expand Down Expand Up @@ -8618,7 +8618,7 @@ <h2 id="maintainers">Maintainers</h2>
<div class="md-copyright">

<div class="md-copyright__highlight">
Copyright © Tom Payne 2018-2024
Copyright © Tom Payne 2018-2025
</div>


Expand Down
2 changes: 1 addition & 1 deletion get
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ ${this}: download chezmoi and optionally run chezmoi
Usage: ${this} [-b bindir] [-d] [-t tag] [chezmoi-args]
-b sets the installation directory, default is ${BINDIR}.
-d enables debug logging.
-t sets the tag, default is ${TAG}.
-t sets the tag, default is ${TAGARG}.
If chezmoi-args are given, after install chezmoi is executed with chezmoi-args.
EOF
exit 2
Expand Down
2 changes: 1 addition & 1 deletion getlb
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ ${this}: download chezmoi and optionally run chezmoi
Usage: ${this} [-b bindir] [-d] [-t tag] [chezmoi-args]
-b sets the installation directory, default is ${BINDIR}.
-d enables debug logging.
-t sets the tag, default is ${TAG}.
-t sets the tag, default is ${TAGARG}.
If chezmoi-args are given, after install chezmoi is executed with chezmoi-args.
EOF
exit 2
Expand Down
8 changes: 4 additions & 4 deletions index.html
Original file line number Diff line number Diff line change
Expand Up @@ -8543,7 +8543,7 @@

<h1 id="chezmoi">chezmoi</h1>
<p>Manage your dotfiles across multiple diverse machines, securely.</p>
<p>The latest version of chezmoi is 2.57.0 (<a href="https://github.com/twpayne/chezmoi/releases/tag/v2.57.0">release notes</a>, <a href="reference/release-history/">release history</a>).</p>
<p>The latest version of chezmoi is 2.58.0 (<a href="https://github.com/twpayne/chezmoi/releases/tag/v2.58.0">release notes</a>, <a href="reference/release-history/">release history</a>).</p>
<h2 id="what-does-chezmoi-do">What does chezmoi do?</h2>
<p>chezmoi helps you manage your personal configuration files (dotfiles, like
<code>~/.gitconfig</code>) across multiple machines.</p>
Expand All @@ -8559,12 +8559,12 @@ <h2 id="what-does-chezmoi-do">What does chezmoi do?</h2>
<p>With chezmoi, pronounced /ʃeɪ mwa/ (shay-mwa), you can install chezmoi and your
dotfiles from your GitHub dotfiles repo on a new, empty machine with a single
command:</p>
<div class="highlight"><pre><span></span><code><span class="gp">$ </span>sh<span class="w"> </span>-c<span class="w"> </span><span class="s2">&quot;</span><span class="k">$(</span>curl<span class="w"> </span>-fsLS<span class="w"> </span>get.chezmoi.io<span class="k">)</span><span class="s2">&quot;</span><span class="w"> </span>--<span class="w"> </span>init<span class="w"> </span>--apply<span class="w"> </span><span class="nv">$GITHUB_USERNAME</span>
<div class="highlight"><pre><span></span><code>sh<span class="w"> </span>-c<span class="w"> </span><span class="s2">&quot;</span><span class="k">$(</span>curl<span class="w"> </span>-fsLS<span class="w"> </span>get.chezmoi.io<span class="k">)</span><span class="s2">&quot;</span><span class="w"> </span>--<span class="w"> </span>init<span class="w"> </span>--apply<span class="w"> </span><span class="nv">$GITHUB_USERNAME</span>
</code></pre></div>
<p>As well as the <code>curl | sh</code> installation, you can <a href="install/">install chezmoi with your
favorite package manager</a>.</p>
<p>Updating your dotfiles on any machine is a single command:</p>
<div class="highlight"><pre><span></span><code><span class="gp">$ </span>chezmoi<span class="w"> </span>update
<div class="highlight"><pre><span></span><code>chezmoi<span class="w"> </span>update
</code></pre></div>
<p>chezmoi runs on all popular operating systems, is distributed as a single
statically-linked binary with no dependencies, and does not require root access.</p>
Expand Down Expand Up @@ -8633,7 +8633,7 @@ <h2 id="i-like-chezmoi-how-do-i-say-thanks">I like chezmoi. How do I say thanks?
<div class="md-copyright">

<div class="md-copyright__highlight">
Copyright © Tom Payne 2018-2024
Copyright © Tom Payne 2018-2025
</div>


Expand Down
Loading

0 comments on commit ad6bd69

Please sign in to comment.