.\" -*- 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 "App::Sqitch::Plan::Pragma 3pm" .TH App::Sqitch::Plan::Pragma 3pm 2024-02-08 "perl v5.38.2" "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 .IX Header "Name" App::Sqitch::Plan::Pragma.pm \- Sqitch deployment plan blank line .SH Synopsis .IX Header "Synopsis" .Vb 4 \& my $plan = App::Sqitch::Plan\->new( sqitch => $sqitch ); \& for my $line ($plan\->lines) { \& say $line\->as_string; \& } .Ve .SH Description .IX Header "Description" An App::Sqitch::Plan::Pragma represents a plan file pragma. See App::Sqitch::Plan::Line for its interface. .SH Interface .IX Header "Interface" In addition to the interface inherited from App::Sqitch::Plan::Line, App::Sqitch::Plan::Line::Pragma adds a few methods of its own. .SS Accessors .IX Subsection "Accessors" \fR\f(CI\*(C`value\*(C'\fR\fI\fR .IX Subsection "value" .PP The value of the pragma. .PP \fR\f(CI\*(C`op\*(C'\fR\fI\fR .IX Subsection "op" .PP The operator, including surrounding white space. .PP \fR\f(CI\*(C`hspace\*(C'\fR\fI\fR .IX Subsection "hspace" .PP The horizontal space between the pragma and its value. .SS "Instance Methods" .IX Subsection "Instance Methods" \fR\f(CI\*(C`format_value\*(C'\fR\fI\fR .IX Subsection "format_value" .PP Formats the value for output. If there is no value, an empty string is returned. Otherwise the value is returned as-is. .SH Author .IX Header "Author" David E. Wheeler .SH License .IX Header "License" Copyright (c) 2012\-2024 iovation Inc., David E. Wheeler .PP Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: .PP The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. .PP THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.