summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorSam James <sam@gentoo.org>2022-03-18 01:28:53 +0000
committerSam James <sam@gentoo.org>2022-03-25 19:47:53 +0000
commit09eeab38ab0b9fb2086d8001579b578397bc09c0 (patch)
tree3cb3b41a52a70c83c6241c8e2218a5b10ece1f08 /eclass/subversion.eclass
parentbash-completion-r1.eclass: fix typo in eclassdoc function name (diff)
downloadgentoo-09eeab38ab0b9fb2086d8001579b578397bc09c0.tar.gz
gentoo-09eeab38ab0b9fb2086d8001579b578397bc09c0.tar.bz2
gentoo-09eeab38ab0b9fb2086d8001579b578397bc09c0.zip
subversion.eclass: stub-document internal functions
Signed-off-by: Sam James <sam@gentoo.org>
Diffstat (limited to 'eclass/subversion.eclass')
-rw-r--r--eclass/subversion.eclass26
1 files changed, 12 insertions, 14 deletions
diff --git a/eclass/subversion.eclass b/eclass/subversion.eclass
index 100920264643..349878618427 100644
--- a/eclass/subversion.eclass
+++ b/eclass/subversion.eclass
@@ -399,11 +399,9 @@ subversion_pkg_preinst() {
## -- Private Functions
-## -- subversion__svn_info() ------------------------------------------------- #
-#
-# param $1 - a target.
-# param $2 - a key name.
-#
+# @FUNCTION: subversion__svn_info
+# @USAGE: <target> <key name>
+# @INTERNAL
subversion__svn_info() {
local target="${1}"
local key="${2}"
@@ -413,9 +411,9 @@ subversion__svn_info() {
| cut -d" " -f2-
}
-## -- subversion__get_repository_uri() --------------------------------------- #
-#
-# param $1 - a repository URI.
+# @FUNCTION: subversion__get_repository_uri
+# @USAGE: <repository URI>
+# @INTERNAL
subversion__get_repository_uri() {
local repo_uri="${1}"
@@ -432,9 +430,9 @@ subversion__get_repository_uri() {
echo "${repo_uri}"
}
-## -- subversion__get_wc_path() ---------------------------------------------- #
-#
-# param $1 - a repository URI.
+# @FUNCTION: subversion__get_wc_path
+# @USAGE: <repository URI>
+# @INTERNAL
subversion__get_wc_path() {
local repo_uri="$(subversion__get_repository_uri "${1}")"
@@ -443,9 +441,9 @@ subversion__get_wc_path() {
echo "${ESVN_STORE_DIR}/${ESVN_PROJECT}/${repo_uri##*/}"
}
-## -- subversion__get_peg_revision() ----------------------------------------- #
-#
-# param $1 - a repository URI.
+# @FUNCTION: subversion__get_peg_revision
+# @USAGE: <repository URI>
+# @INTERNAL
subversion__get_peg_revision() {
local repo_uri="${1}"
local peg_rev=