ok/jj
1
0
Fork 0
forked from mirrors/jj
Code Pull requests Activity

Deployed b3c4795 to prerelease with MkDocs 1.5.3 and mike 2.0.0

Browse source
This commit is contained in:
jj-docs[bot] 2024-02-03 07:30:42 +00:00
parent 3e095a8ecc
commit e53c6adebb
4 changed files with 264 additions and 107 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

267
prerelease/cli-reference/index.html
View file

@ -1077,6 +1077,30 @@
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#jj-config-path" class="md-nav__link">
<span class="md-ellipsis">
jj config path
</span>
</a>
<nav class="md-nav" aria-label="jj config path">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#options_15" class="md-nav__link">
<span class="md-ellipsis">
Options:
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
@ -1099,7 +1123,7 @@
</li>
<li class="md-nav__item">
<a href="#options_15" class="md-nav__link">
<a href="#options_16" class="md-nav__link">
<span class="md-ellipsis">
Options:
</span>
@ -1132,7 +1156,7 @@
</li>
<li class="md-nav__item">
<a href="#options_16" class="md-nav__link">
<a href="#options_17" class="md-nav__link">
<span class="md-ellipsis">
Options:
</span>
@ -1156,7 +1180,7 @@
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#options_17" class="md-nav__link">
<a href="#options_18" class="md-nav__link">
<span class="md-ellipsis">
Options:
</span>
@ -1189,7 +1213,7 @@
</li>
<li class="md-nav__item">
<a href="#options_18" class="md-nav__link">
<a href="#options_19" class="md-nav__link">
<span class="md-ellipsis">
Options:
</span>
@ -1222,7 +1246,7 @@
</li>
<li class="md-nav__item">
<a href="#options_19" class="md-nav__link">
<a href="#options_20" class="md-nav__link">
<span class="md-ellipsis">
Options:
</span>
@ -1255,7 +1279,7 @@
</li>
<li class="md-nav__item">
<a href="#options_20" class="md-nav__link">
<a href="#options_21" class="md-nav__link">
<span class="md-ellipsis">
Options:
</span>
@ -1408,7 +1432,7 @@
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#options_21" class="md-nav__link">
<a href="#options_22" class="md-nav__link">
<span class="md-ellipsis">
Options:
</span>
@ -1441,7 +1465,7 @@
</li>
<li class="md-nav__item">
<a href="#options_22" class="md-nav__link">
<a href="#options_23" class="md-nav__link">
<span class="md-ellipsis">
Options:
</span>
@ -1465,7 +1489,7 @@
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#options_23" class="md-nav__link">
<a href="#options_24" class="md-nav__link">
<span class="md-ellipsis">
Options:
</span>
@ -1516,7 +1540,7 @@
</li>
<li class="md-nav__item">
<a href="#options_24" class="md-nav__link">
<a href="#options_25" class="md-nav__link">
<span class="md-ellipsis">
Options:
</span>
@ -1549,7 +1573,7 @@
</li>
<li class="md-nav__item">
<a href="#options_25" class="md-nav__link">
<a href="#options_26" class="md-nav__link">
<span class="md-ellipsis">
Options:
</span>
@ -1582,7 +1606,7 @@
</li>
<li class="md-nav__item">
<a href="#options_26" class="md-nav__link">
<a href="#options_27" class="md-nav__link">
<span class="md-ellipsis">
Options:
</span>
@ -1615,7 +1639,7 @@
</li>
<li class="md-nav__item">
<a href="#options_27" class="md-nav__link">
<a href="#options_28" class="md-nav__link">
<span class="md-ellipsis">
Options:
</span>
@ -1648,7 +1672,7 @@
</li>
<li class="md-nav__item">
<a href="#options_28" class="md-nav__link">
<a href="#options_29" class="md-nav__link">
<span class="md-ellipsis">
Options:
</span>
@ -1681,7 +1705,7 @@
</li>
<li class="md-nav__item">
<a href="#options_29" class="md-nav__link">
<a href="#options_30" class="md-nav__link">
<span class="md-ellipsis">
Options:
</span>
@ -1714,7 +1738,7 @@
</li>
<li class="md-nav__item">
<a href="#options_30" class="md-nav__link">
<a href="#options_31" class="md-nav__link">
<span class="md-ellipsis">
Options:
</span>
@ -1738,7 +1762,7 @@
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#options_31" class="md-nav__link">
<a href="#options_32" class="md-nav__link">
<span class="md-ellipsis">
Options:
</span>
@ -1810,7 +1834,7 @@
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#options_32" class="md-nav__link">
<a href="#options_33" class="md-nav__link">
<span class="md-ellipsis">
Options:
</span>
@ -1843,7 +1867,7 @@
</li>
<li class="md-nav__item">
<a href="#options_33" class="md-nav__link">
<a href="#options_34" class="md-nav__link">
<span class="md-ellipsis">
Options:
</span>
@ -1876,7 +1900,7 @@
</li>
<li class="md-nav__item">
<a href="#options_34" class="md-nav__link">
<a href="#options_35" class="md-nav__link">
<span class="md-ellipsis">
Options:
</span>
@ -1909,7 +1933,7 @@
</li>
<li class="md-nav__item">
<a href="#options_35" class="md-nav__link">
<a href="#options_36" class="md-nav__link">
<span class="md-ellipsis">
Options:
</span>
@ -1933,7 +1957,7 @@
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#options_36" class="md-nav__link">
<a href="#options_37" class="md-nav__link">
<span class="md-ellipsis">
Options:
</span>
@ -1966,7 +1990,7 @@
</li>
<li class="md-nav__item">
<a href="#options_37" class="md-nav__link">
<a href="#options_38" class="md-nav__link">
<span class="md-ellipsis">
Options:
</span>
@ -1999,7 +2023,7 @@
</li>
<li class="md-nav__item">
<a href="#options_38" class="md-nav__link">
<a href="#options_39" class="md-nav__link">
<span class="md-ellipsis">
Options:
</span>
@ -2041,7 +2065,7 @@
</li>
<li class="md-nav__item">
<a href="#options_39" class="md-nav__link">
<a href="#options_40" class="md-nav__link">
<span class="md-ellipsis">
Options:
</span>
@ -2098,7 +2122,7 @@
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#options_40" class="md-nav__link">
<a href="#options_41" class="md-nav__link">
<span class="md-ellipsis">
Options:
</span>
@ -2131,7 +2155,7 @@
</li>
<li class="md-nav__item">
<a href="#options_41" class="md-nav__link">
<a href="#options_42" class="md-nav__link">
<span class="md-ellipsis">
Options:
</span>
@ -2164,7 +2188,7 @@
</li>
<li class="md-nav__item">
<a href="#options_42" class="md-nav__link">
<a href="#options_43" class="md-nav__link">
<span class="md-ellipsis">
Options:
</span>
@ -2269,7 +2293,7 @@
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#options_43" class="md-nav__link">
<a href="#options_44" class="md-nav__link">
<span class="md-ellipsis">
Options:
</span>
@ -2293,7 +2317,7 @@
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#options_44" class="md-nav__link">
<a href="#options_45" class="md-nav__link">
<span class="md-ellipsis">
Options:
</span>
@ -2353,7 +2377,7 @@
</li>
<li class="md-nav__item">
<a href="#options_45" class="md-nav__link">
<a href="#options_46" class="md-nav__link">
<span class="md-ellipsis">
Options:
</span>
@ -2377,7 +2401,7 @@
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#options_46" class="md-nav__link">
<a href="#options_47" class="md-nav__link">
<span class="md-ellipsis">
Options:
</span>
@ -2467,7 +2491,7 @@
</li>
<li class="md-nav__item">
<a href="#options_47" class="md-nav__link">
<a href="#options_48" class="md-nav__link">
<span class="md-ellipsis">
Options:
</span>
@ -3910,6 +3934,30 @@
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#jj-config-path" class="md-nav__link">
<span class="md-ellipsis">
jj config path
</span>
</a>
<nav class="md-nav" aria-label="jj config path">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#options_15" class="md-nav__link">
<span class="md-ellipsis">
Options:
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
@ -3932,7 +3980,7 @@
</li>
<li class="md-nav__item">
<a href="#options_15" class="md-nav__link">
<a href="#options_16" class="md-nav__link">
<span class="md-ellipsis">
Options:
</span>
@ -3965,7 +4013,7 @@
</li>
<li class="md-nav__item">
<a href="#options_16" class="md-nav__link">
<a href="#options_17" class="md-nav__link">
<span class="md-ellipsis">
Options:
</span>
@ -3989,7 +4037,7 @@
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#options_17" class="md-nav__link">
<a href="#options_18" class="md-nav__link">
<span class="md-ellipsis">
Options:
</span>
@ -4022,7 +4070,7 @@
</li>
<li class="md-nav__item">
<a href="#options_18" class="md-nav__link">
<a href="#options_19" class="md-nav__link">
<span class="md-ellipsis">
Options:
</span>
@ -4055,7 +4103,7 @@
</li>
<li class="md-nav__item">
<a href="#options_19" class="md-nav__link">
<a href="#options_20" class="md-nav__link">
<span class="md-ellipsis">
Options:
</span>
@ -4088,7 +4136,7 @@
</li>
<li class="md-nav__item">
<a href="#options_20" class="md-nav__link">
<a href="#options_21" class="md-nav__link">
<span class="md-ellipsis">
Options:
</span>
@ -4241,7 +4289,7 @@
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#options_21" class="md-nav__link">
<a href="#options_22" class="md-nav__link">
<span class="md-ellipsis">
Options:
</span>
@ -4274,7 +4322,7 @@
</li>
<li class="md-nav__item">
<a href="#options_22" class="md-nav__link">
<a href="#options_23" class="md-nav__link">
<span class="md-ellipsis">
Options:
</span>
@ -4298,7 +4346,7 @@
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#options_23" class="md-nav__link">
<a href="#options_24" class="md-nav__link">
<span class="md-ellipsis">
Options:
</span>
@ -4349,7 +4397,7 @@
</li>
<li class="md-nav__item">
<a href="#options_24" class="md-nav__link">
<a href="#options_25" class="md-nav__link">
<span class="md-ellipsis">
Options:
</span>
@ -4382,7 +4430,7 @@
</li>
<li class="md-nav__item">
<a href="#options_25" class="md-nav__link">
<a href="#options_26" class="md-nav__link">
<span class="md-ellipsis">
Options:
</span>
@ -4415,7 +4463,7 @@
</li>
<li class="md-nav__item">
<a href="#options_26" class="md-nav__link">
<a href="#options_27" class="md-nav__link">
<span class="md-ellipsis">
Options:
</span>
@ -4448,7 +4496,7 @@
</li>
<li class="md-nav__item">
<a href="#options_27" class="md-nav__link">
<a href="#options_28" class="md-nav__link">
<span class="md-ellipsis">
Options:
</span>
@ -4481,7 +4529,7 @@
</li>
<li class="md-nav__item">
<a href="#options_28" class="md-nav__link">
<a href="#options_29" class="md-nav__link">
<span class="md-ellipsis">
Options:
</span>
@ -4514,7 +4562,7 @@
</li>
<li class="md-nav__item">
<a href="#options_29" class="md-nav__link">
<a href="#options_30" class="md-nav__link">
<span class="md-ellipsis">
Options:
</span>
@ -4547,7 +4595,7 @@
</li>
<li class="md-nav__item">
<a href="#options_30" class="md-nav__link">
<a href="#options_31" class="md-nav__link">
<span class="md-ellipsis">
Options:
</span>
@ -4571,7 +4619,7 @@
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#options_31" class="md-nav__link">
<a href="#options_32" class="md-nav__link">
<span class="md-ellipsis">
Options:
</span>
@ -4643,7 +4691,7 @@
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#options_32" class="md-nav__link">
<a href="#options_33" class="md-nav__link">
<span class="md-ellipsis">
Options:
</span>
@ -4676,7 +4724,7 @@
</li>
<li class="md-nav__item">
<a href="#options_33" class="md-nav__link">
<a href="#options_34" class="md-nav__link">
<span class="md-ellipsis">
Options:
</span>
@ -4709,7 +4757,7 @@
</li>
<li class="md-nav__item">
<a href="#options_34" class="md-nav__link">
<a href="#options_35" class="md-nav__link">
<span class="md-ellipsis">
Options:
</span>
@ -4742,7 +4790,7 @@
</li>
<li class="md-nav__item">
<a href="#options_35" class="md-nav__link">
<a href="#options_36" class="md-nav__link">
<span class="md-ellipsis">
Options:
</span>
@ -4766,7 +4814,7 @@
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#options_36" class="md-nav__link">
<a href="#options_37" class="md-nav__link">
<span class="md-ellipsis">
Options:
</span>
@ -4799,7 +4847,7 @@
</li>
<li class="md-nav__item">
<a href="#options_37" class="md-nav__link">
<a href="#options_38" class="md-nav__link">
<span class="md-ellipsis">
Options:
</span>
@ -4832,7 +4880,7 @@
</li>
<li class="md-nav__item">
<a href="#options_38" class="md-nav__link">
<a href="#options_39" class="md-nav__link">
<span class="md-ellipsis">
Options:
</span>
@ -4874,7 +4922,7 @@
</li>
<li class="md-nav__item">
<a href="#options_39" class="md-nav__link">
<a href="#options_40" class="md-nav__link">
<span class="md-ellipsis">
Options:
</span>
@ -4931,7 +4979,7 @@
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#options_40" class="md-nav__link">
<a href="#options_41" class="md-nav__link">
<span class="md-ellipsis">
Options:
</span>
@ -4964,7 +5012,7 @@
</li>
<li class="md-nav__item">
<a href="#options_41" class="md-nav__link">
<a href="#options_42" class="md-nav__link">
<span class="md-ellipsis">
Options:
</span>
@ -4997,7 +5045,7 @@
</li>
<li class="md-nav__item">
<a href="#options_42" class="md-nav__link">
<a href="#options_43" class="md-nav__link">
<span class="md-ellipsis">
Options:
</span>
@ -5102,7 +5150,7 @@
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#options_43" class="md-nav__link">
<a href="#options_44" class="md-nav__link">
<span class="md-ellipsis">
Options:
</span>
@ -5126,7 +5174,7 @@
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#options_44" class="md-nav__link">
<a href="#options_45" class="md-nav__link">
<span class="md-ellipsis">
Options:
</span>
@ -5186,7 +5234,7 @@
</li>
<li class="md-nav__item">
<a href="#options_45" class="md-nav__link">
<a href="#options_46" class="md-nav__link">
<span class="md-ellipsis">
Options:
</span>
@ -5210,7 +5258,7 @@
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#options_46" class="md-nav__link">
<a href="#options_47" class="md-nav__link">
<span class="md-ellipsis">
Options:
</span>
@ -5300,7 +5348,7 @@
</li>
<li class="md-nav__item">
<a href="#options_47" class="md-nav__link">
<a href="#options_48" class="md-nav__link">
<span class="md-ellipsis">
Options:
</span>
@ -5404,6 +5452,7 @@
<li><a href="#jj-config-get"><code>jj config get</code>↴</a></li>
<li><a href="#jj-config-set"><code>jj config set</code>↴</a></li>
<li><a href="#jj-config-edit"><code>jj config edit</code>↴</a></li>
<li><a href="#jj-config-path"><code>jj config path</code>↴</a></li>
<li><a href="#jj-describe"><code>jj describe</code>↴</a></li>
<li><a href="#jj-diff"><code>jj diff</code>↴</a></li>
<li><a href="#jj-diffedit"><code>jj diffedit</code>↴</a></li>
@ -5771,6 +5820,7 @@ repository.</li>
<li><code>get</code> — Get the value of a given config option.</li>
<li><code>set</code> — Update config file to set the given option to a given value</li>
<li><code>edit</code> — Start an editor on a jj config file</li>
<li><code>path</code> — Print the path to the config file</li>
</ul>
<h2 id="jj-config-list"><code>jj config list</code><a class="headerlink" href="#jj-config-list" title="Permanent link">&para;</a></h2>
<p>List variables set in config file, along with their values</p>
@ -5831,7 +5881,8 @@ Martin von Zweigbergk</p>
</li>
</ul>
<h2 id="jj-config-edit"><code>jj config edit</code><a class="headerlink" href="#jj-config-edit" title="Permanent link">&para;</a></h2>
<p>Start an editor on a jj config file</p>
<p>Start an editor on a jj config file.</p>
<p>Creates the file if it doesn't already exist regardless of what the editor does.</p>
<p><strong>Usage:</strong> <code>jj config edit &lt;--user|--repo&gt;</code></p>
<h6 id="options_14"><strong>Options:</strong><a class="headerlink" href="#options_14" title="Permanent link">&para;</a></h6>
<ul>
@ -5844,6 +5895,22 @@ Martin von Zweigbergk</p>
<p>Possible values: <code>true</code>, <code>false</code></p>
</li>
</ul>
<h2 id="jj-config-path"><code>jj config path</code><a class="headerlink" href="#jj-config-path" title="Permanent link">&para;</a></h2>
<p>Print the path to the config file</p>
<p>A config file at that path may or may not exist.</p>
<p>See <code>jj config edit</code> if you'd like to immediately edit the file.</p>
<p><strong>Usage:</strong> <code>jj config path &lt;--user|--repo&gt;</code></p>
<h6 id="options_15"><strong>Options:</strong><a class="headerlink" href="#options_15" title="Permanent link">&para;</a></h6>
<ul>
<li>
<p><code>--user</code> — Target the user-level config</p>
<p>Possible values: <code>true</code>, <code>false</code></p>
</li>
<li>
<p><code>--repo</code> — Target the repo-level config</p>
<p>Possible values: <code>true</code>, <code>false</code></p>
</li>
</ul>
<h2 id="jj-describe"><code>jj describe</code><a class="headerlink" href="#jj-describe" title="Permanent link">&para;</a></h2>
<p>Update the change description or other metadata</p>
<p>Starts an editor to let you edit the description of a change. The editor will be $EDITOR, or <code>pico</code> if that's not defined (<code>Notepad</code> on Windows).</p>
@ -5855,7 +5922,7 @@ Martin von Zweigbergk</p>
<p>Default value: <code>@</code></p>
</li>
</ul>
<h6 id="options_15"><strong>Options:</strong><a class="headerlink" href="#options_15" title="Permanent link">&para;</a></h6>
<h6 id="options_16"><strong>Options:</strong><a class="headerlink" href="#options_16" title="Permanent link">&para;</a></h6>
<ul>
<li>
<p><code>-r</code> — Ignored (but lets you pass <code>-r</code> for consistency with other commands)</p>
@ -5884,7 +5951,7 @@ Martin von Zweigbergk</p>
<ul>
<li><code>&lt;PATHS&gt;</code> — Restrict the diff to these paths</li>
</ul>
<h6 id="options_16"><strong>Options:</strong><a class="headerlink" href="#options_16" title="Permanent link">&para;</a></h6>
<h6 id="options_17"><strong>Options:</strong><a class="headerlink" href="#options_17" title="Permanent link">&para;</a></h6>
<ul>
<li><code>-r</code>, <code>--revision &lt;REVISION&gt;</code> — Show changes in this revision, compared to its parent(s)</li>
<li><code>--from &lt;FROM&gt;</code> — Show changes from this revision</li>
@ -5920,7 +5987,7 @@ Martin von Zweigbergk</p>
<p>Edit the right side of the diff until it looks the way you want. Once you close the editor, the revision specified with <code>-r</code> or <code>--to</code> will be updated. Descendants will be rebased on top as usual, which may result in conflicts.</p>
<p>See <code>jj restore</code> if you want to move entire files from one revision to another. See <code>jj squash -i</code> or <code>jj unsquash -i</code> if you instead want to move changes into or out of the parent revision.</p>
<p><strong>Usage:</strong> <code>jj diffedit [OPTIONS]</code></p>
<h6 id="options_17"><strong>Options:</strong><a class="headerlink" href="#options_17" title="Permanent link">&para;</a></h6>
<h6 id="options_18"><strong>Options:</strong><a class="headerlink" href="#options_18" title="Permanent link">&para;</a></h6>
<ul>
<li><code>-r</code>, <code>--revision &lt;REVISION&gt;</code> — The revision to touch up. Defaults to @ if neither --to nor --from are specified</li>
<li><code>--from &lt;FROM&gt;</code> — Show changes from this revision. Defaults to @ if --to is specified</li>
@ -5936,7 +6003,7 @@ Martin von Zweigbergk</p>
<p>Default value: <code>@</code></p>
</li>
</ul>
<h6 id="options_18"><strong>Options:</strong><a class="headerlink" href="#options_18" title="Permanent link">&para;</a></h6>
<h6 id="options_19"><strong>Options:</strong><a class="headerlink" href="#options_19" title="Permanent link">&para;</a></h6>
<ul>
<li>
<p><code>-r</code> — Ignored (but lets you pass <code>-r</code> for consistency with other commands)</p>
@ -5951,7 +6018,7 @@ Martin von Zweigbergk</p>
<ul>
<li><code>&lt;REVISION&gt;</code> — The commit to edit</li>
</ul>
<h6 id="options_19"><strong>Options:</strong><a class="headerlink" href="#options_19" title="Permanent link">&para;</a></h6>
<h6 id="options_20"><strong>Options:</strong><a class="headerlink" href="#options_20" title="Permanent link">&para;</a></h6>
<ul>
<li>
<p><code>-r</code> — Ignored (but lets you pass <code>-r</code> for consistency with other commands)</p>
@ -5965,7 +6032,7 @@ Martin von Zweigbergk</p>
<ul>
<li><code>&lt;PATHS&gt;</code> — Only list files matching these prefixes (instead of all files)</li>
</ul>
<h6 id="options_20"><strong>Options:</strong><a class="headerlink" href="#options_20" title="Permanent link">&para;</a></h6>
<h6 id="options_21"><strong>Options:</strong><a class="headerlink" href="#options_21" title="Permanent link">&para;</a></h6>
<ul>
<li>
<p><code>-r</code>, <code>--revision &lt;REVISION&gt;</code> — The revision to list files in</p>
@ -6025,7 +6092,7 @@ Martin von Zweigbergk</p>
<h2 id="jj-git-fetch"><code>jj git fetch</code><a class="headerlink" href="#jj-git-fetch" title="Permanent link">&para;</a></h2>
<p>Fetch from a Git remote</p>
<p><strong>Usage:</strong> <code>jj git fetch [OPTIONS]</code></p>
<h6 id="options_21"><strong>Options:</strong><a class="headerlink" href="#options_21" title="Permanent link">&para;</a></h6>
<h6 id="options_22"><strong>Options:</strong><a class="headerlink" href="#options_22" title="Permanent link">&para;</a></h6>
<ul>
<li>
<p><code>--branch &lt;BRANCH&gt;</code> — Fetch only some of the branches</p>
@ -6048,7 +6115,7 @@ Martin von Zweigbergk</p>
<li><code>&lt;SOURCE&gt;</code> — URL or path of the Git repo to clone</li>
<li><code>&lt;DESTINATION&gt;</code> — The directory to write the Jujutsu repo to</li>
</ul>
<h6 id="options_22"><strong>Options:</strong><a class="headerlink" href="#options_22" title="Permanent link">&para;</a></h6>
<h6 id="options_23"><strong>Options:</strong><a class="headerlink" href="#options_23" title="Permanent link">&para;</a></h6>
<ul>
<li>
<p><code>--colocate</code> — Whether or not to colocate the Jujutsu repo with the git repo</p>
@ -6059,7 +6126,7 @@ Martin von Zweigbergk</p>
<p>Push to a Git remote</p>
<p>By default, pushes any branches pointing to <code>remote_branches(remote=&lt;remote&gt;)..@</code>. Use <code>--branch</code> to push specific branches. Use <code>--all</code> to push all branches. Use <code>--change</code> to generate branch names based on the change IDs of specific commits.</p>
<p><strong>Usage:</strong> <code>jj git push [OPTIONS]</code></p>
<h6 id="options_23"><strong>Options:</strong><a class="headerlink" href="#options_23" title="Permanent link">&para;</a></h6>
<h6 id="options_24"><strong>Options:</strong><a class="headerlink" href="#options_24" title="Permanent link">&para;</a></h6>
<ul>
<li><code>--remote &lt;REMOTE&gt;</code> — The remote to push to (only named remotes are supported)</li>
<li><code>-b</code>, <code>--branch &lt;BRANCH&gt;</code> — Push only this branch (can be repeated)</li>
@ -6097,7 +6164,7 @@ Martin von Zweigbergk</p>
<p>Default value: <code>.</code></p>
</li>
</ul>
<h6 id="options_24"><strong>Options:</strong><a class="headerlink" href="#options_24" title="Permanent link">&para;</a></h6>
<h6 id="options_25"><strong>Options:</strong><a class="headerlink" href="#options_25" title="Permanent link">&para;</a></h6>
<ul>
<li>
<p><code>--git</code> — Use the Git backend, creating a jj repo backed by a Git repo</p>
@ -6115,7 +6182,7 @@ Martin von Zweigbergk</p>
<ul>
<li><code>&lt;PATHS&gt;</code> — Restrict the diff to these paths</li>
</ul>
<h6 id="options_25"><strong>Options:</strong><a class="headerlink" href="#options_25" title="Permanent link">&para;</a></h6>
<h6 id="options_26"><strong>Options:</strong><a class="headerlink" href="#options_26" title="Permanent link">&para;</a></h6>
<ul>
<li><code>--from &lt;FROM&gt;</code> — Show changes from this revision</li>
<li><code>--to &lt;TO&gt;</code> — Show changes to this revision</li>
@ -6150,7 +6217,7 @@ Martin von Zweigbergk</p>
<ul>
<li><code>&lt;PATHS&gt;</code> — Show commits modifying the given paths</li>
</ul>
<h6 id="options_26"><strong>Options:</strong><a class="headerlink" href="#options_26" title="Permanent link">&para;</a></h6>
<h6 id="options_27"><strong>Options:</strong><a class="headerlink" href="#options_27" title="Permanent link">&para;</a></h6>
<ul>
<li><code>-r</code>, <code>--revisions &lt;REVISIONS&gt;</code> — Which revisions to show. Defaults to the <code>revsets.log</code> setting, or <code>@ | ancestors(immutable_heads().., 2) | heads(immutable_heads())</code> if it is not set</li>
<li>
@ -6207,7 +6274,7 @@ Martin von Zweigbergk</p>
<p>Default value: <code>@</code></p>
</li>
</ul>
<h6 id="options_27"><strong>Options:</strong><a class="headerlink" href="#options_27" title="Permanent link">&para;</a></h6>
<h6 id="options_28"><strong>Options:</strong><a class="headerlink" href="#options_28" title="Permanent link">&para;</a></h6>
<ul>
<li>
<p><code>-r</code> — Ignored (but lets you pass <code>-r</code> for consistency with other commands)</p>
@ -6246,7 +6313,7 @@ Martin von Zweigbergk</p>
<ul>
<li><code>&lt;PATHS&gt;</code> — Move only changes to these paths (instead of all paths)</li>
</ul>
<h6 id="options_28"><strong>Options:</strong><a class="headerlink" href="#options_28" title="Permanent link">&para;</a></h6>
<h6 id="options_29"><strong>Options:</strong><a class="headerlink" href="#options_29" title="Permanent link">&para;</a></h6>
<ul>
<li><code>--from &lt;FROM&gt;</code> — Move part of this change into the destination</li>
<li><code>--to &lt;TO&gt;</code> — Move part of the source into this change</li>
@ -6268,7 +6335,7 @@ Martin von Zweigbergk</p>
<p>Default value: <code>@</code></p>
</li>
</ul>
<h6 id="options_29"><strong>Options:</strong><a class="headerlink" href="#options_29" title="Permanent link">&para;</a></h6>
<h6 id="options_30"><strong>Options:</strong><a class="headerlink" href="#options_30" title="Permanent link">&para;</a></h6>
<ul>
<li>
<p><code>-r</code> — Ignored (but lets you pass <code>-r</code> for consistency with other commands)</p>
@ -6326,7 +6393,7 @@ B =&gt; @
<p>Default value: <code>1</code></p>
</li>
</ul>
<h6 id="options_30"><strong>Options:</strong><a class="headerlink" href="#options_30" title="Permanent link">&para;</a></h6>
<h6 id="options_31"><strong>Options:</strong><a class="headerlink" href="#options_31" title="Permanent link">&para;</a></h6>
<ul>
<li>
<p><code>--edit</code> — Instead of creating a new working-copy commit on top of the target commit (like <code>jj new</code>), edit the target commit directly (like <code>jj edit</code>)</p>
@ -6337,7 +6404,7 @@ B =&gt; @
<p>Show how a change has evolved</p>
<p>Show how a change has evolved as it's been updated, rebased, etc.</p>
<p><strong>Usage:</strong> <code>jj obslog [OPTIONS]</code></p>
<h6 id="options_31"><strong>Options:</strong><a class="headerlink" href="#options_31" title="Permanent link">&para;</a></h6>
<h6 id="options_32"><strong>Options:</strong><a class="headerlink" href="#options_32" title="Permanent link">&para;</a></h6>
<ul>
<li>
<p><code>-r</code>, <code>--revision &lt;REVISION&gt;</code></p>
@ -6405,7 +6472,7 @@ B =&gt; @
<h2 id="jj-operation-log"><code>jj operation log</code><a class="headerlink" href="#jj-operation-log" title="Permanent link">&para;</a></h2>
<p>Show the operation log</p>
<p><strong>Usage:</strong> <code>jj operation log [OPTIONS]</code></p>
<h6 id="options_32"><strong>Options:</strong><a class="headerlink" href="#options_32" title="Permanent link">&para;</a></h6>
<h6 id="options_33"><strong>Options:</strong><a class="headerlink" href="#options_33" title="Permanent link">&para;</a></h6>
<ul>
<li><code>-l</code>, <code>--limit &lt;LIMIT&gt;</code> — Limit number of operations to show</li>
<li>
@ -6427,7 +6494,7 @@ B =&gt; @
<p>Default value: <code>@</code></p>
</li>
</ul>
<h6 id="options_33"><strong>Options:</strong><a class="headerlink" href="#options_33" title="Permanent link">&para;</a></h6>
<h6 id="options_34"><strong>Options:</strong><a class="headerlink" href="#options_34" title="Permanent link">&para;</a></h6>
<ul>
<li>
<p><code>--what &lt;WHAT&gt;</code> — What portions of the local state to restore (can be repeated)</p>
@ -6449,7 +6516,7 @@ B =&gt; @
<ul>
<li><code>&lt;OPERATION&gt;</code> — The operation to restore to</li>
</ul>
<h6 id="options_34"><strong>Options:</strong><a class="headerlink" href="#options_34" title="Permanent link">&para;</a></h6>
<h6 id="options_35"><strong>Options:</strong><a class="headerlink" href="#options_35" title="Permanent link">&para;</a></h6>
<ul>
<li>
<p><code>--what &lt;WHAT&gt;</code> — What portions of the local state to restore (can be repeated)</p>
@ -6490,7 +6557,7 @@ A A
<p>Default value: <code>1</code></p>
</li>
</ul>
<h6 id="options_35"><strong>Options:</strong><a class="headerlink" href="#options_35" title="Permanent link">&para;</a></h6>
<h6 id="options_36"><strong>Options:</strong><a class="headerlink" href="#options_36" title="Permanent link">&para;</a></h6>
<ul>
<li>
<p><code>--edit</code> — Edit the parent directly, instead of moving the working-copy commit</p>
@ -6568,7 +6635,7 @@ order to work (in addition to its current parent K), you can run <code>jj rebase
J J
</code></pre></div>
<p><strong>Usage:</strong> <code>jj rebase [OPTIONS] --destination &lt;DESTINATION&gt;</code></p>
<h6 id="options_36"><strong>Options:</strong><a class="headerlink" href="#options_36" title="Permanent link">&para;</a></h6>
<h6 id="options_37"><strong>Options:</strong><a class="headerlink" href="#options_37" title="Permanent link">&para;</a></h6>
<ul>
<li><code>-b</code>, <code>--branch &lt;BRANCH&gt;</code> — Rebase the whole branch relative to destination's ancestors (can be repeated)</li>
<li><code>-s</code>, <code>--source &lt;SOURCE&gt;</code> — Rebase specified revision(s) together their tree of descendants (can be repeated)</li>
@ -6592,7 +6659,7 @@ J J
<ul>
<li><code>&lt;PATHS&gt;</code> — Restrict to these paths when searching for a conflict to resolve. We will attempt to resolve the first conflict we can find. You can use the <code>--list</code> argument to find paths to use here</li>
</ul>
<h6 id="options_37"><strong>Options:</strong><a class="headerlink" href="#options_37" title="Permanent link">&para;</a></h6>
<h6 id="options_38"><strong>Options:</strong><a class="headerlink" href="#options_38" title="Permanent link">&para;</a></h6>
<ul>
<li>
<p><code>-r</code>, <code>--revision &lt;REVISION&gt;</code></p>
@ -6618,7 +6685,7 @@ J J
<ul>
<li><code>&lt;PATHS&gt;</code> — Restore only these paths (instead of all paths)</li>
</ul>
<h6 id="options_38"><strong>Options:</strong><a class="headerlink" href="#options_38" title="Permanent link">&para;</a></h6>
<h6 id="options_39"><strong>Options:</strong><a class="headerlink" href="#options_39" title="Permanent link">&para;</a></h6>
<ul>
<li><code>--from &lt;FROM&gt;</code> — Revision to restore from (source)</li>
<li><code>--to &lt;TO&gt;</code> — Revision to restore into (destination)</li>
@ -6638,7 +6705,7 @@ J J
<p>Default value: <code>@</code></p>
</li>
</ul>
<h6 id="options_39"><strong>Options:</strong><a class="headerlink" href="#options_39" title="Permanent link">&para;</a></h6>
<h6 id="options_40"><strong>Options:</strong><a class="headerlink" href="#options_40" title="Permanent link">&para;</a></h6>
<ul>
<li>
<p><code>-r</code> — Ignored (but lets you pass <code>-r</code> for consistency with other commands)</p>
@ -6684,7 +6751,7 @@ J J
<p>Update the patterns that are present in the working copy</p>
<p>For example, if all you need is the <code>README.md</code> and the <code>lib/</code> directory, use <code>jj sparse set --clear --add README.md --add lib</code>. If you no longer need the <code>lib</code> directory, use <code>jj sparse set --remove lib</code>.</p>
<p><strong>Usage:</strong> <code>jj sparse set [OPTIONS]</code></p>
<h6 id="options_40"><strong>Options:</strong><a class="headerlink" href="#options_40" title="Permanent link">&para;</a></h6>
<h6 id="options_41"><strong>Options:</strong><a class="headerlink" href="#options_41" title="Permanent link">&para;</a></h6>
<ul>
<li><code>--add &lt;ADD&gt;</code> — Patterns to add to the working copy</li>
<li><code>--remove &lt;REMOVE&gt;</code> — Patterns to remove from the working copy</li>
@ -6710,7 +6777,7 @@ J J
<ul>
<li><code>&lt;PATHS&gt;</code> — Put these paths in the first commit</li>
</ul>
<h6 id="options_41"><strong>Options:</strong><a class="headerlink" href="#options_41" title="Permanent link">&para;</a></h6>
<h6 id="options_42"><strong>Options:</strong><a class="headerlink" href="#options_42" title="Permanent link">&para;</a></h6>
<ul>
<li>
<p><code>-i</code>, <code>--interactive</code> — Interactively choose which parts to split. This is the default if no paths are provided</p>
@ -6730,7 +6797,7 @@ J J
<ul>
<li><code>&lt;PATHS&gt;</code> — Move only changes to these paths (instead of all paths)</li>
</ul>
<h6 id="options_42"><strong>Options:</strong><a class="headerlink" href="#options_42" title="Permanent link">&para;</a></h6>
<h6 id="options_43"><strong>Options:</strong><a class="headerlink" href="#options_43" title="Permanent link">&para;</a></h6>
<ul>
<li>
<p><code>-r</code>, <code>--revision &lt;REVISION&gt;</code></p>
@ -6784,7 +6851,7 @@ J J
<h2 id="jj-util-completion"><code>jj util completion</code><a class="headerlink" href="#jj-util-completion" title="Permanent link">&para;</a></h2>
<p>Print a command-line-completion script</p>
<p><strong>Usage:</strong> <code>jj util completion [OPTIONS]</code></p>
<h6 id="options_43"><strong>Options:</strong><a class="headerlink" href="#options_43" title="Permanent link">&para;</a></h6>
<h6 id="options_44"><strong>Options:</strong><a class="headerlink" href="#options_44" title="Permanent link">&para;</a></h6>
<ul>
<li>
<p><code>--bash</code> — Print a completion script for Bash</p>
@ -6802,7 +6869,7 @@ J J
<h2 id="jj-util-gc"><code>jj util gc</code><a class="headerlink" href="#jj-util-gc" title="Permanent link">&para;</a></h2>
<p>Run backend-dependent garbage collection</p>
<p><strong>Usage:</strong> <code>jj util gc [OPTIONS]</code></p>
<h6 id="options_44"><strong>Options:</strong><a class="headerlink" href="#options_44" title="Permanent link">&para;</a></h6>
<h6 id="options_45"><strong>Options:</strong><a class="headerlink" href="#options_45" title="Permanent link">&para;</a></h6>
<ul>
<li><code>--expire &lt;EXPIRE&gt;</code> — Time threshold</li>
</ul>
@ -6825,7 +6892,7 @@ J J
<p>Default value: <code>@</code></p>
</li>
</ul>
<h6 id="options_45"><strong>Options:</strong><a class="headerlink" href="#options_45" title="Permanent link">&para;</a></h6>
<h6 id="options_46"><strong>Options:</strong><a class="headerlink" href="#options_46" title="Permanent link">&para;</a></h6>
<ul>
<li>
<p><code>--what &lt;WHAT&gt;</code> — What portions of the local state to restore (can be repeated)</p>
@ -6844,7 +6911,7 @@ J J
<p>After moving the changes out of the parent, the child revision will have the same content state as before. If moving the change out of the parent change made it empty compared to its parent, it will be abandoned. Without <code>--interactive</code>, the parent change will always become empty.</p>
<p>If the source became empty and both the source and destination had a non-empty description, you will be asked for the combined description. If either was empty, then the other one will be used.</p>
<p><strong>Usage:</strong> <code>jj unsquash [OPTIONS]</code></p>
<h6 id="options_46"><strong>Options:</strong><a class="headerlink" href="#options_46" title="Permanent link">&para;</a></h6>
<h6 id="options_47"><strong>Options:</strong><a class="headerlink" href="#options_47" title="Permanent link">&para;</a></h6>
<ul>
<li>
<p><code>-r</code>, <code>--revision &lt;REVISION&gt;</code></p>
@ -6885,7 +6952,7 @@ J J
<ul>
<li><code>&lt;DESTINATION&gt;</code> — Where to create the new workspace</li>
</ul>
<h6 id="options_47"><strong>Options:</strong><a class="headerlink" href="#options_47" title="Permanent link">&para;</a></h6>
<h6 id="options_48"><strong>Options:</strong><a class="headerlink" href="#options_48" title="Permanent link">&para;</a></h6>
<ul>
<li><code>--name &lt;NAME&gt;</code> — A name for the workspace</li>
<li><code>-r</code>, <code>--revision &lt;REVISION&gt;</code> — A list of parent revisions for the working-copy commit of the newly created workspace. You may specify nothing, or any number of parents</li>

