Gitiles
Code Review Sign In
gerrit.omnirom.org / android_external_vim / 4c3616d7a2c8c3b828e4d4ebbcd43e4a22154262
commit4c3616d7a2c8c3b828e4d4ebbcd43e4a22154262[log] [tgz]
authorShane Harper <shane@shaneharper.net>Mon Jul 22 20:09:26 2024 +0200
committerChristian Brabandt <cb@256bit.org>Mon Jul 22 20:09:26 2024 +0200
tree3e78df6a3b691c247b6a1e5bfc524cef3dbb8b7f
parent6e37575760022be047cad0e1cf1e30c18fab21ad [diff]
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>
3 files changed
tree: 3e78df6a3b691c247b6a1e5bfc524cef3dbb8b7f
  1. .github/
  2. ci/
  3. nsis/
  4. pixmaps/
  5. READMEdir/
  6. runtime/
  7. src/
  8. tools/
  9. .appveyor.yml
  10. .cirrus.yml
  11. .codecov.yml
  12. .gitattributes
  13. .gitignore
  14. .hgignore
  15. configure
  16. CONTRIBUTING.md
  17. Filelist
  18. LICENSE
  19. Makefile
  20. README.md
  21. README.rux.txt
  22. README.txt
  23. README_VIM9.md
  24. SECURITY.md
  25. uninstall.txt
  26. vimtutor.bat
  27. vimtutor.com
README.md

Vim The editor

Github Build status Appveyor Build status Cirrus Build Status Coverage Status Coverity Scan Debian CI Packages Fossies codespell report

If you find a bug or want to discuss the best way to add a new feature, please open an issue. If you have a question or want to discuss the best way to do something with Vim, you can use StackExchange or one of the Maillists.

What is Vim?

Vim is a greatly improved version of the good old UNIX editor Vi. Many new features have been added: multi-level undo, syntax highlighting, command line history, on-line help, spell checking, filename completion, block operations, script language, etc. There is also a Graphical User Interface (GUI) available. Still, Vi compatibility is maintained, those who have Vi "in the fingers" will feel at home. See runtime/doc/vi_diff.txt for differences with Vi.

This editor is very useful for editing programs and other plain text files. All commands are given with normal keyboard characters, so those who can type with ten fingers can work very fast. Additionally, function keys can be mapped to commands by the user, and the mouse can be used.

Vim runs under MS-Windows (7, 8, 10, 11), macOS, Haiku, VMS and almost all flavours of UNIX. Porting to other systems should not be very difficult. Older versions of Vim run on MS-DOS, MS-Windows 95/98/Me/NT/2000/XP/Vista, Amiga DOS, Atari MiNT, BeOS, RISC OS and OS/2. These are no longer maintained.

For Vim9 script see README_VIM9.

Distribution

You can often use your favorite package manager to install Vim. On Mac and Linux a small version of Vim is pre-installed, you still need to install Vim if you want more features.

There are separate distributions for Unix, PC, Amiga and some other systems. This README.md file comes with the runtime archive. It includes the documentation, syntax files and other files that are used at runtime. To run Vim you must get either one of the binary archives or a source archive. Which one you need depends on the system you want to run it on and whether you want or must compile it yourself. Check https://www.vim.org/download.php for an overview of currently available distributions.

Some popular places to get the latest Vim:

Compiling

If you obtained a binary distribution you don't need to compile Vim. If you obtained a source distribution, all the stuff for compiling Vim is in the src directory. See src/INSTALL for instructions.

Installation

See one of these files for system-specific instructions. Either in the READMEdir directory (in the repository) or the top directory (if you unpack an archive):

README_ami.txt		Amiga
README_unix.txt		Unix
README_dos.txt		MS-DOS and MS-Windows
README_mac.txt		Macintosh
README_haiku.txt	Haiku
README_vms.txt		VMS

There are other README_*.txt files, depending on the distribution you used.

Documentation

The Vim tutor is a one hour training course for beginners. Often it can be started as vimtutor. See :help tutor for more information.

The best is to use :help in Vim. If you don't have an executable yet, read runtime/doc/help.txt. It contains pointers to the other documentation files. The User Manual reads like a book and is recommended to learn to use Vim. See :help user-manual.

Copying

Vim is Charityware. You can use and copy it as much as you like, but you are encouraged to make a donation to help orphans in Uganda. Please read the file runtime/doc/uganda.txt for details (do :help uganda inside Vim).

Summary of the license: There are no restrictions on using or distributing an unmodified copy of Vim. Parts of Vim may also be distributed, but the license text must always be included. For modified versions, a few restrictions apply. The license is GPL compatible, you may compile Vim with GPL libraries and distribute it.

Sponsoring

Fixing bugs and adding new features takes a lot of time and effort. To show your appreciation for the work and motivate developers to continue working on Vim please send a donation.

The money you donated will be mainly used to help children in Uganda. See runtime/doc/uganda.txt. But at the same time donations increase the development team motivation to keep working on Vim!

For the most recent information about sponsoring look on the Vim web site: https://www.vim.org/sponsor/

Contributing

If you would like to help make Vim better, see the CONTRIBUTING.md file.

Information

If you are on macOS, you can use MacVim.

The latest news about Vim can be found on the Vim home page: https://www.vim.org/

If you have problems, have a look at the Vim documentation or tips: https://www.vim.org/docs.php https://vim.fandom.com/wiki/Vim_Tips_Wiki

If you still have problems or any other questions, use one of the mailing lists to discuss them with Vim users and developers: https://www.vim.org/maillist.php

If nothing else works, report bugs directly to the vim-dev mailing list: <vim-dev@vim.org>

Main author

Most of Vim was created by Bram Moolenaar <Bram@vim.org> Bram-Moolenaar

Send any other comments, patches, flowers and suggestions to the vim-dev mailing list: <vim-dev@vim.org>

This is README.md for version 9.1 of Vim: Vi IMproved.