Skip to content

Commit

Permalink
more documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
barbie committed Sep 20, 2014
1 parent 3568f87 commit a98f07f
Showing 1 changed file with 36 additions and 1 deletion.
37 changes: 36 additions & 1 deletion vhost/cgi-bin/reports-summary.cgi
Expand Up @@ -28,11 +28,45 @@ item * dist (required)
The distribution to provide a summary for. An error will be returned if no
distribution name is provided.
item * author (optional)
Filter based on a specific author who released the distribution. Defaults to authors.
item * version (optional)
Filter based on a specific distribution version. Defaults to the latest
version.
item * grade (optional)
Filter based on report grade, i.e. 'pass','fail','na' or 'unknown'.
item * oncpan (optional)
Filter based on whether the distribution is available on CPAN or only BACKPAN.
Values are:
=over 4
=item * 0 = CPAN and BACKPAN
=item * 1 = CPAN only
=item * 2 = BACKPAN only
=back
item * distmat (optional)
Filter based on whether the distribution is a developer release or a
stable release.
=over 4
=item * 0 = all releases
=item * 1 = stable releases only
=item * 2 = development releases only
=back
item * perlmat (optional)
Filter based on perl maturity, i.e. whether a development version (5.21.3) or
Expand Down Expand Up @@ -71,7 +105,8 @@ Systems.
item * format (optional)
Available formats are: 'txt', 'html' and 'xml'. Defaults to 'html'.
Available formats are: 'csv', 'txt', 'html' and 'xml'. Defaults to 'html'.
'txt' is provided for backwards compatibility, but is mapped to 'csv'.
=back
Expand Down

0 comments on commit a98f07f

Please sign in to comment.