(add skeleton page at suggestion of cicku) |
(Redirect Package Maintainer wiki links to docs.fp.o) |
||
| (One intermediate revision by one other user not shown) | |||
| Line 3: | Line 3: | ||
== Package Naming == | == Package Naming == | ||
Names of packages which extend vim, such as plugins and syntax highlighting descriptions, must be prefix with "vim-". Examples: | |||
* vim-gtk-syntax (even though the upstream tarball is named gtk-vim-syntax) | * vim-gtk-syntax (even though the upstream tarball is named gtk-vim-syntax) | ||
* vim-halibut | |||
* vim-latex | |||
* … | * … | ||
== Directory Owership == | == Directory Owership == | ||
If the extension installs files into directories owned by the vim-filesystem package, it should add a Requires on vim-filesystem, and not own those directories. The directories in the filesystem package are currently: | |||
* %{_datadir}/vim/vimfiles | |||
* %{_datadir}/vim/vimfiles/after | |||
* %{_datadir}/vim/vimfiles/autoload | |||
* %{_datadir}/vim/vimfiles/colors | |||
* %{_datadir}/vim/vimfiles/compiler | |||
* %{_datadir}/vim/vimfiles/doc | |||
* %{_datadir}/vim/vimfiles/ftdetect | |||
* %{_datadir}/vim/vimfiles/ftplugin | |||
* %{_datadir}/vim/vimfiles/indent | |||
* %{_datadir}/vim/vimfiles/keymap | |||
* %{_datadir}/vim/vimfiles/lang | |||
* %{_datadir}/vim/vimfiles/plugin | |||
* %{_datadir}/vim/vimfiles/print | |||
* %{_datadir}/vim/vimfiles/spell | |||
* %{_datadir}/vim/vimfiles/syntax | |||
* %{_datadir}/vim/vimfiles/tutor | |||
== URL tag == | == URL tag == | ||
| Line 16: | Line 35: | ||
If the package is hosted at http://www.vim.org/scripts/ then use its page there as the URL. | If the package is hosted at http://www.vim.org/scripts/ then use its page there as the URL. | ||
== | == Upstream Release Monitoring == | ||
If the extension is downloaded from http://www.vim.org/scripts/ then it is very difficult to use upstream release monitoring with the provided URLs, especially if the release tarballs are unversioned. A good alternative is to use the http://vim-scripts.org/ "mirror" at github instead. Example: | If the extension is downloaded from http://www.vim.org/scripts/ then it is very difficult to use [https://docs.fedoraproject.org/en-US/package-maintainers/Upstream_Release_Monitoring/ upstream release monitoring] with the provided URLs, especially if the release tarballs are unversioned. A good alternative is to use the http://vim-scripts.org/ "mirror" at github instead. Example match: | ||
vim-gtk-syntax GITHUB-TAGS GITHUB-TAGS:vim-scripts/gtk-vim-syntax | vim-gtk-syntax GITHUB-TAGS GITHUB-TAGS:vim-scripts/gtk-vim-syntax | ||
Latest revision as of 20:37, 2 October 2021
This document seeks to document the conventions and customs surrounding the proper packaging of vim extensions in Fedora.
Package Naming
Names of packages which extend vim, such as plugins and syntax highlighting descriptions, must be prefix with "vim-". Examples:
- vim-gtk-syntax (even though the upstream tarball is named gtk-vim-syntax)
- vim-halibut
- vim-latex
- …
Directory Owership
If the extension installs files into directories owned by the vim-filesystem package, it should add a Requires on vim-filesystem, and not own those directories. The directories in the filesystem package are currently:
- %{_datadir}/vim/vimfiles
- %{_datadir}/vim/vimfiles/after
- %{_datadir}/vim/vimfiles/autoload
- %{_datadir}/vim/vimfiles/colors
- %{_datadir}/vim/vimfiles/compiler
- %{_datadir}/vim/vimfiles/doc
- %{_datadir}/vim/vimfiles/ftdetect
- %{_datadir}/vim/vimfiles/ftplugin
- %{_datadir}/vim/vimfiles/indent
- %{_datadir}/vim/vimfiles/keymap
- %{_datadir}/vim/vimfiles/lang
- %{_datadir}/vim/vimfiles/plugin
- %{_datadir}/vim/vimfiles/print
- %{_datadir}/vim/vimfiles/spell
- %{_datadir}/vim/vimfiles/syntax
- %{_datadir}/vim/vimfiles/tutor
URL tag
If the package is hosted at http://www.vim.org/scripts/ then use its page there as the URL.
Upstream Release Monitoring
If the extension is downloaded from http://www.vim.org/scripts/ then it is very difficult to use upstream release monitoring with the provided URLs, especially if the release tarballs are unversioned. A good alternative is to use the http://vim-scripts.org/ "mirror" at github instead. Example match:
vim-gtk-syntax GITHUB-TAGS GITHUB-TAGS:vim-scripts/gtk-vim-syntax