summaryrefslogtreecommitdiffstats
path: root/upstream/archlinux/man3/Test2::EventFacet::About.3perl
blob: efbfc1dddc515ec21ef3da85b5ec175ccda1cc18 (plain)
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
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
.ie n \{\
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "Test2::EventFacet::About 3perl"
.TH Test2::EventFacet::About 3perl 2024-02-11 "perl v5.38.2" "Perl Programmers Reference Guide"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH NAME
Test2::EventFacet::About \- Facet with event details.
.SH DESCRIPTION
.IX Header "DESCRIPTION"
This facet has information about the event, such as event package.
.SH FIELDS
.IX Header "FIELDS"
.ie n .IP "$string = $about\->{details}" 4
.el .IP "\f(CW$string\fR = \f(CW$about\fR\->{details}" 4
.IX Item "$string = $about->{details}"
.PD 0
.ie n .IP "$string = $about\->\fBdetails()\fR" 4
.el .IP "\f(CW$string\fR = \f(CW$about\fR\->\fBdetails()\fR" 4
.IX Item "$string = $about->details()"
.PD
Summary about the event.
.ie n .IP "$package = $about\->{package}" 4
.el .IP "\f(CW$package\fR = \f(CW$about\fR\->{package}" 4
.IX Item "$package = $about->{package}"
.PD 0
.ie n .IP "$package = $about\->\fBpackage()\fR" 4
.el .IP "\f(CW$package\fR = \f(CW$about\fR\->\fBpackage()\fR" 4
.IX Item "$package = $about->package()"
.PD
Event package name.
.ie n .IP "$bool = $about\->{no_display}" 4
.el .IP "\f(CW$bool\fR = \f(CW$about\fR\->{no_display}" 4
.IX Item "$bool = $about->{no_display}"
.PD 0
.ie n .IP "$bool = $about\->\fBno_display()\fR" 4
.el .IP "\f(CW$bool\fR = \f(CW$about\fR\->\fBno_display()\fR" 4
.IX Item "$bool = $about->no_display()"
.PD
True if the event should be skipped by formatters.
.ie n .IP "$uuid = $about\->{uuid}" 4
.el .IP "\f(CW$uuid\fR = \f(CW$about\fR\->{uuid}" 4
.IX Item "$uuid = $about->{uuid}"
.PD 0
.ie n .IP "$uuid = $about\->\fBuuid()\fR" 4
.el .IP "\f(CW$uuid\fR = \f(CW$about\fR\->\fBuuid()\fR" 4
.IX Item "$uuid = $about->uuid()"
.PD
Will be set to a uuid if uuid tagging was enabled.
.ie n .IP "$uuid = $about\->{eid}" 4
.el .IP "\f(CW$uuid\fR = \f(CW$about\fR\->{eid}" 4
.IX Item "$uuid = $about->{eid}"
.PD 0
.ie n .IP "$uuid = $about\->\fBeid()\fR" 4
.el .IP "\f(CW$uuid\fR = \f(CW$about\fR\->\fBeid()\fR" 4
.IX Item "$uuid = $about->eid()"
.PD
A unique (for the test job) identifier for the event.
.SH SOURCE
.IX Header "SOURCE"
The source code repository for Test2 can be found at
\&\fIhttp://github.com/Test\-More/test\-more/\fR.
.SH MAINTAINERS
.IX Header "MAINTAINERS"
.IP "Chad Granum <exodist@cpan.org>" 4
.IX Item "Chad Granum <exodist@cpan.org>"
.SH AUTHORS
.IX Header "AUTHORS"
.PD 0
.IP "Chad Granum <exodist@cpan.org>" 4
.IX Item "Chad Granum <exodist@cpan.org>"
.PD
.SH COPYRIGHT
.IX Header "COPYRIGHT"
Copyright 2020 Chad Granum <exodist@cpan.org>.
.PP
This program is free software; you can redistribute it and/or
modify it under the same terms as Perl itself.
.PP
See \fIhttp://dev.perl.org/licenses/\fR