yetus-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From a.@apache.org
Subject [1/2] yetus git commit: YETUS-112 - add missing args to precommit-buildtools.md and add annotations to builtin-personality.sh
Date Fri, 29 Jul 2016 15:20:23 GMT
Repository: yetus
Updated Branches:
  refs/heads/master 9d12713aa -> 54de2af97


YETUS-112 - add missing args to precommit-buildtools.md and add annotations to builtin-personality.sh

Signed-off-by: Allen Wittenauer <aw@apache.org>


Project: http://git-wip-us.apache.org/repos/asf/yetus/repo
Commit: http://git-wip-us.apache.org/repos/asf/yetus/commit/54de2af9
Tree: http://git-wip-us.apache.org/repos/asf/yetus/tree/54de2af9
Diff: http://git-wip-us.apache.org/repos/asf/yetus/diff/54de2af9

Branch: refs/heads/master
Commit: 54de2af97cc263b7f2880724329e1daa7b630a54
Parents: 38a6b2f
Author: Karen Clark <kclark.dev@gmail.com>
Authored: Thu Jul 21 18:39:41 2016 -0700
Committer: Allen Wittenauer <aw@apache.org>
Committed: Fri Jul 29 08:20:12 2016 -0700

----------------------------------------------------------------------
 .../documentation/in-progress/precommit-buildtools.md     |  4 ++--
 precommit/core.d/builtin-personality.sh                   | 10 ++++++++++
 2 files changed, 12 insertions(+), 2 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/yetus/blob/54de2af9/asf-site-src/source/documentation/in-progress/precommit-buildtools.md
----------------------------------------------------------------------
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 @@ For example, the gradle build tool does not have a standard way to execute
check
 
 * 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
 

http://git-wip-us.apache.org/repos/asf/yetus/blob/54de2af9/precommit/core.d/builtin-personality.sh
----------------------------------------------------------------------
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 @@ function personality_modules
   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


Mime
View raw message