On Tue, Mar 17, 2020 at 3:50 PM Daniel Shahaf <d...@daniel.shahaf.name> wrote:
> hartmannat...@apache.org wrote on Tue, 17 Mar 2020 18:36 -0000:
> > +<p>When invoking the user-defined <tt>$SVN_EDITOR</tt>, such as during
>
> The editor may be configured in other ways: --editor-cmd,
> --config-option=…:editor-cmd, $EDITOR.
>
> Suggest to say "When invoking the user-defined editor", with or without
> listing some of the ways in which the editor command may be specified.
> Add an example? (An example is worth a thousand words…)
Thanks for your suggestions.
How about something along these lines:
[[[
<div class="h4" id="editor-filename-escaping">
<h4>Escaping/quoting of pathname arguments to the user-defined editor
<a class="sectionlink" href="#log-search"
title="Link to this section">¶</a>
</h4>
<p>When invoking the user-defined editor, such as during interactive conflict
resolution, Subversion now performs escaping of any special characters in the
pathname of the file to be edited. This corrects a problem that would occur
previously when the file to be edited (and/or the path leading to it)
contained spaces or other special characters. (See
<a href="http://svn.apache.org/r1874057";>r1874057</a>,
<a href="http://svn.apache.org/r1874093";>r1874093</a>, and
<a href="http://svn.apache.org/r1875230";>r1875230</a>.)</p>
<p>Note that escaping is performed only on the pathname argument. As before,
the editor itself is invoked through the shell and the user must properly
quote/escape the command line used to launch it. This is intentional, as it
allows the user to construct a shell command which itself contains command
line arguments.</p>
<p>The user-defined editor can be specified in the following ways, in this
order of precedence:</p>
<ul>
<li>The <tt>--editor-cmd</tt> command-line option</li>
<li>The <tt>$SVN_EDITOR</tt> environment variable</li>
<li>The <tt>editor-cmd</tt> runtime configuration option</li>
<li>The <tt>$VISUAL</tt> environment variable</li>
<li>The <tt>$EDITOR</tt> environment variable</li>
</ul>
<p>The escaped pathname of the file to be edited is passed to the editor as
its last command line argument.</p>
<p>See the related <a href="https://subversion.apache.org/faq.html#svn-editor";
>FAQ entry</a> for more on spaces and/or command line options in the editor
path.</p>
</div> <!-- editor-filename-escaping -->
]]]
Cheers,
Nathan
