texlive-common.eclass: fix several @USAGE problems
authorBen Kohler <bkohler@gentoo.org>
Fri, 6 Sep 2019 17:08:03 +0000 (12:08 -0500)
committerBen Kohler <bkohler@gentoo.org>
Tue, 31 Mar 2020 14:57:03 +0000 (09:57 -0500)
Signed-off-by: Ben Kohler <bkohler@gentoo.org>
eclass/texlive-common.eclass

index 2618cba2e1accf3f014987d55a1da5b0e32c2e9c..2072d3ad16053c199143e248dd95fb02f574376e 100644 (file)
@@ -67,7 +67,7 @@ texlive-common_is_file_present_in_texmf() {
 }
 
 # @FUNCTION: texlive-common_do_symlinks
-# @USAGE: < src > < dest >
+# @USAGE: <src> <dest>
 # @DESCRIPTION:
 # Mimic the install_link function of texlinks
 #
@@ -103,7 +103,7 @@ texlive-common_do_symlinks() {
 }
 
 # @FUNCTION: etexlinks
-# @USAGE: < file >
+# @USAGE: <file>
 # @DESCRIPTION:
 # Mimic texlinks on a fmtutil format file
 #
@@ -121,7 +121,7 @@ etexlinks() {
 }
 
 # @FUNCTION: dobin_texmf_scripts
-# @USAGE: < file1 file2 ... >
+# @USAGE: <file1> [file2] ...
 # @DESCRIPTION:
 # Symlinks a script from the texmf tree to /usr/bin. Requires permissions to be
 # correctly set for the file that it will point to.
@@ -137,10 +137,10 @@ dobin_texmf_scripts() {
 }
 
 # @FUNCTION: etexmf-update
-# @USAGE: In ebuilds' pkg_postinst and pkg_postrm phases
 # @DESCRIPTION:
 # Runs texmf-update if it is available and prints a warning otherwise. This
-# function helps in factorizing some code.
+# function helps in factorizing some code.  Useful in ebuilds' pkg_postinst and
+# pkg_postrm phases.
 
 etexmf-update() {
        if has_version 'app-text/texlive-core' ; then
@@ -155,10 +155,10 @@ etexmf-update() {
 }
 
 # @FUNCTION: efmtutil-sys
-# @USAGE: In ebuilds' pkg_postinst to force a rebuild of TeX formats.
 # @DESCRIPTION:
 # Runs fmtutil-sys if it is available and prints a warning otherwise. This
-# function helps in factorizing some code.
+# function helps in factorizing some code. Used in ebuilds' pkg_postinst to
+# force a rebuild of TeX formats.
 
 efmtutil-sys() {
        if has_version 'app-text/texlive-core' ; then