commit: 80edf9c26c6f38e624e55a81eede57cd7c476ddb
Author: Ulrich Müller <ulm <AT> gentoo <DOT> org>
AuthorDate: Sat Aug 26 06:51:00 2023 +0000
Commit: Ulrich Müller <ulm <AT> gentoo <DOT> org>
CommitDate: Sat Aug 26 06:51:06 2023 +0000
URL: https://gitweb.gentoo.org/repo/gentoo.git/commit/?id=80edf9c2
elisp-common.eclass: Rewrap lines in eclass documentation
No changes of the text.
Signed-off-by: Ulrich Müller <ulm <AT> gentoo.org>
eclass/elisp-common.eclass | 56 +++++++++++++++++++++++++---------------------
1 file changed, 30 insertions(+), 26 deletions(-)
diff --git a/eclass/elisp-common.eclass b/eclass/elisp-common.eclass
index ef24622d405e..a40c9f63007d 100644
--- a/eclass/elisp-common.eclass
+++ b/eclass/elisp-common.eclass
@@ -351,8 +351,8 @@ elisp-make-autoload-file() {
# @FUNCTION: elisp-org-export-to
# @USAGE: <export file type> <Org file path>
# @DESCRIPTION:
-# Use Emacs Org "export-to" functions to convert a given Org file to a picked
-# format.
+# Use Emacs Org "export-to" functions to convert a given Org file to a
+# picked format.
#
# Example:
# @CODE
@@ -386,12 +386,13 @@ elisp-org-export-to() {
# @DESCRIPTION:
# Run ELisp package tests using the "buttercup" test runner.
#
-# The option "test-subdirectory" may be given any number of times, it should
-# be given as though it was passed to Emacs or the test tool, not as a string.
+# The option "test-subdirectory" may be given any number of times,
+# it should be given as though it was passed to Emacs or the test tool,
+# not as a string.
#
# The options "test-subdirectory" and "test-runner-opts" are optional,
-# but if "test-runner-opts" needs to be provided also "test-subdirectory" has
-# to be specified.
+# but if "test-runner-opts" needs to be provided also "test-subdirectory"
+# has to be specified.
elisp-test-buttercup() {
debug-print-function ${FUNCNAME} "$@"
@@ -415,12 +416,13 @@ elisp-test-buttercup() {
# @DESCRIPTION:
# Run ELisp package tests using the "ert-runner" test runner.
#
-# The option "test-subdirectory" may be given any number of times, it should
-# be given as though it was passed to Emacs or the test tool, not as a string.
+# The option "test-subdirectory" may be given any number of times,
+# it should be given as though it was passed to Emacs or the test tool,
+# not as a string.
#
# The options "test-subdirectory" and "test-runner-opts" are optional,
-# but if "test-runner-opts" needs to be provided also "test-subdirectory" has
-# to be specified.
+# but if "test-runner-opts" needs to be provided also "test-subdirectory"
+# has to be specified.
elisp-test-ert-runner() {
debug-print-function ${FUNCNAME} "$@"
@@ -445,12 +447,13 @@ elisp-test-ert-runner() {
# @DESCRIPTION:
# Run ELisp package tests using "ert", the Emacs's built-in test runner.
#
-# The option "test-subdirectory" may be given any number of times, it should
-# be given as though it was passed to Emacs or the test tool, not as a string.
+# The option "test-subdirectory" may be given any number of times,
+# it should be given as though it was passed to Emacs or the test tool,
+# not as a string.
#
# The options "test-subdirectory" and "test-runner-opts" are optional,
-# but if "test-runner-opts" needs to be provided also "test-subdirectory" has
-# to be specified.
+# but if "test-runner-opts" needs to be provided also "test-subdirectory"
+# has to be specified.
elisp-test-ert() {
debug-print-function ${FUNCNAME} "$@"
@@ -482,8 +485,8 @@ elisp-test-ert() {
# @FUNCTION: elisp-enable-tests
# @USAGE: [--optional] <test-runner> [test-runner-options] ...
# @DESCRIPTION:
-# Set up IUSE, RESTRICT, BDEPEND and test runner function for running tests
-# with the specified test runner.
+# Set up IUSE, RESTRICT, BDEPEND and test runner function for running
+# tests with the specified test runner.
#
# The test-runner argument must be one of:
#
@@ -493,18 +496,19 @@ elisp-test-ert() {
#
# - ert: for built-in GNU Emacs test utility
#
-# If the "--optional" flag is passed (before specifying the test runner),
-# then it is assumed that the ELisp package is a part of some project that
-# optionally enables GNU Emacs support.
-# This will correctly set up the test and Emacs dependencies.
+# If the "--optional" flag is passed (before specifying the test
+# runner), then it is assumed that the ELisp package is a part of some
+# some project that optionally enables GNU Emacs support. This will
+# correctly set up the test and Emacs dependencies.
#
-# Notice that the fist option passed to the "test-runner" is the directory
-# and the rest are miscellaneous options applicable to that given runner.
+# Notice that the fist option passed to the "test-runner" is the
+# directory and the rest are miscellaneous options applicable to that
+# given runner.
#
-# This function has to be called post inherit, specifically after "IUSE",
-# "RESTRICT" and "BDEPEND" variables are assigned.
-# It is advised to place this call right before (re)defining a given ebuild's
-# phases.
+# This function has to be called post inherit, specifically after
+# "IUSE", "RESTRICT" and "BDEPEND" variables are assigned.
+# It is advised to place this call right before (re)defining a given
+# ebuild's phases.
#
# Example:
# @CODE
