.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.40) .\" .\" 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 .. .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 .\" .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2). .\" Fear. Run. Save yourself. No user-serviceable parts. . \" fudge factors for nroff and troff .if n \{\ . ds #H 0 . ds #V .8m . ds #F .3m . ds #[ \f1 . ds #] \fP .\} .if t \{\ . ds #H ((1u-(\\\\n(.fu%2u))*.13m) . ds #V .6m . ds #F 0 . ds #[ \& . ds #] \& .\} . \" simple accents for nroff and troff .if n \{\ . ds ' \& . ds ` \& . ds ^ \& . ds , \& . ds ~ ~ . ds / .\} .if t \{\ . ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u" . ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u' . ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u' . ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u' . ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u' . ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u' .\} . \" troff and (daisy-wheel) nroff accents .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V' .ds 8 \h'\*(#H'\(*b\h'-\*(#H' .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#] .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H' .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u' .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#] .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#] .ds ae a\h'-(\w'a'u*4/10)'e .ds Ae A\h'-(\w'A'u*4/10)'E . \" corrections for vroff .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u' .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u' . \" for low resolution devices (crt and lpr) .if \n(.H>23 .if \n(.V>19 \ \{\ . ds : e . ds 8 ss . ds o a . ds d- d\h'-1'\(ga . ds D- D\h'-1'\(hy . ds th \o'bp' . ds Th \o'LP' . ds ae ae . ds Ae AE .\} .rm #[ #] #H #V #F C .\" ======================================================================== .\" .IX Title "Config::Model::models::Dpkg::Patch 3pm" .TH Config::Model::models::Dpkg::Patch 3pm "2021-01-25" "perl v5.32.0" "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" Config::Model::models::Dpkg::Patch \- Configuration class Dpkg::Patch .SH "DESCRIPTION" .IX Header "DESCRIPTION" Configuration classes used by Config::Model .SH "Elements" .IX Header "Elements" .SS "Synopsis \- short description of the patch" .IX Subsection "Synopsis - short description of the patch" This line is stored in the first line of \s-1DEP\-3\s0 description field. \fI Optional. Type uniline. \fR .SS "Description" .IX Subsection "Description" verbose explanation of the patch and its history. \fI Optional. Type string. \fR .SS "Subject" .IX Subsection "Subject" \&\fI Optional. Type uniline. \fR .SS "Bug \- \s-1URL\s0 for related upstream bug(s)" .IX Subsection "Bug - URL for related upstream bug(s)" This field contains one \s-1URL\s0 pointing to the related bug (possibly fixed by the patch). The Bug field is reserved for the bug \s-1URL\s0 in the upstream bug tracker. Those fields can be used multiple times if several bugs are concerned. .PP The vendor name is explicitly encoded in the field name so that vendors can share patches among them without having to update the meta-information in most cases. The upstream bug \s-1URL\s0 is special cased because it's the central point of cooperation and it must be easily distinguishable among all the bug URLs. .PP To get a vendor bug (like Bug-Foo) in the graphical editor, right-click on the patch name, enter "\f(CW\*(C`Bug\-Foo\*(C'\fR\*(L" (or any other value) in the \*(R"\f(CW\*(C`accept:\*(C'\fR\*(L" entry and hit \*(R"Return". A new element will be created that you can fill like the \f(CW\*(C`Bug\*(C'\fR field. \fI Optional. Type list of uniline. \fR .SS "Bug-Debian \- \s-1URL\s0 for related bug in Debian \s-1BTS\s0" .IX Subsection "Bug-Debian - URL for related bug in Debian BTS" This field contains one \s-1URL\s0 pointing to the related bug (possibly fixed by the patch). The Bug-Debian field is reserved for the bug \s-1URL\s0 in Debian \s-1BTS.\s0 Those fields can be used multiple times if several bugs are concerned. \fI Optional. Type list of uniline. \fR .SS "Forwarded" .IX Subsection "Forwarded" Any value other than \*(L"no\*(R" or \*(L"not-needed\*(R" means that the patch has been forwarded upstream. Ideally the value is an \s-1URL\s0 proving that it has been forwarded and where one can find more information about its inclusion status. .PP If the field is missing, its implicit value is \*(L"yes\*(R" if the \*(L"Bug\*(R" field is present, otherwise it's \*(L"no\*(R". The field is really required only if the patch is vendor specific, in that case its value should be \*(L"not-needed\*(R" to indicate that the patch must not be forwarded upstream (whereas \*(L"no\*(R" simply means that it has not yet been done). .PP \&\fI Optional. Type uniline. \fR .SS "Author" .IX Subsection "Author" This field can be used to record the name and email of the patch author (ex: \*(L"John Bear \*(R"). Its usage is recommended when the patch author did not add copyright notices for his work in the patch itself. It's also a good idea to add this contact information when the patch needs to be maintained over time because it has very little chance of being integrated upstream. This field can be used multiple times if several people authored the patch. \fI Optional. Type list of uniline. \fR .SS "Origin" .IX Subsection "Origin" This field should document the origin of the patch. In most cases, it should be a simple \s-1URL.\s0 For patches backported/taken from upstream, it should point into the upstream \s-1VCS\s0 web interface when possible, otherwise it can simply list the relevant commit identifier (it should be prefixed with \*(L"commit:\*(R" in that case). For other cases, one should simply indicate the \s-1URL\s0 where the patch was taken from (mailing list archives, distribution bugtrackers, etc.) when possible. .PP The field can be optionally prefixed with a single keyword followed by a comma and a space to categorize the origin. The allowed keywords are \*(L"upstream\*(R" (in the case of a patch cherry-picked from the upstream \s-1VCS\s0), \*(L"backport\*(R" (in the case of an upstream patch that had to be modified to apply on the current version), \*(L"vendor\*(R" for a patch created by Debian or another distribution vendor, or \*(L"other\*(R" for all other kind of patches. .PP In general, a user-created patch grabbed in a \s-1BTS\s0 should be categorized as \*(L"other\*(R". When copying a patch from another vendor, the meta-information (and hence this field) should be kept if present, or created if necessary with a \*(L"vendor\*(R" origin. .PP If the Author field is present, the Origin field can be omitted and it's assumed that the patch comes from its author. \fI Optional. Type string. \fR .SS "From" .IX Subsection "From" Like Author field, this field can be used to record the name and email of the patch author (ex: \*(L"John Bear \*(R"). Its usage is recommended when the patch author did not add copyright notices for his work in the patch itself. It's also a good idea to add this contact information when the patch needs to be maintained over time because it has very little chance of being integrated upstream. This field can be used multiple times if several people authored the patch. \fI Optional. Type list of uniline. \fR .SS "Reviewed-by" .IX Subsection "Reviewed-by" This field can be used to document the fact that the patch has been reviewed and approved by someone. It should list her name and email in the standard format (similar to the example given for the Author field). This field can be used multiple times if several people reviewed the patch. .PP \&\fI Optional. Type list of uniline. \fR .SS "Acked-by" .IX Subsection "Acked-by" Synonym to Reviewd-by. This field can be used to document the fact that the patch has been reviewed and approved by someone. It should list her name and email in the standard format (similar to the example given for the Author field). This field can be used multiple times if several people reviewed the patch. .PP \&\fI Optional. Type list of uniline. \fR .SS "Last-Update" .IX Subsection "Last-Update" This field can be used to record the date when the meta-information was last updated. It should use the \s-1ISO\s0 date format YYYY-MM-DD. \fI Optional. Type uniline. \fR .SS "Applied-Upstream" .IX Subsection "Applied-Upstream" This field can be used to document the fact that the patch has been applied upstream. It may contain the upstream version expected to contain this patch, or the \s-1URL\s0 or commit identifier of the upstream commit (with commit identifiers prefixed with \*(L"commit:\*(R", as in the Origin field), or both separated by a comma and a space. \fI Optional. Type uniline. \fR .SS "diff \- actual patch" .IX Subsection "diff - actual patch" This element contains the diff that will be used to patch the source. Do not modify unless you really know what you're doing. \fI Optional. Type string. \fR .SH "SEE ALSO" .IX Header "SEE ALSO" .IP "\(bu" 4 cme