diff --git a/docs/artifactory/buildaddgit/help.go b/docs/artifactory/buildaddgit/help.go index 63fe99311..d3d6b73d1 100644 --- a/docs/artifactory/buildaddgit/help.go +++ b/docs/artifactory/buildaddgit/help.go @@ -3,7 +3,11 @@ package buildaddgit var Usage = []string{"rt bag [command options] [Path To .git]"} func GetDescription() string { - return "Collect VCS details from git and add them to a build." + return "Collects the Git revision and URL from the local .git directory and adds it to the build-info.\n" + + "It can also collect the list of tracked project issues (for example, issues stored in JIRA or other bug tracking systems) and add them to the build-info.\n" + + "The issues are collected by reading the git commit messages from the local git log.\n" + + "Each commit message is matched against a pre-configured regular expression, which retrieves the issue ID and issue summary.\n" + + "The information required for collecting the issues is retrieved from a yaml configuration file provided to the command." } func GetArguments() string {