[vim/vim] runtime(man): UX fixes (PR #15117)
Ivan Shapovalov
Two minor improvements to manpage support that seem to do the right thing for me.
Note that I'm fairly new to Vim{,script}, so please do not kick me too hard if any of these changes are bogus.
-
Honor placement (vert/hor/tab) cmd modifiers to
:Man, if any are present, beforeg:ft_man_open_mode.
This way, e.g.:vert Mandoes the expected thing even in presence of a contradictingg:ft_man_open_mode. -
Actually add parentheses to
iskeyword=so thatKon a man page reference considers its section (if present).
The comment suggests that the parentheses were added to the iskeyword set elsewhere, but I could not find it in the code (and, indeed, it did not work in practice).
You can view, comment on, or merge this pull request online at:
https://github.com/vim/vim/pull/15117
Commit Summary
- f270573 runtime(man): honor cmd modifiers before `g:ft_man_open_mode`
- c955ffc runtime(man): add parentheses to iskeyword=
File Changes
(2 files)
Patch Links:
—
Reply to this email directly, view it on GitHub.
You are receiving this because you are subscribed to this thread.
Ivan Shapovalov
@intelfx pushed 2 commits.
- f394f04 runtime(man): honor cmd modifiers before `g:ft_man_open_mode`
- af30dec runtime(man): add parentheses to iskeyword=
—
View it on GitHub or unsubscribe.
You are receiving this because you are subscribed to this thread.
Aliaksei Budavei
What manual page issue are you currently having that can be
solved by including (,) in &iskeyword script-wide?
The reason for chucking out parentheses at 8cfe52 was that
having them included or not is immaterial for parsing str:
—
Reply to this email directly, view it on GitHub.
You are receiving this because you are subscribed to this thread.
Ivan Shapovalov
What manual page issue are you currently having that can be solved by including
(,)in&iskeywordscript-wide?
If you define keywordprg=:Man and then use plain K to navigate to a man page under cursor, the section is not considered.
I see that man.vim itself suggests a nmap K :Man <cWORD><CR> mapping (that is special-cased in GetPage), and also defines a <Leader> K mapping for the same, but it feels unnecessary if one can just use builtin K?
—
Reply to this email directly, view it on GitHub.
You are receiving this because you are subscribed to this thread.
Aliaksei Budavei
I can reproduce the faulty behaviour (v9.1.0516).
For example, initially read signal(2) and later fail to
read signal(7)with K (when &kp is set to :Man):
MANWIDTH=80 VIMRUNTIME=/path/to/fork/dir/runtime \ vim --clean --not-a-term \ '+set vif=NONE' \ '+sil! unmap K' \ '+doautoall FileType setl ft=man kp=:Man nofen' \ '+Man 2 signal' \ '+/signal(7)' \ '+norm f7BK'
However, finding a page should work whenever the sought page
is locally installed in only one section directory and its
name matches the referenced section number (e.g. full(4)).
It appears that parentheses had exclusively been used for
fetching <cword> ever since vim-6-0k (Oct. 2000) and until
recently, when at f269ea (see #11244) similar changes were
applied, but summarily dismissed at 71badf with a comment
referencing dist#man#PreGetPage().
And you don't get to see signal(7) anyway with the proposed
changes for the above Vim command, because any parenthesis
now belongs to \k, so K would try looking for signal(7))
(note the extra closing parenthesis). Also, with K you
can't follow a reference that terminates in a hyphen-minus
or a hyphen; that is, split between two lines.
Anyway, you need to run the changes by the maintainers:
@goweol, @lifecrisis.
—
Reply to this email directly, view it on GitHub.
You are receiving this because you are subscribed to this thread.
Ivan Shapovalov
And you don't get to see signal(7) anyway with the proposed
changes for the above Vim command, because any parenthesis
now belongs to \k, so K would try looking for signal(7))
(note the extra closing parenthesis). Also, with K you
can't follow a reference that terminates in a hyphen-minus
or a hyphen; that is, split between two lines.
Yes, that is true. The custom <Leader>K mapping man.vim defines is more powerful than the built-in K functionality, where the latter does have limitations as you describe. But I think there is perhaps still value to making it work OOTB-ish?
—
Reply to this email directly, view it on GitHub.
You are receiving this because you are subscribed to this thread.
D. Ben Knoble
I expect the modifiers support would be welcome, but the parentheses bit seems controversial.
—
Reply to this email directly, view it on GitHub.
You are receiving this because you are subscribed to this thread.
Aliaksei Budavei
Further observations.
The current execution of K (setl kp=:Man) is aligned with
the Man command invocation when the latter does not take any
section number, e.g. :Man signal, either would pick the same
page; and [count]K is aligned with :Man [section] [page],
e.g. 7K and :Man 7 signal.
Indefinitely adding (,) to &isk would break this symmetry
by rendering K more capable than :Man [page], and it would
also neither make K work nor \K nor C-] to boot on some
references that contain a \k character after the closing
parenthesis, e.g. signal(7)) , signal(7).). If accepted,
this line should also be adapted:
—
Reply to this email directly, view it on GitHub.
You are receiving this because you are subscribed to this thread.