http://git-wip-us.apache.org/repos/asf/yetus/blob/d8b4eab6/documentation/0.1.0/precommit-apidocs/core/index.html ---------------------------------------------------------------------- diff --git a/documentation/0.1.0/precommit-apidocs/core/index.html b/documentation/0.1.0/precommit-apidocs/core/index.html new file mode 100644 index 0000000..643e4d6 --- /dev/null +++ b/documentation/0.1.0/precommit-apidocs/core/index.html @@ -0,0 +1,1238 @@ + + + + + + Apache Yetus + + + + + + + + + + + + + + + +
+ + + + +
+ +

Public/Stable/Replaceable

+ +

add_bugsystem

+ + +
add_bugsystem bugsystem
+
+ + + +

Add the given bugsystem type

+ + + +

Nothing

+ + + + + + + + + + + + + + + + + + + +
ClassificationLevel
AudiencePublic
StabilityStable
ReplaceableYes
+ +

add_build_tool

+ + +
add_build_tool build tool
+
+ + + +

Add the given build tool type

+ + + +

Nothing

+ + + + + + + + + + + + + + + + + + + +
ClassificationLevel
AudiencePublic
StabilityStable
ReplaceableYes
+ +

add_test

+ + +
add_test test
+
+ + + +

Add the given test type

+ + + +

Nothing

+ + + + + + + + + + + + + + + + + + + +
ClassificationLevel
AudiencePublic
StabilityStable
ReplaceableYes
+ +

add_test_format

+ + +
add_test_format test format
+
+ + + +

Add the given test format type

+ + + +

Nothing

+ + + + + + + + + + + + + + + + + + + +
ClassificationLevel
AudiencePublic
StabilityStable
ReplaceableYes
+ +

add_test_type

+ + +
add_test_type plugin
+
+ + + +

Add the given test type

+ + + +

Nothing

+ + + + + + + + + + + + + + + + + + + +
ClassificationLevel
AudiencePublic
StabilityStable
ReplaceableYes
+ +

delete_bugsystem

+ + +
delete_bugsystem bugsystem
+
+ + + +

Remove the given bugsystem type

+ + + +

Nothing

+ + + + + + + + + + + + + + + + + + + +
ClassificationLevel
AudiencePublic
StabilityStable
ReplaceableYes
+ +

delete_build_tool

+ + +
delete_build_tool build tool
+
+ + + +

Remove the given build tool type

+ + + +

Nothing

+ + + + + + + + + + + + + + + + + + + +
ClassificationLevel
AudiencePublic
StabilityStable
ReplaceableYes
+ +

delete_test

+ + +
delete_test test
+
+ + + +

Remove the given test type

+ + + +

Nothing

+ + + + + + + + + + + + + + + + + + + +
ClassificationLevel
AudiencePublic
StabilityStable
ReplaceableYes
+ +

delete_test_format

+ + +
delete_test_format test format
+
+ + + +

Remove the given test format type

+ + + +

Nothing

+ + + + + + + + + + + + + + + + + + + +
ClassificationLevel
AudiencePublic
StabilityStable
ReplaceableYes
+ +

delete_test_type

+ + +
delete_test_type plugin
+
+ + + +

Remove the given test type

+ + + +

Nothing

+ + + + + + + + + + + + + + + + + + + +
ClassificationLevel
AudiencePublic
StabilityStable
ReplaceableYes
+ +

personality_plugins

+ + +
personality_plugins plug-in list string
+
+ + + +

Personality-defined plug-in list

+ + + +

Nothing

+ + + + + + + + + + + + + + + + + + + +
ClassificationLevel
AudiencePublic
StabilityStable
ReplaceableYes
+ +

verify_needed_test

+ + +
verify_needed_test test
+
+ + + +

Verify if a given test was requested

+ + + +

1 = yes

+ +

0 = no

+ + + + + + + + + + + + + + + + + + + +
ClassificationLevel
AudiencePublic
StabilityStable
ReplaceableYes
+ +

verify_plugin_enabled

+ + +
verify_plugin_enabled test
+
+ + + +

Determine if a plugin was enabeld by the user ENABLED_PLUGINS must be defined

+ + + +

Nothing

+ + + + + + + + + + + + + + + + + + + +
ClassificationLevel
AudiencePublic
StabilityStable
ReplaceableYes
+ +

Public/Stable/Not Replaceable

+ +

common_defaults

+ + +
common_defaults
+
+ + + +

Setup the default global variables

+ + + +