102
prerelease/config/index.html
View file

@ -1010,6 +1010,39 @@
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#ways-to-specify-jj-config-details" class="md-nav__link">
<span class="md-ellipsis">
Ways to specify jj config: details
</span>
</a>
<nav class="md-nav" aria-label="Ways to specify jj config: details">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#user-config-file" class="md-nav__link">
<span class="md-ellipsis">
User config file
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#specifying-config-on-the-command-line" class="md-nav__link">
<span class="md-ellipsis">
Specifying config on the command-line
</span>
</a>
</li>
</ul>
</nav>
</li>
</ul>
@ -1912,6 +1945,39 @@
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#ways-to-specify-jj-config-details" class="md-nav__link">
<span class="md-ellipsis">
Ways to specify jj config: details
</span>
</a>
<nav class="md-nav" aria-label="Ways to specify jj config: details">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#user-config-file" class="md-nav__link">
<span class="md-ellipsis">
User config file
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#specifying-config-on-the-command-line" class="md-nav__link">
<span class="md-ellipsis">
Specifying config on the command-line
</span>
</a>
</li>
</ul>
</nav>
</li>
</ul>
@ -1932,13 +1998,31 @@
<h1 id="configuration">Configuration<a class="headerlink" href="#configuration" title="Permanent link">&para;</a></h1>
<p>These are the config settings available to jj/Jujutsu.</p>
<h2 id="config-files-and-toml">Config files and TOML<a class="headerlink" href="#config-files-and-toml" title="Permanent link">&para;</a></h2>
<p>The config settings are loaded from the following locations. Less common ways to
specify <code>jj</code> config settings are discussed in a later section.</p>
<p><code>jj</code> loads several types of config settings:</p>
<ul>
<li><a href="#user-config-file">The user config file</a></li>
<li><code>.jj/repo/config.toml</code> (per-repository)</li>
<li>
<p>The built-in settings. These cannot be edited. They can be viewed in the
<code>cli/src/config/</code> directory in <code>jj</code>'s source repo.</p>
</li>
<li>
<p>The user settings. These can be edited with <code>jj config edit --user</code>. User
settings are located in <a href="#user-config-file">the user config file</a>, which can be found with <code>jj
config path --user</code>.</p>
</li>
<li>
<p>The repo settings. These can be edited with <code>jj config edit --repo</code> and are
located in <code>.jj/repo/config.toml</code>.</p>
</li>
<li>
<p>Settings <a href="#specifying-config-on-the-command-line">specified in the command-line</a>.</p>
</li>
</ul>
<p>See the <a href="https://toml.io/en/">TOML site</a> and the <a href="https://toml.io/en/v1.0.0">syntax guide</a> for a description of the syntax.</p>
<p>These are listed in the order they are loaded; the settings from earlier items
in
the list are overridden by the settings from later items if they disagree. Every
type of config except for the built-in settings is optional.</p>
<p>See the <a href="https://toml.io/en/">TOML site</a> and the <a href="https://toml.io/en/v1.0.0">syntax guide</a> for a detailed description of the
syntax. We cover some of the basics below.</p>
<p>The first thing to remember is that the value of a setting (the part to the
right of the <code>=</code> sign) should be surrounded in quotes if it's a string.</p>
<h3 id="dotted-style-and-headings">Dotted style and headings<a class="headerlink" href="#dotted-style-and-headings" title="Permanent link">&para;</a></h3>
@ -2316,7 +2400,12 @@ snapshots without having to rescan the entire working copy.</p>
<code>core.fsmonitor = "watchman"</code>. Ensure that you have <a href="https://facebook.github.io/watchman/docs/install">installed the Watchman
executable on your system</a>.</p>
<p>Debugging commands are available under <code>jj debug watchman</code>.</p>
<h1 id="user-config-file">User config file<a class="headerlink" href="#user-config-file" title="Permanent link">&para;</a></h1>
<h2 id="ways-to-specify-jj-config-details">Ways to specify <code>jj</code> config: details<a class="headerlink" href="#ways-to-specify-jj-config-details" title="Permanent link">&para;</a></h2>
<h3 id="user-config-file">User config file<a class="headerlink" href="#user-config-file" title="Permanent link">&para;</a></h3>
<p>An easy way to find the user config file is:</p>
<div class="highlight"><pre><span></span><code>jj<span class="w"> </span>config<span class="w"> </span>path<span class="w"> </span>--user
</code></pre></div>
<p>The rest of this section covers the details of where this file can be located.</p>
<p>On all platforms, the user's global <code>jj</code> configuration file is located at either
<code>~/.jjconfig.toml</code> (where <code>~</code> represents <code>$HOME</code> on Unix-likes, or
<code>%USERPROFILE%</code> on Windows) or in a platform-specific directory. The
@ -2354,6 +2443,7 @@ to a TOML file that will be used instead of any configuration file in the
default locations. For example,</p>
<div class="highlight"><pre><span></span><code>env<span class="w"> </span><span class="nv">JJ_CONFIG</span><span class="o">=</span>/dev/null<span class="w"> </span>jj<span class="w"> </span>log<span class="w"> </span><span class="c1"># Ignores any settings specified in the config file.</span>
</code></pre></div>
<h3 id="specifying-config-on-the-command-line">Specifying config on the command-line<a class="headerlink" href="#specifying-config-on-the-command-line" title="Permanent link">&para;</a></h3>
<p>You can use one or more <code>--config-toml</code> options on the command line to specify
additional configuration settings. This overrides settings defined in config
files or environment variables. For example,</p>

2
prerelease/search/search_index.json
View file

File diff suppressed because one or more lines are too long

BIN
prerelease/sitemap.xml.gz
View file

Binary file not shown.