Page MenuHomeFreeBSD

sh.1: Provide references to editline(7)
Needs ReviewPublic

Authored by tembun_bk.ru on Sun, Jan 18, 9:00 PM.
Referenced Files
Unknown Object (File)
Sat, Feb 7, 7:28 PM
Unknown Object (File)
Tue, Feb 3, 11:13 AM
Unknown Object (File)
Sun, Feb 1, 3:02 PM
Unknown Object (File)
Sat, Jan 31, 3:06 AM
Unknown Object (File)
Sat, Jan 24, 9:07 PM
Unknown Object (File)
Thu, Jan 22, 5:27 PM
Unknown Object (File)
Wed, Jan 21, 11:55 AM
Unknown Object (File)
Mon, Jan 19, 8:01 AM
Subscribers

Details

Summary

Now the man page does not document anywhere that editline(7) is used by the sh(1) for the command line editing. There is a reference to editrc(5), but it's not very obvious and mentioned only once, in the bind command description. Meanwhile, editline(7) does a good job on documenting editor commands and modes, which are mentioned in the sh(1) page several times.

Also, I believe that most users, if want to find more information about, say, keybindings for searching through the shell history, would expect to find that in the sh(1) page, since shell is the program, where they use these keybindings. It would be easier for them to come across editline(7) if this man page will be mentioned in several places.

Diff Detail

Repository
rG FreeBSD src repository
Lint
Lint Skipped
Unit
Tests Skipped

Event Timeline

One apparent mistake, looks OK otherwise.

bin/sh/sh.1
2068

The section number is in an unexpected position.

bin/sh/sh.1
232

I wonder if these should actually be something like:

See
.Sx Command Line Editing

2067–2068
3013

The first sentence of a paragraph or section is very important. It tells the reader if they're reading the right paragraph, or if they need to skip to the next one.

The existing introductory sentence is a good explanation of this section. This one is not. I would suggest putting it this line in a new paragraph at the bottom of this section.

tembun_bk.ru marked 4 inline comments as done.

Address jilles and ziaee comments.

This revision is now accepted and ready to land.Sun, Feb 1, 4:10 PM
This revision now requires review to proceed.Fri, Feb 6, 8:54 AM