Nothing

+ + + + + + + + + + + + + + + + + + + +
ClassificationLevel
AudiencePublic
StabilityStable
ReplaceableNo
+ +

patchfile_verify_zero

+ + +
patchfile_verify_zero log filename
+
+ + + +

if patch-level zero, then verify we aren’t just adding files

+ + + +

$?

+ + + + + + + + + + + + + + + + + + + +
ClassificationLevel
AudiencePublic
StabilityStable
ReplaceableNo
+ +

yetus_abs

+ + +
yetus_abs directory
+
+ + + +

Given a filename or dir, return the absolute version of it

+ + + +

0 success

+ +

1 failure

+ +

stdout abspath

+ + + + + + + + + + + + + + + + + + + +
ClassificationLevel
AudiencePublic
StabilityStable
ReplaceableNo
+ +

yetus_add_entry

+ + +
yetus_add_entry
+
+ + + +

Given variable $1 add $2 to it

+ + + +

Nothing

+ + + + + + + + + + + + + + + + + + + +
ClassificationLevel
AudiencePublic
StabilityStable
ReplaceableNo
+ +

yetus_debug

+ + +
yetus_debug string
+
+ + + +

Print a message to stderr if –debug is turned on

+ + + +

Nothing

+ + + + + + + + + + + + + + + + + + + +
ClassificationLevel
AudiencePublic
StabilityStable
ReplaceableNo
+ +

yetus_delete_entry

+ + +
yetus_delete_entry
+
+ + + +

Given variable $1 delete $2 from it

+ + + +

Nothing

+ + + + + + + + + + + + + + + + + + + +
ClassificationLevel
AudiencePublic
StabilityStable
ReplaceableNo
+ +

yetus_error

+ + +
yetus_error string
+
+ + + +

Print a message to stderr

+ + + +

Nothing

+ + + + + + + + + + + + + + + + + + + +
ClassificationLevel
AudiencePublic
StabilityStable
ReplaceableNo
+ +

yetus_run_and_redirect

+ + +
yetus_run_and_redirect filename command [..]
+
+ + + +

run the command, sending stdout and stderr to the given filename

+ + + +

$?

+ + + + + + + + + + + + + + + + + + + +
ClassificationLevel
AudiencePublic
StabilityStable
ReplaceableNo
+ +

yetus_verify_entry

+ + +
yetus_verify_entry
+
+ + + +

Given variable $1 determine if $2 is in it

+ + + +

1 = yes, 0 = no

+ + + + + + + + + + + + + + + + + + + +
ClassificationLevel
AudiencePublic
StabilityStable
ReplaceableNo
+ +

Public/Evolving/Not Replaceable

+ +

list_plugins

+ + +
list_plugins
+
+ + + +

List all installed plug-ins, regardless of whether they have been enabled

+ + + +

Nothing

+ + + + + + + + + + + + + + + + + + + +
ClassificationLevel
AudiencePublic
StabilityEvolving
ReplaceableNo
+ +

None/None/Not Replaceable

+ +

docker_version

+ + +
docker_version
+
+ + + +

None

+ + + +

Nothing

+ + + + + + + + + + + + + + + + + + + +
ClassificationLevel
AudienceNone
StabilityNone
ReplaceableNo
+ +

personality_file_tests

+ + +
personality_file_tests
+
+ + + +

None

+ + + +

Nothing

+ + + + + + + + + + + + + + + + + + + +
ClassificationLevel
AudienceNone
StabilityNone
ReplaceableNo
+ +

personality_modules

+ + +
personality_modules
+
+ + + +

None

+ + + +

Nothing

+ + + + + + + + + + + + + + + + + + + +
ClassificationLevel
AudienceNone
StabilityNone
ReplaceableNo
+ +
+
+
+ +
+ + + http://git-wip-us.apache.org/repos/asf/yetus/blob/d8b4eab6/documentation/0.1.0/precommit-apidocs/index.html ---------------------------------------------------------------------- diff --git a/documentation/0.1.0/precommit-apidocs/index.html b/documentation/0.1.0/precommit-apidocs/index.html new file mode 100644 index 0000000..a5d5bc6 --- /dev/null +++ b/documentation/0.1.0/precommit-apidocs/index.html @@ -0,0 +1,149 @@ + + + + + + Apache Yetus + + + + + + + + + + + + + + + +
+ + +

Precommit API Docs

+ +

Following gives the downstream consumable API for precommit components.

+ + + +
+
+
+ +
+ + +