Skip site navigation (1)Skip section navigation (2)

FreeBSD Manual Pages

  
 
  

home | help
App::Sqitch::Plan::TagUser Contributed Perl DocumentaApp::Sqitch::Plan::Tag(3)

Name
       App::Sqitch::Plan::Tag -	Sqitch deployment plan tag

Synopsis
	 my $plan = App::Sqitch::Plan->new( sqitch => $sqitch );
	 for my	$line ($plan->lines) {
	     say $line->as_string;
	 }

Description
       A App::Sqitch::Plan::Tag	represents a tag as parsed from	a plan file.
       In addition to the interface inherited from App::Sqitch::Plan::Line, it
       offers interfaces fetching and formatting timestamp and planner
       information.

Interface
       See App::Sqitch::Plan::Line for the basics.

   Accessors
       "change"

       Returns the App::Sqitch::Plan::Change object with which the tag is
       associated.

       "timestamp"

       Returns the an App::Sqitch::DateTime object representing	the time at
       which the tag was added to the plan.

       "planner_name"

       Returns the name	of the user who	added the tag to the plan.

       "planner_email"

       Returns the email address of the	user who added the tag to the plan.

       "info"

       Information about the tag, returned as a	string.	Includes the tag ID,
       the ID of the associated	change,	the name and email address of the user
       who added the tag to the	plan, and the timestamp	for when the tag was
       added to	the plan.

       "id"

       A SHA1 hash of the data returned	by "info()", which can be used as a
       globally-unique identifier for the tag.

   Instance Methods
       "format_planner"

	 my $planner = $tag->format_planner;

       Returns a string	formatted with the name	and email address of the user
       who added the tag to the	plan.

Author
       David E.	Wheeler	<david@justatheory.com>

License
       Copyright (c) 2012-2015 iovation	Inc.

       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:

       The above copyright notice and this permission notice shall be included
       in all copies or	substantial portions of	the Software.

       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.

perl v5.24.1			  2017-07-03	     App::Sqitch::Plan::Tag(3)

Name | Synopsis | Description | Interface | Author | License

Want to link to this manual page? Use this URL:
<https://www.freebsd.org/cgi/man.cgi?query=App::Sqitch::Plan::Tag&sektion=3&manpath=FreeBSD+12.0-RELEASE+and+Ports>

home | help