diff mbox

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

Message ID 6csf1e-9n5.ln1@sabon.larryhynes.com (mailing list archive)
State Superseded
Delegated to: Herbert Xu
Headers show

Commit Message

Larry Hynes June 17, 2017, 2:53 p.m. UTC 
Hi

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.


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

Comments

Jilles Tjoelker June 23, 2017, 2:41 p.m. UTC | #1 
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.
diff mbox

Patch

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.