Small cleanup to src/dash.1 - Command Line Editing

Commit Message

Larry Hynes June 23, 2017, 4:42 p.m. UTC

Jilles Tjoelker <[e-mail]> wrote:
> On Sat, Jun 17, 2017 at 03:53:26PM +0100, Larry Hynes wrote:
>> src/dash.1, under Command Line Editing, states:

>>       It's similar to vi: typing <ESC> will throw you into command
>>       VI command mode.

>> - There appears to be no need for both occurrences of 'command'
>> - I can't see a reason for VI to be capitalised
>> - 'will throw you into' seems a little... enthusiastic

>> Following diff changes it to

>>       It's similar to vi: typing <ESC> enters vi command mode.

>> diff --git a/src/dash.1 b/src/dash.1
>> index 8b8026d..f35d89d 100644
>> --- a/src/dash.1
>> +++ b/src/dash.1
>> @@ -2232,7 +2232,7 @@ enabled, sh can be switched between insert mode and command mode.
>>  The editor is not described in full here, but will be in a later document.
>>  It's similar to vi: typing
>>  .Aq ESC
>> -will throw you into command VI command mode.
>> +enters vi command mode.
>>  Hitting
>>  .Aq return
>>  while in command mode will pass the line to the shell.

> I agree. If you're changing things here anyway, I suggest getting rid of
> the contraction as well (changing It's to It is). The fairly formal
> style of man pages avoids contractions, just like it avoids "you".

> The reference to the "later document" can probably be removed as well,
> since said document does not exist yet after many years.

Hi

Revised diff, below, expands the contraction, deletes reference to
'later document' and changes 'place' to 'places' in the following:

	The command ‘set -o vi’ enables vi-mode editing and place sh
	into vi insert mode.


--
To unsubscribe from this list: send the line "unsubscribe dash" in
the body of a message to [e-mail]
More majordomo info at  http://vger.kernel.org/majordomo-info.html

Comments

Herbert Xu March 10, 2018, 8:03 a.m. UTC | #1

On Fri, Jun 23, 2017 at 05:42:50PM +0100, Larry Hynes wrote:
>
> Revised diff, below, expands the contraction, deletes reference to
> 'later document' and changes 'place' to 'places' in the following:
> 
> 	The command ‘set -o vi’ enables vi-mode editing and place sh
> 	into vi insert mode.

Patch applied.  Thanks.

Patch

diff --git a/src/dash.1 b/src/dash.1
index 8b8026d..1056285 100644
--- a/src/dash.1
+++ b/src/dash.1
@@ -2226,13 +2226,12 @@  This mode uses commands, described below,
 similar to a subset of those described in the vi man page.
 The command
 .Ql set -o vi
-enables vi-mode editing and place sh into vi insert mode.
+enables vi-mode editing and places sh into vi insert mode.
 With vi-mode
 enabled, sh can be switched between insert mode and command mode.
-The editor is not described in full here, but will be in a later document.
-It's similar to vi: typing
+It is similar to vi: typing
 .Aq ESC
-will throw you into command VI command mode.
+enters vi command mode.
 Hitting
 .Aq return
 while in command mode will pass the line to the shell.