Gentoo Archives: gentoo-commits

From: Patrice Clement <monsieurp@g.o>
To: gentoo-commits@l.g.o
Subject: [gentoo-commits] repo/gentoo:master commit in: eclass/
Date: Sun, 03 Sep 2017 21:47:36
Message-Id: 1504475246.8061fdcd76edb8f51819a8b6222848a5a215523a.monsieurp@gentoo
1 commit: 8061fdcd76edb8f51819a8b6222848a5a215523a
2 Author: Patrice Clement <monsieurp <AT> gentoo <DOT> org>
3 AuthorDate: Sat Aug 19 10:37:57 2017 +0000
4 Commit: Patrice Clement <monsieurp <AT> gentoo <DOT> org>
5 CommitDate: Sun Sep 3 21:47:26 2017 +0000
6 URL: https://gitweb.gentoo.org/repo/gentoo.git/commit/?id=8061fdcd
7
8 vim-spell.eclass: document functions using Gentoo documentation tags.
9
10 eclass/vim-spell.eclass | 29 ++++++++++++++++++-----------
11 1 file changed, 18 insertions(+), 11 deletions(-)
12
13 diff --git a/eclass/vim-spell.eclass b/eclass/vim-spell.eclass
14 index 0a3ef952a87..1b0f93c264d 100644
15 --- a/eclass/vim-spell.eclass
16 +++ b/eclass/vim-spell.eclass
17 @@ -1,12 +1,13 @@
18 -# Copyright 1999-2011 Gentoo Foundation
19 +# Copyright 1999-2017 Gentoo Foundation
20 # Distributed under the terms of the GNU General Public License v2
21
22 -#
23 -# Original Author: Ciaran McCreesh <ciaranm@g.o>
24 -# Maintainers: Vim Herd <vim@g.o>
25 -# Purpose: Simplify installing spell files for vim7
26 -#
27 -
28 +# @ECLASS: vim-spell.eclass
29 +# @MAINTAINER:
30 +# Vim Maintainers <vim@g.o>
31 +# @AUTHOR:
32 +# Ciaran McCreesh <ciaranm@g.o>
33 +# @BLURB: Eclass for managing Vim spell files.
34 +# @DESCRIPTION:
35 # How to make a vim spell file package using prebuilt spell lists
36 # from upstream (${CODE} is the language's two letter code):
37 #
38 @@ -21,9 +22,9 @@
39 #
40 # * Upload the tarball to the Gentoo mirrors.
41 #
42 -# * (for now) Add your spell file to package.mask next to the other vim7
43 -# things. The vim herd will handle unmasking your spell packages when vim7
44 -# comes out of package.mask.
45 +# * Add your spell file to package.mask next to the other vim things. Vim
46 +# Project members will handle unmasking your spell packages when vim comes out
47 +# of package.mask.
48 #
49 # * Create the app-vim/vim-spell-${CODE} package. You should base your ebuild
50 # upon app-vim/vim-spell-en. You will need to change VIM_SPELL_LANGUAGE,
51 @@ -52,7 +53,7 @@
52 # Don't forget to update your package as necessary.
53 #
54 # If there isn't an upstream-provided pregenerated spell file for your language
55 -# yet, read :help spell.txt from inside vim7 for instructions on how to create
56 +# yet, read :help spell.txt from inside vim for instructions on how to create
57 # spell files. It's best to let upstream know if you've generated spell files
58 # for another language rather than keeping them Gentoo-specific.
59
60 @@ -77,6 +78,9 @@ if [[ -z "${HOMEPAGE}" ]] ; then
61 HOMEPAGE="http://www.vim.org/"
62 fi
63
64 +# @FUNCTION: vim-spell_src_install
65 +# @DESCRIPTION:
66 +# Install Vim spell files.
67 vim-spell_src_install() {
68 target="/usr/share/vim/vimfiles/spell/"
69 dodir "${target}"
70 @@ -103,6 +107,9 @@ vim-spell_src_install() {
71 [[ -z "${had_spell_file}" ]] && die "Didn't install any spell files?"
72 }
73
74 +# @FUNCTION: vim-spell_pkg_postinst
75 +# @DESCRIPTION:
76 +# Display installed Vim spell files.
77 vim-spell_pkg_postinst() {
78 has "${EAPI:-0}" 0 1 2 && ! use prefix && EROOT="${ROOT}"
79 target="/usr/share/vim/vimfiles/spell/"