Skip to content
This repository has been archived by the owner on Jan 6, 2023. It is now read-only.

Commit

Permalink
Remove documentation on JIRA plugin, per issue #29
Browse files Browse the repository at this point in the history
This commit has been made separately in order to allow as simple git revert
as and when issue #29 is resolved.

Signed-off-by: Ikey Doherty <[email protected]>
  • Loading branch information
Ikey Doherty committed Jan 18, 2016
1 parent a195102 commit f956b1e
Showing 1 changed file with 0 additions and 74 deletions.
74 changes: 0 additions & 74 deletions docs/cve-check-tool.1
Original file line number Diff line number Diff line change
Expand Up @@ -78,21 +78,6 @@ Report status for all packages, regardless of whether or not they are
affected by a CVE. This is useful when doing full repository audits.
.RE
.PP
\fB\-b\fR, \fB\-\-auto-bug\fR
.RS 4
Enable automatic bug tracking. This requires you to have a valid
\fBcve\-check\-tool\.conf\fR file, with the configuration of your bug
tracker in place. Currently only JIRA is supported.
.RE
.PP
\fB\-j\fR, \fB\-\-auto-bug-template\fR
.RS 4
Specify an optional JSON template file to be used when building bug queries,
whether checking their report status or reporting for the first time. This,
combined with \fBcve\-check\-tool\.conf\fR, will allow fine grained control
of bug queries.
.RE
.PP
\fB\-o\fR, \fB\-\-output-file\fR
.RS 4
Set the path to the output file of \fBcve\-check\-tool\fR. This is only used
Expand All @@ -108,65 +93,6 @@ Print the version of \fBcve\-check\-tool\fR and exit\&.
.PP
On success, 0 is returned, a non\-zero failure code otherwise\&

.SH "FILES"
.PP
.SS CVE\-CHECK\-TOOL.conf
.PP
Use this file to configure tool and plugin settings:
.P
\fB[JIRA]\fR
.P
\fBurl=\fR
.RS 4
Set the JIRA server's REST API URL.
.RE
\fBuser=\fR
.RS 4
Set the JIRA login user name.
.RE
\fBpassword=\fR
.RS 4
Set the JIRA login user name's password (if any).
.RE
\fBtimeout=\fR
.RS 4
Set the timeout in seconds in case server hangs. A 0 means wait forever.
.RE
\fBverbose=\fR
.RS 4
Set to true to show more output for debugging, etc.
.RE
.P
\fB[JIRA-New-Issue]\fR
.P
\fBcomponents.[name]=\fR
.RS 4
Set the name of the component.
.RE
\fBissuetype.name=\fR
.RS 4
Set the name of the issue type.
.RE
\fBproject.key=\fR
.RS 4
Set the name of the project.
.RE
\fBassignee.name=\fR
.RS 4
Set the name of the assignee.
.RE
.P
\fB[JIRA-Search-Issues]\fR
.P
\fBjql=\fR
.RS 4
Set the literal JIRA jql search criteria string.
.RE
\fBsearch_filter=\fR
.RS 4
Set the search string for the summary field.
.RE
.P

.SH "COPYRIGHT"
.PP
Expand Down

0 comments on commit f956b1e

Please sign in to comment.