[
https://issues.apache.org/jira/browse/YETUS-112?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=15372138#comment-15372138
]
Sean Busbey commented on YETUS-112:
-----------------------------------
I think first we should ensure that we have a general description in
precommit-buildtools.md, since that's what folks making their own plugins will
have to rely on.
The methods in builtin-personality just delegate to the plugin methods
described in the precommit-buildtools.md docs. Describing that would be nice
(maybe while pointing to the docs?) but I wouldn't make it too involved, since
the methods themselves can't be altered by folks. That means anything we write
there will essentially be implementation details for consumption within the
project. For reference, they end up pushed to [the core
apidocs|http://yetus.apache.org/documentation/in-progress/precommit-apidocs/core/#personality_file_tests]
(and you're right they're all sparse).
Related, if you look at the [apidocs for plugins we
provide|http://yetus.apache.org/documentation/in-progress/precommit-apidocs/plugins/]
you can see there are examples for all of our out-of-the-box build tools (e.g.
_ant_builtin_personality_modules_, _maven_builtin_personality_modules_, etc).
Since these also can't be updated by downstream folks we should probably label
them with an audience of private so they don't show up. (there's an example of
using shelldocs to label methods private in [the core's set of common
functions|https://github.com/apache/yetus/blob/rel/0.3.0/precommit/core.d/01-common.sh#L92].
> test-patch build system documentation missing expected args for required
> ------------------------------------------------------------------------
>
> Key: YETUS-112
> URL: https://issues.apache.org/jira/browse/YETUS-112
> Project: Yetus
> Issue Type: Bug
> Components: Test Patch, website and documentation
> Reporter: Sean Busbey
> Assignee: Karen Clark
> Labels: beginner
>
> Two of the required method for build system plugins don't include a
> description of their expected parameters.
> {quote}
> pluginname_builtin_personality_modules
> Default method to determine how to enqueue modules for processing. Note that
> personalities may override this function.
> pluginname_builtin_personality_file_tests
> Default method to determine which tests to trigger. Note that personalities
> may override this function.
> {quote}
> from looking at the maven build plugin, the first has two parameters: repo
> status and test desired, second has one parameter: a given changed file
--
This message was sent by Atlassian JIRA
(v6.3.4#6332)
