commit: 09eeab38ab0b9fb2086d8001579b578397bc09c0
Author: Sam James <sam <AT> gentoo <DOT> org>
AuthorDate: Fri Mar 18 01:28:53 2022 +0000
Commit: Sam James <sam <AT> gentoo <DOT> org>
CommitDate: Fri Mar 25 19:47:53 2022 +0000
URL: https://gitweb.gentoo.org/repo/gentoo.git/commit/?id=09eeab38
subversion.eclass: stub-document internal functions
Signed-off-by: Sam James <sam <AT> gentoo.org>
eclass/subversion.eclass | 26 ++++++++++++--------------
1 file 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=