[jira] [Commented] (YETUS-112) test-patch build system documentation missing expected args for required

["Karen Clark (JIRA)" <ji...@apache.org>]

    [ https://issues.apache.org/jira/browse/YETUS-112?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=15369980#comment-15369980 ] 

Karen Clark commented on YETUS-112:
-----------------------------------

I'm working on this one now. Seems easy to just put the additional info into yetus/asf-site-src/source/documentation/in-progress/precommit-buildtools.md, but as [~aw] says, that doesn't solve the root problem.

Looks like the code in yetus/precommit/core.d/builtin-personality.sh doesn't have any comments / much in the way of descriptive run-time messages. Does it make sense to extend this documentation there OR is that expected only to be called by other systems and therefore not interactive enough to bother?

[~busbey] What would you prefer here?

> 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)