YETUS-112 - add missing args to precommit-buildtools.md and add annotations to builtin-personality.sh
Signed-off-by: Allen Wittenauer <aw@apache.org>
diff --git a/asf-site-src/source/documentation/in-progress/precommit-buildtools.md b/asf-site-src/source/documentation/in-progress/precommit-buildtools.md
index a2c74f2..d09323b 100644
--- a/asf-site-src/source/documentation/in-progress/precommit-buildtools.md
+++ b/asf-site-src/source/documentation/in-progress/precommit-buildtools.md
@@ -68,11 +68,11 @@
* pluginname\_builtin_personality\_modules
- - Default method to determine how to enqueue modules for processing. Note that personalities may override this function.
+ - Default method to determine how to enqueue modules for processing. Note that personalities may override this function. Requires two arguments: repo status and test desired. For example, in a maven build, values may be 'branch' and 'mvninstall'.
* pluginname\_builtin_personality\_file\_tests
- - Default method to determine which tests to trigger. Note that personalities may override this function.
+ - Default method to determine which tests to trigger. Note that personalities may override this function. Requires a single argument: the file in which the tests exist.
# Optional Functions
diff --git a/precommit/core.d/builtin-personality.sh b/precommit/core.d/builtin-personality.sh
index 1258d46..c473d66 100755
--- a/precommit/core.d/builtin-personality.sh
+++ b/precommit/core.d/builtin-personality.sh
@@ -14,6 +14,11 @@
# See the License for the specific language governing permissions and
# limitations under the License.
+## @description Generate a list of all personality modules for a given
+## @description buildtool for the system to invoke
+## @audience private
+## @stability evolving
+## @replaceable no
function personality_modules
{
if declare -f "${BUILDTOOL}_builtin_personality_modules" >/dev/null; then
@@ -21,6 +26,11 @@
fi
}
+## @description Generate a list of all personality file tests for a given
+## @description buildtool for the system to invoke
+## @audience private
+## @stability evolving
+## @replaceable no
function personality_file_tests
{
if declare -f "${BUILDTOOL}_builtin_personality_file_tests" >/dev/null; then
