[vim/vim] Unified spellings "VIM" to "Vim" and "GVIM" or "Gvim" or "gVim" to "gvim" in help documents (#1733)

73 views
Skip to first unread message

Tatsuki

unread,
May 29, 2017, 8:59:13 AM5/29/17
to vim/vim, Subscribed

Unified spellings "VIM" to "Vim" and "GVIM" or "Gvim" or "gVim" to "gvim" in help documents.


You can view, comment on, or merge this pull request online at:

  https://github.com/vim/vim/pull/1733

Commit Summary

  • Change spelling VIM to Vim and GVIM or Gvim or gVim to gvim

File Changes

Patch Links:


You are receiving this because you are subscribed to this thread.
Reply to this email directly, view it on GitHub

Codecov

unread,
May 29, 2017, 9:21:52 AM5/29/17
to vim/vim, Subscribed

Codecov Report

Merging #1733 into master will increase coverage by 6.81%.
The diff coverage is n/a.

Impacted file tree graph

@@            Coverage Diff             @@
##           master    #1733      +/-   ##
==========================================
+ Coverage   68.21%   75.02%   +6.81%     
==========================================
  Files          76       76              
  Lines      124299   124948     +649     
==========================================
+ Hits        84788    93743    +8955     
+ Misses      39511    31205    -8306
Impacted Files Coverage Δ
src/if_lua.c 50.88% <0%> (+0.65%) ⬆️
src/if_python3.c 77.37% <0%> (+1.32%) ⬆️
src/if_perl.xs 86.41% <0%> (+1.44%) ⬆️
src/if_py_both.h 76.01% <0%> (+1.89%) ⬆️
src/if_python.c 78.9% <0%> (+1.95%) ⬆️
src/main.c 55.13% <0%> (+2.18%) ⬆️
src/gui_gtk.c 24.81% <0%> (+2.3%) ⬆️
src/netbeans.c 27.1% <0%> (+2.53%) ⬆️
src/if_ruby.c 56.21% <0%> (+2.57%) ⬆️
src/farsi.c 59.32% <0%> (+3.38%) ⬆️
... and 62 more

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 6e62da3...510abd6. Read the comment docs.

Dominique Pellé

unread,
May 29, 2017, 11:27:02 AM5/29/17
to vim/vim, Subscribed

@dpelle commented on this pull request.


In runtime/doc/quotes.txt:

> @@ -18,7 +18,7 @@ Coming with a very GUI mindset from Windows, I always thought of people using
 Vi as some kind of outer space alien in human clothes.  Once I tried I really
 got addicted by its power and now I found myself typing Vim keypresses in the
 oddest places! That's why I would like to see Vim embedded in every
-application which deals with text editing.  (Jos� Fonseca)
+application which deals with text editing.  (Jos� Fonseca)

Did you change the encoding of the file?

It encoded in latin1 in Vim git repo. I don't think that changing encoding should be done as part of this change.


In runtime/doc/editing.txt:

> @@ -1040,7 +1040,7 @@ if the system allows it (the directory must be writable).
 							*write-fail*
 If the writing of the new file fails, you have to be careful not to lose
 your changes AND the original file.  If there is no backup file and writing
-the new file failed, you have already lost the original file!  DON'T EXIT VIM
+the new file failed, you have already lost the original file!  DON'T EXIT Vim

In contexts where the sentence is all upper-case, I think it's better to write VIM uppper-case too.


In runtime/doc/editing.txt:

> @@ -1455,7 +1455,7 @@ Do this before writing the file.  When reading an encrypted file it will be
 set automatically to the method used when that file was written.  You can
 change 'cryptmethod' before writing that file to change the method.
 
-To set the default method, used for new files, use this in your |vimrc| 
+To set the default method, used for new files, use this in your |vimrc|

I would not remove trailing spaces as part of this change, it's causing many changes unrelated to unifying spelling of Vim.


You are receiving this because you are subscribed to this thread.

Reply to this email directly, view it on GitHub, or mute the thread.

h_east

unread,
May 29, 2017, 11:40:09 AM5/29/17
to vim_dev, v...@noreply.github.com, subsc...@noreply.github.com, reply+00b1d19876593da137ebb9408684a89387ea274...@reply.github.com, vim-dev...@256bit.org
Hi Katsuki,

`Vim` agrees. But why `gvim`?

--
Best regards,
Hirohito Higashi (h_east)

vim-dev ML

unread,
May 29, 2017, 11:40:37 AM5/29/17
to vim/vim, vim-dev ML, Your activity

Tatsuki

unread,
May 29, 2017, 12:19:29 PM5/29/17
to vim/vim, vim-dev ML, Comment

Because I heard it on issue #1733

At the sadly neglected Vim wiki, we chose "Vim" and "gvim" despite the inconsistency. The "Vim" spelling fits modern usage such as in "Python" and many other packages. But then "Gvim" is rather weird, and "gVim" is very weird.


You are receiving this because you commented.

Tatsuki

unread,
May 29, 2017, 12:23:59 PM5/29/17
to vim/vim, vim-dev ML, Push

@Tatsuki-I pushed 1 commit.


You are receiving this because you are subscribed to this thread.

View it on GitHub

Tatsuki

unread,
May 29, 2017, 12:25:03 PM5/29/17
to vim/vim, vim-dev ML, Comment

@Tatsuki-I commented on this pull request.


In runtime/doc/quotes.txt:

> @@ -18,7 +18,7 @@ Coming with a very GUI mindset from Windows, I always thought of people using
 Vi as some kind of outer space alien in human clothes.  Once I tried I really
 got addicted by its power and now I found myself typing Vim keypresses in the
 oddest places! That's why I would like to see Vim embedded in every
-application which deals with text editing.  (Jos� Fonseca)
+application which deals with text editing.  (Jos� Fonseca)

Sorry, it's my mistake.
I fixed it.


You are receiving this because you commented.

Tatsuki

unread,
May 29, 2017, 12:26:46 PM5/29/17
to vim/vim, vim-dev ML, Comment

@Tatsuki-I commented on this pull request.


In runtime/doc/editing.txt:

> @@ -1040,7 +1040,7 @@ if the system allows it (the directory must be writable).
 							*write-fail*
 If the writing of the new file fails, you have to be careful not to lose
 your changes AND the original file.  If there is no backup file and writing
-the new file failed, you have already lost the original file!  DON'T EXIT VIM
+the new file failed, you have already lost the original file!  DON'T EXIT Vim

I see.
I'll fix them.


You are receiving this because you commented.

Tatsuki

unread,
May 29, 2017, 12:28:29 PM5/29/17
to vim/vim, vim-dev ML, Push

@Tatsuki-I pushed 1 commit.


You are receiving this because you are subscribed to this thread.

View it on GitHub

Tatsuki

unread,
May 29, 2017, 12:29:49 PM5/29/17
to vim/vim, vim-dev ML, Push

@Tatsuki-I pushed 1 commit.


You are receiving this because you are subscribed to this thread.

View it on GitHub

Tatsuki

unread,
May 29, 2017, 12:30:08 PM5/29/17
to vim/vim, vim-dev ML, Push

@Tatsuki-I pushed 1 commit.


You are receiving this because you are subscribed to this thread.

View it on GitHub

Tatsuki

unread,
May 29, 2017, 12:30:47 PM5/29/17
to vim/vim, vim-dev ML, Push

@Tatsuki-I pushed 1 commit.


You are receiving this because you are subscribed to this thread.

View it on GitHub

Tatsuki

unread,
May 29, 2017, 12:31:21 PM5/29/17
to vim/vim, vim-dev ML, Push

@Tatsuki-I pushed 1 commit.


You are receiving this because you are subscribed to this thread.

View it on GitHub

Tatsuki

unread,
May 29, 2017, 12:33:33 PM5/29/17
to vim/vim, vim-dev ML, Comment

@Tatsuki-I commented on this pull request.


In runtime/doc/editing.txt:

> @@ -1455,7 +1455,7 @@ Do this before writing the file.  When reading an encrypted file it will be
 set automatically to the method used when that file was written.  You can
 change 'cryptmethod' before writing that file to change the method.
 
-To set the default method, used for new files, use this in your |vimrc| 
+To set the default method, used for new files, use this in your |vimrc|

Sorry...
I'll fix them.


You are receiving this because you commented.

K.Takata

unread,
May 29, 2017, 12:48:32 PM5/29/17
to vim/vim, vim-dev ML, Comment

@k-takata commented on this pull request.

I also agree to change "VIM" to "Vim", but I don't think there is a consensus about "gvim".


In runtime/doc/mbyte.txt:

> @@ -1328,7 +1328,7 @@ Useful commands:
   to automatically detect the encoding of a file.
 
 
-STARTING VIM
+STARTING Vim

This should be "VIM".


In runtime/doc/quotes.txt:

> @@ -63,53 +63,53 @@ versions of 'emacs' in the late 1970's and was relieved by finding 'vi' in the
 first UNIX I came across in 1983).  In my opinion, it's about time 'VIM'
 replace 'emacs' as the standard for top editors.  (Bo Thide', Sweden)
 
-I love and use VIM heavily too.  (Larry Wall)
+I love and use Vim heavily too.  (Larry Wall)

This file is quotation. Should not be changed.


In runtime/doc/gui_w32.txt:

> @@ -383,7 +383,7 @@ Note that a menu that starts with ']' will not be displayed.
 7. Command line arguments				*gui-w32-cmdargs*
 
 Analysis of a command line into parameters is not standardised in MS Windows.
-Gvim has to provide logic to analyse a command line.  This logic is likely to
+gvim has to provide logic to analyse a command line.  This logic is likely to

I'm not English native, so I'm afraid that I'm saying something wrong, but starting a sentence with a lower case might be unnatural.


In runtime/doc/gui_w32.txt:

> @@ -472,7 +472,7 @@ with the Intellimouse driver 2.2 and when "Universal Scrolling" is turned on.
 
 XPM support						*w32-xpm-support*
 
-Gvim can be build on MS-Windows with support for XPM files.  |+xpm_w32|
+gvim can be build on MS-Windows with support for XPM files.  |+xpm_w32|

Start of a sentence.


In runtime/doc/sponsor.txt:

> @@ -5,7 +5,7 @@
 
 
 
-SPONSOR VIM DEVELOPMENT						*sponsor*
+SPONSOR Vim DEVELOPMENT						*sponsor*

This breaks highlight. Should be upper case.


In runtime/doc/usr_09.txt:

> @@ -5,7 +5,7 @@
 				Using the GUI
 
 
-Vim works in an ordinary terminal.  GVim can do the same things and a few
+Vim works in an ordinary terminal.  gvim can do the same things and a few

Start of a sentence.


You are receiving this because you commented.

Bram Moolenaar

unread,
May 29, 2017, 1:59:00 PM5/29/17
to vim...@googlegroups.com, Tatsuki, vim/vim, Comment

> Because I heard it on issue #1733
> > At the sadly neglected Vim wiki, we chose "Vim" and "gvim" despite
> > the inconsistency. The "Vim" spelling fits modern usage such as in
> > "Python" and many other packages. But then "Gvim" is rather weird,
> > and "gVim" is very weird.

While "Vim" is a name, "gvim" is a command. Vim can also be a command,
thus then it's written as "vim". Depends on the context.

I agree that "Gvim" and "gVim" are a bit strange. "GVim" is weird.
Just using "gvim" seems best.

--
Never under any circumstances take a sleeping pill
and a laxative on the same night.

/// Bram Moolenaar -- Br...@Moolenaar.net -- http://www.Moolenaar.net \\\
/// sponsor Vim, vote for features -- http://www.Vim.org/sponsor/ \\\
\\\ an exciting new programming language -- http://www.Zimbu.org ///
\\\ help me help AIDS victims -- http://ICCF-Holland.org ///

Kazunobu Kuriyama

unread,
May 30, 2017, 3:00:13 AM5/30/17
to vim...@googlegroups.com
2017-05-30 2:58 GMT+09:00 Bram Moolenaar <Br...@moolenaar.net>:

> Because I heard it on issue #1733
> > At the sadly neglected Vim wiki, we chose "Vim" and "gvim" despite
> > the inconsistency. The "Vim" spelling fits modern usage such as in
> > "Python" and many other packages. But then "Gvim" is rather weird,
> > and "gVim" is very weird.

While "Vim" is a name, "gvim" is a command.  Vim can also be a command,
thus then it's written as "vim".  Depends on the context.

I do think proper use of capitalization that depends on the context is much more important than unification in appearance attained by context-free substitution.


I agree that "Gvim" and "gVim" are a bit strange.  "GVim" is weird.
Just using "gvim" seems best.

That's quite understandable.  But then, what should we do with the all lower case "gvim" when we need to write a sentence beginning with the word spelled that way, or when we need to include it in the title of an article?

For those cases, no matter how weird it looks, I even think "GVim" is suitable; in addition to making the initial "g" capital as per English orthography, the capitalization of the second letter "v" would clearly show what the word stems from (i.e., GVim is Vim);  the succession of the two different capital letters G and V could be helpful to distinguish "gvim" from words such as gnome or gnu in pronunciation (i.e., GVim never appears to be pronounced the same way as Vim).

Probably, what we need while we are at this issue would be not to specify things helpful to write down regular expressions to have a unified spelling for "gvim" in the documents but to establish a style guide for authors and contributors who want to refer to Vim that is built with a dedicated graphical user interface, with a concise way in their document.

I wrote a bit my view on the capitalization of the word "gvim", but the point does not lie in its form "GVim."  Actually I'm open to any form of capitalization as long as authors and contributors won't be puzzled at it when they write a sentence beginning with 'gvim'.  That's the point.  Even "Gvim" is okay to me since it is the class name of GUI Vim instances running on X11 (= value of a property known as WM_CLASS which is to be registered at startup for inter-cllient communication between X11 clients, in particular the window manager on one end).

Best regards,
Kazunobu Kuriyama

--
Never under any circumstances take a sleeping pill
and a laxative on the same night.

 /// Bram Moolenaar -- Br...@Moolenaar.net -- http://www.Moolenaar.net   \\\
///        sponsor Vim, vote for features -- http://www.Vim.org/sponsor/ \\\
\\\  an exciting new programming language -- http://www.Zimbu.org        ///
 \\\            help me help AIDS victims -- http://ICCF-Holland.org    ///

--
--
You received this message from the "vim_dev" maillist.
Do not top-post! Type your reply below the text you are replying to.
For more information, visit http://www.vim.org/maillist.php

---
You received this message because you are subscribed to the Google Groups "vim_dev" group.
To unsubscribe from this group and stop receiving emails from it, send an email to vim_dev+unsubscribe@googlegroups.com.
For more options, visit https://groups.google.com/d/optout.

h_east

unread,
May 30, 2017, 9:41:28 AM5/30/17
to vim_dev, v...@noreply.github.com, vim-dev...@256bit.org, com...@noreply.github.com, reply+00b1d19805fc5e70af824ecbb9609ae41d3a717...@reply.github.com
Hi,

2017-5-30(Tue) 1:19:29 UTC+9 Tatsuki:


> Because I heard it on issue #1733
>
>
> At the sadly neglected Vim wiki, we chose "Vim" and "gvim" despite the inconsistency. The "Vim" spelling fits modern usage such as in "Python" and many other packages. But then "Gvim" is rather weird, and "gVim" is very weird.

Hmm, I couldn't find it on issue #1733.
Please put a link explicitly.

h_east

unread,
May 30, 2017, 9:44:59 AM5/30/17
to vim_dev
Hi Kazunobu and All,

2017-5-30(Tue) 16:00:13 UTC+9 Kazunobu Kuriyama:
> 2017-05-30 2:58 GMT+09:00 Bram Moolenaar <Br...@moolenaar.net>:
>
>
>
>
> > Because I heard it on issue #1733
>
> > > At the sadly neglected Vim wiki, we chose "Vim" and "gvim" despite
>
> > > the inconsistency. The "Vim" spelling fits modern usage such as in
>
> > > "Python" and many other packages. But then "Gvim" is rather weird,
>
> > > and "gVim" is very weird.
>
>
>
> While "Vim" is a name, "gvim" is a command.  Vim can also be a command,
>
> thus then it's written as "vim".  Depends on the context.
>
>
>
> I do think proper use of capitalization that depends on the context is much more important than unification in appearance attained by context-free substitution.
>
>
>
>
> I agree that "Gvim" and "gVim" are a bit strange.  "GVim" is weird.
>
> Just using "gvim" seems best.
>
>
>
> That's quite understandable.  But then, what should we do with the all lower case "gvim" when we need to write a sentence beginning with the word spelled that way, or when we need to include it in the title of an article?
>
>
> For those cases, no matter how weird it looks, I even think "GVim" is suitable; in addition to making the initial "g" capital as per English orthography, the capitalization of the second letter "v" would clearly show what the word stems from (i.e., GVim is Vim);  the succession of the two different capital letters G and V could be helpful to distinguish "gvim" from words such as gnome or gnu in pronunciation (i.e., GVim never appears to be pronounced the same way as Vim).
>
>
> Probably, what we need while we are at this issue would be not to specify things helpful to write down regular expressions to have a unified spelling for "gvim" in the documents but to establish a style guide for authors and contributors who want to refer to Vim that is built with a dedicated graphical user interface, with a concise way in their document.
>
>
> I wrote a bit my view on the capitalization of the word "gvim", but the point does not lie in its form "GVim."  Actually I'm open to any form of capitalization as long as authors and contributors won't be puzzled at it when they write a sentence beginning with 'gvim'.  That's the point.  Even "Gvim" is okay to me since it is the class name of GUI Vim instances running on X11 (= value of a property known as WM_CLASS which is to be registered at startup for inter-cllient communication between X11 clients, in particular the window manager on one end).

+1
I fully approve of your opinion.

K.Takata

unread,
Jun 1, 2017, 3:18:34 PM6/1/17
to vim/vim, vim-dev ML, Comment

Hmm, I couldn't find it on issue #1733.

Should be #1732.


You are receiving this because you commented.

vim-dev ML

unread,
Jun 1, 2017, 3:18:37 PM6/1/17
to vim/vim, vim-dev ML, Your activity
Hi,

2017-5-30(Tue) 1:19:29 UTC+9 Tatsuki:
> Because I heard it on issue #1733
>
>
> At the sadly neglected Vim wiki, we chose "Vim" and "gvim" despite the inconsistency. The "Vim" spelling fits modern usage such as in "Python" and many other packages. But then "Gvim" is rather weird, and "gVim" is very weird.

Hmm, I couldn't find it on issue #1733.
Please put a link explicitly.

--
Best regards,
Hirohito Higashi (h_east)

Charles E Campbell

unread,
Jun 1, 2017, 4:26:44 PM6/1/17
to vim...@googlegroups.com
Tatsuki wrote:
>
> Unified spellings "VIM" to "Vim" and "GVIM" or "Gvim" or "gVim" to
> "gvim" in help documents.
>
> ------------------------------------------------------------------------
>
>
> You can view, comment on, or merge this pull request online at:
>
> https://github.com/vim/vim/pull/1733
>
>
> Commit Summary
>
> * Change spelling VIM to Vim and GVIM or Gvim or gVim to gvim
>
>
> File Changes
>
> * *M* runtime/doc/arabic.txt
> <https://github.com/vim/vim/pull/1733/files#diff-0> (40)
> * *M* runtime/doc/autocmd.txt
> <https://github.com/vim/vim/pull/1733/files#diff-1> (2)
> * *M* runtime/doc/editing.txt
> <https://github.com/vim/vim/pull/1733/files#diff-2> (4)
> * *M* runtime/doc/ft_ada.txt
> <https://github.com/vim/vim/pull/1733/files#diff-3> (2)
> * *M* runtime/doc/gui_w32.txt
> <https://github.com/vim/vim/pull/1733/files#diff-4> (4)
> * *M* runtime/doc/hangulin.txt
> <https://github.com/vim/vim/pull/1733/files#diff-5> (16)
> * *M* runtime/doc/help.txt
> <https://github.com/vim/vim/pull/1733/files#diff-6> (2)
> * *M* runtime/doc/if_ole.txt
> <https://github.com/vim/vim/pull/1733/files#diff-7> (4)
> * *M* runtime/doc/if_perl.txt
> <https://github.com/vim/vim/pull/1733/files#diff-8> (6)
> * *M* runtime/doc/intro.txt
> <https://github.com/vim/vim/pull/1733/files#diff-9> (8)
> * *M* runtime/doc/map.txt
> <https://github.com/vim/vim/pull/1733/files#diff-10> (8)
> * *M* runtime/doc/mbyte.txt
> <https://github.com/vim/vim/pull/1733/files#diff-11> (2)
> * *M* runtime/doc/netbeans.txt
> <https://github.com/vim/vim/pull/1733/files#diff-12> (4)
> * *M* runtime/doc/os_beos.txt
> <https://github.com/vim/vim/pull/1733/files#diff-13> (2)
> * *M* runtime/doc/os_vms.txt
> <https://github.com/vim/vim/pull/1733/files#diff-14> (24)
> * *M* runtime/doc/os_win32.txt
> <https://github.com/vim/vim/pull/1733/files#diff-15> (4)
> * *M* runtime/doc/pi_getscript.txt
> <https://github.com/vim/vim/pull/1733/files#diff-16> (8)
> * *M* runtime/doc/pi_netrw.txt
> <https://github.com/vim/vim/pull/1733/files#diff-17> (4)
> * *M* runtime/doc/print.txt
> <https://github.com/vim/vim/pull/1733/files#diff-18> (64)
> * *M* runtime/doc/quotes.txt
> <https://github.com/vim/vim/pull/1733/files#diff-19> (116)
> * *M* runtime/doc/spell.txt
> <https://github.com/vim/vim/pull/1733/files#diff-20> (22)
> * *M* runtime/doc/sponsor.txt
> <https://github.com/vim/vim/pull/1733/files#diff-21> (4)
> * *M* runtime/doc/usr_02.txt
> <https://github.com/vim/vim/pull/1733/files#diff-22> (2)
> * *M* runtime/doc/usr_08.txt
> <https://github.com/vim/vim/pull/1733/files#diff-23> (4)
> * *M* runtime/doc/usr_09.txt
> <https://github.com/vim/vim/pull/1733/files#diff-24> (6)
> * *M* runtime/doc/usr_21.txt
> <https://github.com/vim/vim/pull/1733/files#diff-25> (4)
> * *M* runtime/doc/usr_31.txt
> <https://github.com/vim/vim/pull/1733/files#diff-26> (2)
> * *M* runtime/doc/version5.txt
> <https://github.com/vim/vim/pull/1733/files#diff-27> (2)
> * *M* runtime/doc/version6.txt
> <https://github.com/vim/vim/pull/1733/files#diff-28> (18)
> * *M* runtime/doc/version7.txt
> <https://github.com/vim/vim/pull/1733/files#diff-29> (122)
>
>
> Patch Links:
>
> * https://github.com/vim/vim/pull/1733.patch
> * https://github.com/vim/vim/pull/1733.diff
>
>
For netrw: all the characters in a subtitle are in caps. DON'T CHANGE
GVIM in such a title to gvim . Please. Similarly, don't change VIM to
Vim in such a title.
Also, you'll find in pi_netrw.txt a usage of GVIM associated with
v:servername. Changing GVIM to gvim would not simply be disconcerting,
it'd be wrong.
The only place where arguably such a change would be acceptable is in
the licensing where it refers to the "VIM LICENSE"; in which case, it
should be "Vim license".

I don't have time to run through all your changes; you need to make sure
you're not messing with VIM or GVIM when it has to do with remote server
names (ex. :he clientserver, then search for "...running GVIM server...".

Regards,
Chip Campbell

cecamp

unread,
Jun 2, 2017, 1:54:34 AM6/2/17
to vim/vim, vim-dev ML, Comment
Tatsuki wrote:
>
> Unified spellings "VIM" to "Vim" and "GVIM" or "Gvim" or "gVim" to
> "gvim" in help documents.
>
> ------------------------------------------------------------------------

>
> * *M* runtime/doc/pi_getscript.txt
> <https://github.com/vim/vim/pull/1733/files#diff-16> (8)
> * *M* runtime/doc/pi_netrw.txt
> <https://github.com/vim/vim/pull/1733/files#diff-17> (4)
>
(looks like a response I gave earlier did not show up, so I'll try again)

Please do not change VIM and GVIM in the various subtitles in
pi_netrw.txt or pi_getscript.txt. I have subtitles as all uppercase.
Please do not change VIM or GVIM when referring to clientserver names
(that applies to pi_netrw.txt, and probably elsewhere). (see :he
netrw-P20). Such changes would be incorrect and not just an aesthetic
issue.

Regards,
Chip Campbell


You are receiving this because you commented.

Reply all
Reply to author
Forward
0 new messages