Mercurial > vim
view runtime/doc/vimtutor.1 @ 35769:4f48d5d327ea v9.1.0609
patch 9.1.0609: outdated comments in Makefile
Commit: https://github.com/vim/vim/commit/4c3616d7a2c8c3b828e4d4ebbcd43e4a22154262
Author: Shane Harper <shane@shaneharper.net>
Date: Mon Jul 22 20:09:26 2024 +0200
patch 9.1.0609: outdated comments in Makefile
Problem: outdated comments in Makefile
Solution: update outdated comments, update rule for vimtags
(Shane Harper)
related: commit b81109192f
Here are the changes and the reasons for them:
- Delete the comment preceding the assignment to VIMPROG. Since b81109192f
there's no need for VIMPROG to be set to something else when this is executed
from src/Makefile. (The comment was wrong anyway; VIMPROG was being set to
"$$BUILD_DIR/$(VIMTARGET)".)
```
# Set to $(VIMTARGET) when executed from src/Makefile.
VIMPROG = ../../src/vim
```
- Delete "`and installed`" in the following comment; The vimtags rule doesn't
require that Vim has been installed.
```
# Use Vim to generate the tags file. Can only be used when Vim has been
# compiled and installed. Supports multiple languages.
vimtags: $(DOCS)
```
- With commit b81109192f there is no longer a need to set VIMPROG here:
```
-@BUILD_DIR="`pwd`"; cd $(HELPSOURCE); if test -z "$(CROSS_COMPILING)"; then \
$(MAKE) VIMPROG="$$BUILD_DIR/$(VIMTARGET)" vimtags; fi
```
The new code below will use the same vim executable as the old code:
```
-@cd $(HELPSOURCE); if test -z "$(CROSS_COMPILING)"; then \
$(MAKE) vimtags; fi
```
- Delete the following comment which was related to setting VIMPROG as it no longer has any value:
```
# We can assume Vim was build, but it may not have been installed,
# thus use the executable in the current directory.
```
Note: this comment used to be (unnecessarily) echoed to the terminal (because
it was indented) when making installrtbase.
closes: #15320
Signed-off-by: Shane Harper <shane@shaneharper.net>
Signed-off-by: Christian Brabandt <cb@256bit.org>
author | Christian Brabandt <cb@256bit.org> |
---|---|
date | Mon, 22 Jul 2024 20:30:07 +0200 |
parents | b2e8663e6dcc |
children | 4a958ef2dc5e |
line wrap: on
line source
.TH VIMTUTOR 1 "2001 April 2" .SH NAME vimtutor \- the Vim tutor .SH SYNOPSIS .br .B vimtutor [\-g] [language] .SH DESCRIPTION .B Vimtutor starts the .B Vim tutor. It copies the tutor file first, so that it can be modified without changing the original file. .PP The .B Vimtutor is useful for people that want to learn their first .B Vim commands. .PP The optional argument \-g starts vimtutor with gvim rather than vim, if the GUI version of vim is available, or falls back to Vim if gvim is not found. .PP The optional [language] argument is the two-letter name of a language, like "it" or "es". If the [language] argument is missing, the language of the current locale will be used. If a tutor in this language is available, it will be used. Otherwise the English version will be used. .PP .B Vim is always started in Vi compatible mode. .SH FILES .TP 15 /usr/local/lib/vim/tutor/tutor[.language] The .B Vimtutor text file(s). .TP 15 /usr/local/lib/vim/tutor/tutor.vim The Vim script used to copy the .B Vimtutor text file. .SH AUTHOR The .B Vimtutor was originally written for Vi by Michael C. Pierce and Robert K. Ware, Colorado School of Mines using ideas supplied by Charles Smith, Colorado State University. E-mail: bware@mines.colorado.edu (now invalid). .br It was modified for .B Vim by Bram Moolenaar. For the names of the translators see the tutor files. .SH SEE ALSO vim(1)