'\" t
.\" aegis - project change supervisor
.\" Copyright (C) 1991-1995, 2006-2008 Peter Miller
.\"
.\" This program 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.
.\"
.\" This program 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 this program. If not, see
.\" .
.\"
.\"
.\" aegis - project change supervisor
.\" Copyright (C) 1991-1993, 1997, 2006-2008 Peter Miller
.\"
.\" This program 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.
.\"
.\" This program 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 this program. If not, see
.\" .
.\"
.\"
.\" aegis - project change supervisor
.\" Copyright (C) 1991-1993, 1997, 2006-2008 Peter Miller
.\"
.\" This program 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.
.\"
.\" This program 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 this program. If not, see
.\" .
.\"
.ds n) aegis
.ds N) Aegis
.if n .nr )M 8n
.if n .nr IN 8n
.if n .nr )I 8n
.if n .po 0
.hy 0
.if n .ad l
.de r)
.if !'\\*(R)'no' \{\
.PP
See also
.IR \*(n) (1)
for options common to all \*(n) commands.
.\}
..
.de eB
.RS
.nf
.ft CW
.ta 8n 16n 24n 32n
..
.de eE
.ft P
.fi
.RE
..
.TH aecattr 5 \*(N) "Reference Manual"
.SH NAME
aecattr \- aegis change attributes file
.XX "aecattr(5)" "change attributes file format"
.SH DESCRIPTION
A change attributes file is used to describe the
modifiable portion of a change.
.SH CONTENTS
A change attributes file contains the following fields:
'\" t
.\" aegis - project change supervisor
.\" Copyright (C) 1991-1994, 2002, 2004, 2006-2008 Peter Miller.
.\"
.\" This program 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.
.\"
.\" This program 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 this program. If not, see
.\" .
.\"
.TP 8n
description = string;
.br
This field contains a detailed description of the change.
.TP 8n
brief_description = string;
.br
This field contains a brief description of the change.
.TP 8n
cause = ( ... );
.br
This field describes the cause which motivated the change.
.RS 8n
.TP 8n
external_bug
.br
The change was created in response to
a bug report
from outside the development team.
This repairs existing functionality.
.TP 8n
external_enhancement
.br
The change was created in response to
an enhancement request
from outside the development team.
This adds new functionality.
.TP 8n
external_improvement
.br
The change was created in response to
an improvement request
from outside the development team.
This improves existing functionality.
.TP 8n
internal_bug
.br
The change was created in response to
a bug report
from inside the development team.
This repairs existing functionality.
.TP 8n
internal_enhancement
.br
The change was created in response to
an enhancement request
from inside the development team.
This adds new functionality.
.TP 8n
internal_improvement
.br
The change was created in response to
an improvement request
from inside the development team.
This improves existing functionality.
.TP 8n
chain
.br
This cause is where you have a fix to fix a fix;
tracking these is an interesting quality metric.
.RE
.TP 8n
test_exempt = boolean;
.br
This field is true if it is not necessary
to test the change.
It is, in general, desirable to test all changes,
whether new functionality or a bug fix.
This is, however, a project management issue.
.TP 8n
test_baseline_exempt = boolean;
.br
This field is true if it is not necessary
to test the change against the baseline before it is changed.
The test of the baseline is required to fail;
this is to establish that the test has isolated the bug,
and that the change has fixed that isolated bug.
.TP 8n
regression_test_exempt = boolean;
.br
This field is true if it is not necessary
to perform a full regression test on the change.
If absent, defaults to true for all causes except improvements.
.TP 8n
architecture = [ string ];
.br
This field is a list of names of
system and machine architectures on which the change
must successfully build and test.
.TP 8n
copyright_years = [ integer ];
.RS
This field details the years in which the change was worked on.
This field is present in trunk, branch and leaf nodes.
.PP
As a change is edited, years in which the change was worked on
accumulate in this field automatically.
Branches accumulate years as integrations occur.
You may need to manually edit this,
though it should be rare.
.RE
.TP 8n
version_previous = string;
This field records the "previous" version, mostly to simplify patch generation.
It is only meaningful for trunks and branches.
It is set automatically when a branch is started or integrated.
.TP 8n
attribute = [ { ... } ];
.RS
This is a list of \fI(name,value)\fP pairs, defining user specified attributes.
.TP 8n
name = string;
.RS
The name of the attribute.
By convention, names which start with an upper-case letter will appear
in listings, and lower-case will not.
Attribute names are case-insensitive.
.RE
.TP 8n
value = string;
The value of the attribute.
.PP
Arguably, most change attributes which may be altered by the user (and
some that can't) should be of this form. Due to an accident of history,
this is not the case.
.RE
.SH SEE ALSO
.TP 8n
.IR aenc (1)
create a new change
.TP 8n
.IR aeca (1)
modify the attributes of a change
.TP 8n
.IR aegis (5)
\*(n) file format syntax
.TP 8n
.IR aecstate (5)
change state file format
.TP 8n
.IR aepattr (5)
project attributes file format
.\"
.\" aegis - project change supervisor
.\" Copyright (C) 1991-1995, 1997, 2006-2008 Peter Miller
.\"
.\" This program 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.
.\"
.\" This program 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 this program. If not, see
.\" .
.\"
.br
.ne 2i
.SH COPYRIGHT
.ds v) 4.24.3
.ds V) 4.24.3.D001
.ds o) 0
.ds p) 4.25
.ds u) 4.24
.ds Y) 1991, 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010
\*(n) version \*(V)
.br
.if t .ds C) \(co
.if n .ds C) (C)
Copyright \*(C) \*(Y) Peter Miller
.PP
The \*(n) program comes with ABSOLUTELY NO WARRANTY;
for details use the '\fI\*(n) -VERSion License\fP' command.
This is free software
and you are welcome to redistribute it under certain conditions;
for details use the '\fI\*(n) -VERSion License\fP' command.
.br
.ne 1i
.SH AUTHOR
.TS
tab(;);
l r l.
Peter Miller;E-Mail:;millerp@canb.auug.org.au
\f(CW/\e/\e*\fR;WWW:;http://www.canb.auug.org.au/~millerp/
.TE