/usr/share/perl5/FCM/Context/Make.pm is in fcm 2016.12.0-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 | # ------------------------------------------------------------------------------
# (C) British Crown Copyright 2006-16 Met Office.
#
# This file is part of FCM, tools for managing and building source code.
#
# FCM is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# FCM is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with FCM. If not, see <http://www.gnu.org/licenses/>.
# ------------------------------------------------------------------------------
use strict;
use warnings;
# ------------------------------------------------------------------------------
package FCM::Context::Make;
use base qw{FCM::Class::HASH};
use constant {
ST_UNKNOWN => 0,
ST_INIT => 1,
ST_OK => 2,
ST_FAILED => -1,
};
__PACKAGE__->class({
ctx_of => '%',
dest => '$',
dest_lock => '$',
error => {},
inherit_ctx_list => '@',
name => {isa => '$', default => q{}},
option_of => '%',
prev_ctx => __PACKAGE__,
status => {isa => '$', default => ST_UNKNOWN},
steps => '@',
});
# ------------------------------------------------------------------------------
1;
__END__
=head1 NAME
FCM::Context::Make
=head1 SYNOPSIS
use FCM::Context::Make;
my $ctx = FCM::Context::Make->new();
=head1 DESCRIPTION
Provides a context object for the FCM make system. It is a sub-class of
L<FCM::Class::HASH|FCM::Class::HASH>.
=head1 OBJECTS
=head2 FCM::Context::Make
An instance of this class represents a make. It has the following
attributes:
=over 4
=item ctx_of
A HASH containing the (keys) IDs and the (values) context objects of the make.
=item dest
The destination of this make.
=item dest_lock
The destination lock of this make.
=item error
This should be set to the value of the exception, if this make ends in one.
=item inherit_ctx_list
An ARRAY of contexts inherited by this make.
=item name
The name of the context. This is useful if we need to have multiple (but
non-overlapping) "fcm make" runs in the same destination. (Default is a null
string.)
=item option_of
A HASH to store the options of this make. See L</OPTION> for detail.
=item status
The status of the make.
=item steps
The names of the steps to make.
=back
=head1 OPTION
The C<option_of> attribute of a FCM::Context::Make object may contain the
following elements:
=over 4
=item config-file
An ARRAY of configuration file names.
=item directory
The working directory of the make.
=item ignore-lock
Ignores lock file in the destination.
=item jobs
The number of (child) threads that can be run simultaneously.
=item new
Performs a make in "new" mode (as opposed to the "incremental" mode).
=back
=head1 CONSTANTS
=over 4
=item FCM::Context::Make->ST_UNKNOWN
The status of a make context or the context of a subsystem. Status is unknown.
=item FCM::Context::Make->ST_INIT
The status of a make context or the context of a subsystem. The make or the
subsystem has initialised, but not completed.
=item FCM::Context::Make->ST_OK
The status of a make context or the context of a subsystem. The make or the
subsystem has completed successfully.
=item FCM::Context::Make->ST_FAILED
The status of a make context or the context of a subsystem. The make or the
subsystem has failed.
=back
=head1 COPYRIGHT
(C) Crown copyright Met Office. All rights reserved.
=cut
|