cybercyst/jj
1
0
Fork 0
mirror of https://github.com/martinvonz/jj.git synced 2025-05-29 02:51:12 +00:00
Code Issues Packages Projects Releases Wiki Activity

Deployed e8f722c to prerelease with MkDocs 1.6.1 and mike 2.1.3

Browse Source
This commit is contained in:
jj-docs[bot] 2024-11-05 03:14:56 +00:00
parent 48dfb2280e
commit dc1cbf4446
4 changed files with 74 additions and 55 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

53
prerelease/config/index.html
View File

@ -2965,27 +2965,46 @@ setting, but you could set it explicitly too.</p>
</code></pre></div>
<p>Obviously, you would only set one line, don't copy them all in!</p>
<h2 id="editing-diffs">Editing diffs<a class="headerlink" href="#editing-diffs" title="Permanent link">&para;</a></h2>
<p>The <code>ui.diff-editor</code> setting affects the tool used for editing diffs (e.g. <code>jj
split</code>, <code>jj squash -i</code>). The default is the special value <code>:builtin</code>, which
launches a built-in TUI tool (known as <a href="https://github.com/arxanas/scm-record?tab=readme-ov-file#scm-diff-editor">scm-diff-editor</a>) to edit the diff in
your terminal.</p>
<p>The <code>ui.diff-editor</code> setting affects the default tool used for editing diffs
(e.g. <code>jj split</code>, <code>jj squash -i</code>). If it is not set, the special value
<code>:builtin</code> is used. It launches a built-in TUI tool (known as <a href="https://github.com/arxanas/scm-record?tab=readme-ov-file#scm-diff-editor">scm-diff-editor</a>)
to edit the diff in your terminal.</p>
<p>You can try a different tool temporarily by doing e.g. <code>jj split --tool meld</code> or
you can set the option to change the default. This requires that you have an
appropriate tool installed, e.g. <a href="https://meldmerge.org/">Meld</a> to use the
<code>meld</code> diff editor.</p>
<p><strong>Suggestion:</strong> If possible, it is recommended to try an external diff tool like
<code>meld</code> (see below for some other possibilities) for splitting commits and other
diff editing, in addition to the built-in diff editor. It is good to know the
capabilities of both. The built-in diff editor does not require external tools
to be available, is faster for tasks like picking hunks, and does not require
leaving the terminal. External tools give you the flexibility of picking out
portions of lines from the diff or even arbitrarily editing the text of the
files.</p>
<p>If <code>ui.diff-editor</code> is a string, e.g. <code>"meld"</code>, the arguments will be read from
the following config keys.</p>
<div class="highlight"><pre><span></span><code><span class="c1"># merge-tools.meld.program = &quot;meld&quot; # Defaults to the name of the tool if not specified</span>
<span class="n">merge-tools</span><span class="p">.</span><span class="n">meld</span><span class="p">.</span><span class="n">program</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s2">&quot;/path/to/meld&quot;</span><span class="w"> </span><span class="c1"># May be necessary if `meld` is not in the PATH</span>
<span class="n">merge-tools</span><span class="p">.</span><span class="n">meld</span><span class="p">.</span><span class="n">edit-args</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="p">[</span><span class="s2">&quot;--newtab&quot;</span><span class="p">,</span><span class="w"> </span><span class="s2">&quot;$left&quot;</span><span class="p">,</span><span class="w"> </span><span class="s2">&quot;$right&quot;</span><span class="p">]</span>
</code></pre></div>
<p><code>jj</code> makes the following substitutions:</p>
<ul>
<li><code>$left</code> and <code>$right</code> are replaced with the paths to the left and right
directories to diff respectively.</li>
<li>
<p><code>$left</code> and <code>$right</code> are replaced with the paths to the left and right
directories to diff respectively.</p>
</li>
<li>
<p>If no <code>edit-args</code> are specified, <code>["$left", "$right"]</code> are set by default.</p>
</li>
</ul>
<p>If no arguments are specified, <code>["$left", "$right"]</code> are set by default.</p>
<p>For example:</p>
<div class="highlight"><pre><span></span><code><span class="c1"># Use merge-tools.kdiff3.edit-args</span>
<span class="n">ui</span><span class="p">.</span><span class="n">diff-editor</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s2">&quot;kdiff3&quot;</span>
<p>Finally, <code>ui.diff-editor</code> can be a list that specifies a command and its arguments.</p>
<p>Some examples:</p>
<div class="highlight"><pre><span></span><code><span class="c1"># Use merge-tools.meld.edit-args</span>
<span class="n">ui</span><span class="p">.</span><span class="n">diff-editor</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s2">&quot;meld&quot;</span><span class="w"> </span><span class="c1"># Or `kdiff3`, or `diffedit3`, ...</span>
<span class="c1"># Specify edit-args inline</span>
<span class="n">ui</span><span class="p">.</span><span class="n">diff-editor</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="p">[</span><span class="s2">&quot;kdiff3&quot;</span><span class="p">,</span><span class="w"> </span><span class="s2">&quot;--merge&quot;</span><span class="p">,</span><span class="w"> </span><span class="s2">&quot;$left&quot;</span><span class="p">,</span><span class="w"> </span><span class="s2">&quot;$right&quot;</span><span class="p">]</span>
</code></pre></div>
<p>If <code>ui.diff-editor</code> consists of a single word, e.g. <code>"kdiff3"</code>, the arguments
will be read from the following config keys.</p>
<div class="highlight"><pre><span></span><code><span class="c1"># merge-tools.kdiff3.program = &quot;kdiff3&quot; # Defaults to the name of the tool if not specified</span>
<span class="n">merge-tools</span><span class="p">.</span><span class="n">kdiff3</span><span class="p">.</span><span class="n">edit-args</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="p">[</span>
<span class="w"> </span><span class="s2">&quot;--merge&quot;</span><span class="p">,</span><span class="w"> </span><span class="s2">&quot;--cs&quot;</span><span class="p">,</span><span class="w"> </span><span class="s2">&quot;CreateBakFiles=0&quot;</span><span class="p">,</span><span class="w"> </span><span class="s2">&quot;$left&quot;</span><span class="p">,</span><span class="w"> </span><span class="s2">&quot;$right&quot;</span><span class="p">]</span>
<span class="n">ui</span><span class="p">.</span><span class="n">diff-editor</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="p">[</span><span class="s2">&quot;/path/to/binary&quot;</span><span class="p">,</span><span class="w"> </span><span class="s2">&quot;--be-helpful&quot;</span><span class="p">,</span><span class="w"> </span><span class="s2">&quot;$left&quot;</span><span class="p">,</span><span class="w"> </span><span class="s2">&quot;$right&quot;</span><span class="p">]</span>
<span class="c1"># Equivalent to [&quot;binary&quot;, &quot;$left&quot;, &quot;$right&quot;] arguments by default</span>
<span class="n">ui</span><span class="p">.</span><span class="n">diff-editor</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s2">&quot;binary&quot;</span>
</code></pre></div>
<h3 id="experimental-3-pane-diff-editing">Experimental 3-pane diff editing<a class="headerlink" href="#experimental-3-pane-diff-editing" title="Permanent link">&para;</a></h3>
<p>We offer two special "3-pane" diff editor configs:</p>

