vim-spell.eclass – Gentoo Development Guide

Name

vim-spell.eclass -- Eclass for managing Vim spell files.

Description

How to make a vim spell file package using prebuilt spell lists from upstream (${CODE} is the language's two letter code):

Get the ${CODE}.*.spl, ${CODE}.*.sug (if your language has them) and README_${CODE}.txt files. Currently they're at ftp://ftp.vim.org/pub/vim/unstable/runtime/spell/ (except for English, which should be taken from CVS instead).
Stick them in vim-spell-${CODE}-$(date --iso | tr -d - ).tar.bz2 . Make sure that they're in the appropriately named subdirectory to avoid having to mess with S=.
Upload the tarball to the Gentoo mirrors.
Add your spell file to package.mask next to the other vim things. Vim Project members will handle unmasking your spell packages when vim comes out of package.mask.
Create the app-vim/vim-spell-${CODE} package. You should base your ebuild upon app-vim/vim-spell-en. You will need to change VIM_SPELL_LANGUAGE, KEYWORDS and LICENSE. Check the license carefully! The README will tell you what it is.

Don't forget metadata.xml. You should list the Vim project and yourself as maintainers. There is no need to join the Vim project just for spell files. Here's an example of a metadata.xml file:

              <?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE pkgmetadata SYSTEM "https://www.gentoo.org/dtd/metadata.dtd">
<pkgmetadata>
              
Warning:
                Unexpected indentation.
              
                              
                  <maintainer type="person">
                  
                    <email>your@email.tld</email>
<name>Your Name</name>
                  
                
                
Warning:
                  Definition list ends without a blank line; unexpected unindent.
                
                </maintainer>
<maintainer type="project">
                
Warning:
                  Unexpected indentation.
                
                                  <email>vim@gentoo.org</email>
<name>Vim Maintainers</name>
                
                
Warning:
                  Block quote ends without a blank line; unexpected unindent.
                
                </maintainer>
                                  
                    <longdescription lang="en">
                    
                      Vim spell files for French (fr). Supported character sets are
UTF-8 and latin1.
                    
                  
                  
Warning:
                    Definition list ends without a blank line; unexpected unindent.
                  
                  </longdescription>
                
              
              
Warning:
                Block quote ends without a blank line; unexpected unindent.
              
              </pkgmetadata>

Send an email to vim@gentoo.org to let us know.

Don't forget to update your package as necessary.

If there isn't an upstream-provided pregenerated spell file for your language yet, read :help spell.txt from inside vim for instructions on how to create spell files. It's best to let upstream know if you've generated spell files for another language rather than keeping them Gentoo-specific.

Supported EAPIs

6 7

Exported Phases

pkg_postinst
src_install

Functions

vim-spell_src_install: This function installs Vim spell files.
vim-spell_pkg_postinst: This function displays installed Vim spell files.

Variables

VIM_SPELL_LANGUAGE ?= "English": This variable defines the language for the spell package being installed. The default value is "English".
DESCRIPTION ?= "vim spell files: ${VIM_SPELL_LANGUAGE} (${VIM_SPELL_LOCALE})": This variable defines the DESCRIPTION for Vim spell ebuilds.
HOMEPAGE ?= "https://www.vim.org": This variable defines the HOMEPAGE for Vim spell ebuilds.

Authors

Ciaran McCreesh <ciaranm@gentoo.org>

Maintainers

Vim Maintainers <vim@gentoo.org>

Reporting Bugs

Please report bugs via https://bugs.gentoo.org/