-
Notifications
You must be signed in to change notification settings - Fork 0
/
README.gripe
45 lines (32 loc) · 1.33 KB
/
README.gripe
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
This is how to use gripe.
Full example showing all the available fields:
$self->gripe({
arch => ...
subpackage => ...
code => 'ShortCodeName',
diag => "This is a human-readable string",
context => {
path => "/path/to/file",
lineno => 123,
sub => ???,
excerpt => "e.g. from a build log",
},
});
In real life, you won't use all of those.
=== Testing
When using gripe, please use the convention:
code => 'Something'
(i.e. the bareword "code", an arrow, and a string in single or double quotes).
This convention is used by t/RPM/Grill/40codes.t to cross-reference
plugins with tooltips, and (try to) make sure that no tests go
undocumented.
=== FIXME
I'm finding it hard to deal with context. Here are some of
the real-world cases it has to cope with:
* The problem is with the CONTENT of {path}
* The problem is with {path} itself
* The problem is in the specfile (path unknown)
* The problem is with the RPM itself
* The problem is in a build log
There's also a need for a "for more information" thingy (eg
SecurityPolicy.pm > _check_cve_file)