2
prerelease/search/search_index.json
View File

File diff suppressed because one or more lines are too long

74
prerelease/sitemap.xml
View File

@ -2,150 +2,150 @@
<urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9">
<url>
<loc>https://martinvonz.github.io/jj/latest/</loc>
<lastmod>2024-11-04</lastmod>
<lastmod>2024-11-05</lastmod>
</url>
<url>
<loc>https://martinvonz.github.io/jj/latest/FAQ/</loc>
<lastmod>2024-11-04</lastmod>
<lastmod>2024-11-05</lastmod>
</url>
<url>
<loc>https://martinvonz.github.io/jj/latest/bookmarks/</loc>
<lastmod>2024-11-04</lastmod>
<lastmod>2024-11-05</lastmod>
</url>
<url>
<loc>https://martinvonz.github.io/jj/latest/cli-reference/</loc>
<lastmod>2024-11-04</lastmod>
<lastmod>2024-11-05</lastmod>
</url>
<url>
<loc>https://martinvonz.github.io/jj/latest/code-of-conduct/</loc>
<lastmod>2024-11-04</lastmod>
<lastmod>2024-11-05</lastmod>
</url>
<url>
<loc>https://martinvonz.github.io/jj/latest/community_tools/</loc>
<lastmod>2024-11-04</lastmod>
<lastmod>2024-11-05</lastmod>
</url>
<url>
<loc>https://martinvonz.github.io/jj/latest/config/</loc>
<lastmod>2024-11-04</lastmod>
<lastmod>2024-11-05</lastmod>
</url>
<url>
<loc>https://martinvonz.github.io/jj/latest/conflicts/</loc>
<lastmod>2024-11-04</lastmod>
<lastmod>2024-11-05</lastmod>
</url>
<url>
<loc>https://martinvonz.github.io/jj/latest/contributing/</loc>
<lastmod>2024-11-04</lastmod>
<lastmod>2024-11-05</lastmod>
</url>
<url>
<loc>https://martinvonz.github.io/jj/latest/design_doc_blueprint/</loc>
<lastmod>2024-11-04</lastmod>
<lastmod>2024-11-05</lastmod>
</url>
<url>
<loc>https://martinvonz.github.io/jj/latest/design_docs/</loc>
<lastmod>2024-11-04</lastmod>
<lastmod>2024-11-05</lastmod>
</url>
<url>
<loc>https://martinvonz.github.io/jj/latest/filesets/</loc>
<lastmod>2024-11-04</lastmod>
<lastmod>2024-11-05</lastmod>
</url>
<url>
<loc>https://martinvonz.github.io/jj/latest/git-comparison/</loc>
<lastmod>2024-11-04</lastmod>
<lastmod>2024-11-05</lastmod>
</url>
<url>
<loc>https://martinvonz.github.io/jj/latest/git-compatibility/</loc>
<lastmod>2024-11-04</lastmod>
<lastmod>2024-11-05</lastmod>
</url>
<url>
<loc>https://martinvonz.github.io/jj/latest/github/</loc>
<lastmod>2024-11-04</lastmod>
<lastmod>2024-11-05</lastmod>
</url>
<url>
<loc>https://martinvonz.github.io/jj/latest/glossary/</loc>
<lastmod>2024-11-04</lastmod>
<lastmod>2024-11-05</lastmod>
</url>
<url>
<loc>https://martinvonz.github.io/jj/latest/install-and-setup/</loc>
<lastmod>2024-11-04</lastmod>
<lastmod>2024-11-05</lastmod>
</url>
<url>
<loc>https://martinvonz.github.io/jj/latest/operation-log/</loc>
<lastmod>2024-11-04</lastmod>
<lastmod>2024-11-05</lastmod>
</url>
<url>
<loc>https://martinvonz.github.io/jj/latest/related-work/</loc>
<lastmod>2024-11-04</lastmod>
<lastmod>2024-11-05</lastmod>
</url>
<url>
<loc>https://martinvonz.github.io/jj/latest/revsets/</loc>
<lastmod>2024-11-04</lastmod>
<lastmod>2024-11-05</lastmod>
</url>
<url>
<loc>https://martinvonz.github.io/jj/latest/roadmap/</loc>
<lastmod>2024-11-04</lastmod>
<lastmod>2024-11-05</lastmod>
</url>
<url>
<loc>https://martinvonz.github.io/jj/latest/sapling-comparison/</loc>
<lastmod>2024-11-04</lastmod>
<lastmod>2024-11-05</lastmod>
</url>
<url>
<loc>https://martinvonz.github.io/jj/latest/templates/</loc>
<lastmod>2024-11-04</lastmod>
<lastmod>2024-11-05</lastmod>
</url>
<url>
<loc>https://martinvonz.github.io/jj/latest/testimonials/</loc>
<lastmod>2024-11-04</lastmod>
<lastmod>2024-11-05</lastmod>
</url>
<url>
<loc>https://martinvonz.github.io/jj/latest/tutorial/</loc>
<lastmod>2024-11-04</lastmod>
<lastmod>2024-11-05</lastmod>
</url>
<url>
<loc>https://martinvonz.github.io/jj/latest/windows/</loc>
<lastmod>2024-11-04</lastmod>
<lastmod>2024-11-05</lastmod>
</url>
<url>
<loc>https://martinvonz.github.io/jj/latest/working-copy/</loc>
<lastmod>2024-11-04</lastmod>
<lastmod>2024-11-05</lastmod>
</url>
<url>
<loc>https://martinvonz.github.io/jj/latest/design/copy-tracking/</loc>
<lastmod>2024-11-04</lastmod>
<lastmod>2024-11-05</lastmod>
</url>
<url>
<loc>https://martinvonz.github.io/jj/latest/design/git-submodule-storage/</loc>
<lastmod>2024-11-04</lastmod>
<lastmod>2024-11-05</lastmod>
</url>
<url>
<loc>https://martinvonz.github.io/jj/latest/design/git-submodules/</loc>
<lastmod>2024-11-04</lastmod>
<lastmod>2024-11-05</lastmod>
</url>
<url>
<loc>https://martinvonz.github.io/jj/latest/design/run/</loc>
<lastmod>2024-11-04</lastmod>
<lastmod>2024-11-05</lastmod>
</url>
<url>
<loc>https://martinvonz.github.io/jj/latest/design/sparse-v2/</loc>
<lastmod>2024-11-04</lastmod>
<lastmod>2024-11-05</lastmod>
</url>
<url>
<loc>https://martinvonz.github.io/jj/latest/design/tracking-branches/</loc>
<lastmod>2024-11-04</lastmod>
<lastmod>2024-11-05</lastmod>
</url>
<url>
<loc>https://martinvonz.github.io/jj/latest/governance/temporary-voting/</loc>
<lastmod>2024-11-04</lastmod>
<lastmod>2024-11-05</lastmod>
</url>
<url>
<loc>https://martinvonz.github.io/jj/latest/technical/architecture/</loc>
<lastmod>2024-11-04</lastmod>
<lastmod>2024-11-05</lastmod>
</url>
<url>
<loc>https://martinvonz.github.io/jj/latest/technical/concurrency/</loc>
<lastmod>2024-11-04</lastmod>
<lastmod>2024-11-05</lastmod>
</url>
<url>
<loc>https://martinvonz.github.io/jj/latest/technical/conflicts/</loc>
<lastmod>2024-11-04</lastmod>
<lastmod>2024-11-05</lastmod>
</url>
</urlset>

BIN
prerelease/sitemap.xml.gz
View File

Binary file not shown.