.\" Automatically generated by Pod::Man 4.09 (Pod::Simple 3.35) .\" .\" 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 .. .\" Set up some character translations and predefined strings. \*(-- will .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left .\" double quote, and \*(R" will give a right double quote. \*(C+ will .\" give a nicer C++. Capital omega is used to do unbreakable dashes and .\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff, .\" nothing in troff, for use with C<>. .tr \(*W- .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' .ie n \{\ . ds -- \(*W- . ds PI pi . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch . ds L" "" . ds R" "" . ds C` "" . ds C' "" 'br\} .el\{\ . ds -- \|\(em\| . ds PI \(*p . ds L" `` . ds R" '' . 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 .. .if !\nF .nr F 0 .if \nF>0 \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . if !\nF==2 \{\ . nr % 0 . nr F 2 . \} .\} .\" ======================================================================== .\" .IX Title "Debbugs::Control::Service 3pm" .TH Debbugs::Control::Service 3pm "2018-02-26" "perl v5.26.1" "User Contributed Perl Documentation" .\" 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" Debbugs::Control::Service \-\- Handles the modification parts of scripts/service by calling Debbugs::Control .SH "SYNOPSIS" .IX Header "SYNOPSIS" use Debbugs::Control::Service; .SH "DESCRIPTION" .IX Header "DESCRIPTION" This module contains the code to implement the grammar of control@. It is abstracted here so that it can be called from process at submit time. .PP All of the public functions take the following options: .IP "debug \*(-- scalar reference to which debbuging information is appended" 4 .IX Item "debug scalar reference to which debbuging information is appended" .PD 0 .IP "transcript \*(-- scalar reference to which transcript information is appended" 4 .IX Item "transcript scalar reference to which transcript information is appended" .IP "affected_bugs \*(-- hashref which is updated with bugs affected by this function" 4 .IX Item "affected_bugs hashref which is updated with bugs affected by this function" .PD .PP Functions which should (probably) append to the .log file take the following options: .IP "requester \*(-- Email address of the individual who requested the change" 4 .IX Item "requester Email address of the individual who requested the change" .PD 0 .IP "request_addr \*(-- Address to which the request was sent" 4 .IX Item "request_addr Address to which the request was sent" .IP "request_nn \*(-- Name of queue file which caused this request" 4 .IX Item "request_nn Name of queue file which caused this request" .IP "request_msgid \*(-- Message id of message which caused this request" 4 .IX Item "request_msgid Message id of message which caused this request" .IP "location \*(-- Optional location; currently ignored but may be supported in the future for updating archived bugs upon archival" 4 .IX Item "location Optional location; currently ignored but may be supported in the future for updating archived bugs upon archival" .IP "message \*(-- The original message which caused the action to be taken" 4 .IX Item "message The original message which caused the action to be taken" .IP "append_log \*(-- Whether or not to append information to the log." 4 .IX Item "append_log Whether or not to append information to the log." .PD .PP \&\fBappend_log\fR (for most functions) is a special option. When set to false, no appending to the log is done at all. When it is not present, the above information is faked, and appended to the log file. When it is true, the above options must be present, and their values are used. .SH "GENERAL FUNCTIONS" .IX Header "GENERAL FUNCTIONS"