From: Patrice Clement <monsieurp@gentoo.org>
To: gentoo-dev@lists.gentoo.org
Cc: vim@gentoo.org
Subject: [gentoo-dev] [PATCH 1/2] vim-spell.eclass: document functions using Gentoo documentation tags.
Date: Sat, 19 Aug 2017 14:53:49 +0200 [thread overview]
Message-ID: <20170819125350.10651-2-monsieurp@gentoo.org> (raw)
In-Reply-To: <20170819125350.10651-1-monsieurp@gentoo.org>
---
eclass/vim-spell.eclass | 29 ++++++++++++++++++-----------
1 file changed, 18 insertions(+), 11 deletions(-)
diff --git a/eclass/vim-spell.eclass b/eclass/vim-spell.eclass
index 0a3ef952a87..1b0f93c264d 100644
--- a/eclass/vim-spell.eclass
+++ b/eclass/vim-spell.eclass
@@ -1,12 +1,13 @@
-# Copyright 1999-2011 Gentoo Foundation
+# Copyright 1999-2017 Gentoo Foundation
# Distributed under the terms of the GNU General Public License v2
-#
-# Original Author: Ciaran McCreesh <ciaranm@gentoo.org>
-# Maintainers: Vim Herd <vim@gentoo.org>
-# Purpose: Simplify installing spell files for vim7
-#
-
+# @ECLASS: vim-spell.eclass
+# @MAINTAINER:
+# Vim Maintainers <vim@gentoo.org>
+# @AUTHOR:
+# Ciaran McCreesh <ciaranm@gentoo.org>
+# @BLURB: 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):
#
@@ -21,9 +22,9 @@
#
# * Upload the tarball to the Gentoo mirrors.
#
-# * (for now) Add your spell file to package.mask next to the other vim7
-# things. The vim herd will handle unmasking your spell packages when vim7
-# comes out of package.mask.
+# * 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,
@@ -52,7 +53,7 @@
# 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 vim7 for instructions on how to create
+# 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.
@@ -77,6 +78,9 @@ if [[ -z "${HOMEPAGE}" ]] ; then
HOMEPAGE="http://www.vim.org/"
fi
+# @FUNCTION: vim-spell_src_install
+# @DESCRIPTION:
+# Install Vim spell files.
vim-spell_src_install() {
target="/usr/share/vim/vimfiles/spell/"
dodir "${target}"
@@ -103,6 +107,9 @@ vim-spell_src_install() {
[[ -z "${had_spell_file}" ]] && die "Didn't install any spell files?"
}
+# @FUNCTION: vim-spell_pkg_postinst
+# @DESCRIPTION:
+# Display installed Vim spell files.
vim-spell_pkg_postinst() {
has "${EAPI:-0}" 0 1 2 && ! use prefix && EROOT="${ROOT}"
target="/usr/share/vim/vimfiles/spell/"
--
2.13.0
next prev parent reply other threads:[~2017-08-19 12:54 UTC|newest]
Thread overview: 4+ messages / expand[flat|nested] mbox.gz Atom feed top
2017-08-19 12:53 [gentoo-dev] [PATCH 0/2] vim-spell.eclass: improvements Patrice Clement
2017-08-19 12:53 ` Patrice Clement [this message]
2017-08-19 12:53 ` [gentoo-dev] [PATCH 2/2] vim-spell.eclass: document variables using Gentoo documentation tags Patrice Clement
2017-08-19 18:14 ` Michał Górny
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20170819125350.10651-2-monsieurp@gentoo.org \
--to=monsieurp@gentoo.org \
--cc=gentoo-dev@lists.gentoo.org \
--cc=vim@gentoo.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox