





.













                           Aegis

                A Project Change Supervisor




                           HOWTO







                        Peter Miller

                  [4mmillerp@canb.auug.org.au[0m































Howto                                                  Aegis


.






This document describes Aegis version 4.24.3
and was prepared 9 July 2013.






This  document  describing  the Aegis program, and the Aegis
program itself, are
Copyright (C) 1991, 1992,  1993,  1994,  1995,  1996,  1997,
1998,  1999, 2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007,
2008, 2009, 2010 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 ver-
sion.

This program is distributed in the hope that it will be use-
ful, but WITHOUT ANY WARRANTY; without even the implied war-
ranty of MERCHANTABILITY or FITNESS FOR  A  PARTICULAR  PUR-
POSE.   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
<http://www.gnu.org/licenses/>.






















Page 2          (lib/en/howto/introductio.so)   Peter Miller





Aegis                                                  Howto


[1m1.  Introduction[0m

This manual contains a series of brief lessons or  "How  To"
guides  for  using  Aegis.   Each  is  arranged to cover two
pages, so that when the manual lies open on  the  desk,  the
whole subject is easily visible in front of you.

When  printing this manual, it is essential to print it dou-
ble sided, or the "subject at once" effect will not occur.

The table of contents  will  be  printed  last.   Insert  it
(there  should  be  two pages, on one sheet of paper) before
this page.

[1m1.1.  Assumed Knowledge[0m

Many of these sections are written for use by beginners,  so
there  is a fairly low level of assumed knowledge.  However,
you may want to have [4mThe[24m [4mAegis[24m [4mUser[24m  [4mGuide[24m,  and  [4mThe[24m  [4mAegis[0m
[4mReference[24m  [4mManual[24m very close by, as all of the material con-
veyed here is available in a more expended or detailed  form
on those manuals.

[1m1.2.  Howto Install Aegis[0m

The  description of how to build, test and install Aegis may
be found in the Reference  Manual,  under  the  heading  [4mThe[0m
[4mBUILDING[24m  [4mFile[24m,  which reproduces the BUILDING file included
in the Aegis source distribution.

If you installed Aegis using a  RedHat  or  Debian  package,
this will not be at all relevant to you, simply ignore it.

[1m1.3.  Howto Contribute[0m

If  you  would  like  to see other "How To" subjects, please
drop me an e-mail.  Better yet, write one and e-mail  it  to
me.



















Peter Miller      (./lib/en/howto/main.ms)            Page 3





Howto                                                  Aegis


[1m2.  Cheat Sheet[0m

This  page  is  a quick reference into the common Aegis com-
mands.

+o Usually, "man  [4mcommand_name[24m"  can  be  used  to  get  more
  details on a particular command.

+o See  also  the  official Aegis quick reference in the User
  Guide, page 88.

+o The "-p [4mname[24m" option is used to specify the project  name.

+o The  "-c [4mnumber[24m" option is used to specify the change num-
  ber.

+o The "-l" (or "-List") option can often  be  used  to  list
  subjects  for  the  given  command  (eg. change numbers or
  projects) or simply to list rather than edit ([4me.g.[24m a  file
  or change attributes).

[1m2.1.  Common Commands[0m

ae_p [4mproject-name.branch-number[0m
        Set  current  project number for all following Aegis
        commands.  The ae_p command with no  arguments  will
        `unset' this forced default.

ae_c [4mnumber[0m
        Set  current  change  number for all following Aegis
        commands.  The ae_c command with no  arguments  will
        `unset' this forced default.

aecd [ -bl ]
        Change directory [change to baseline].

aeb     Aegis  build - used by developers, reviewers and/ or
        integrators.

aet     Run tests - used by developers.

aed     Difference of change files with baseline.

aedless View difference files generated with aed.

ael cd  List change details.

aeca [ -l ]
        Edit [list] change attributes.

tkaenc  Create a new change (see [4maenc[24m(1) for details), using
        a  GUI interface.  This makes it a damn sight easier
        to type in the description field.




Page 4             (lib/en/howto/cheat.so)      Peter Miller





Aegis                                                  Howto


tkaeca  Edit change attributes (see  [4maeca[24m(1)  for  details),
        using  a  GUI interface.  This makes it a damn sight
        easier to edit the description field.

ael ll  List all of the lists (there are a lot).

ael c   List all of the changes for a project (branch).

ael cf  List all of the files in a change.

[4maeuconf[24m(5)
        This is a man page documenting the  ~/.aegisrc  file
        format.

[1m2.2.  Developer Commands[0m

Procedure:  ael  cd -> aedb -> [4mdo[24m [4mstuff[24m -> aeb -> aet -> aed
-> aedless [ -> aeclean ] -> aede

aedb[u]
     Develop begin [undo].

aede[u]
     Develop end [undo].

aeclean
     This will remove all files in the development directory
     which  are  not  in  the  change as new files or copied
     files.  This may delete files  that  you  want,  so  be
     careful.

The [4maeclean[24m(1) command uses Aegis' knowledge of what is [4msup-[0m
[4mposed[24m to be in the change.  You  are  meant  to  tell  Aegis
about  all  source  files you create in a development direc-
tory.  If you have forgotten to do this, it is highly likely
that the integration would fail in any case.

If  you are importing files from elsewhere, use "[4maenf[24m [4m.[24m" and
all of the files in the directory tree below dot  (the  cur-
rent directory) will be added to the change (make sure there
are no object files when you do this).

aecp Prepares a file in the project for editing  within  the
     change;  [4mi.e.[24m  copy  file  into  change  from baseline.
     Remove symlink if necessary, etc.

aecpu
     Reverse the effects of the above.

aecpu -unch
     Will check all files in your change to see if any  have
     not  been modified, and perform an [4maecpu[24m on them.  This
     will stop an unnecessary version number  increment  for
     files  that  have not changed.  (And also improves test



Peter Miller       (lib/en/howto/cheat.so)            Page 5





Howto                                                  Aegis


     correlations.)

aem  Merge out-of-date files.  See the [4m-Only-merge[24m option of
     the [4maed[24m(1) command.

aenf[u]
     Create/ add a new file [undo].

aemv Rename (move) files.

aerm[u]
     This  tells  Aegis  the  file is to be removed from the
     baseline when the change is integrated.   Or  [4maermu[24m  to
     undo this [4mbefore[24m the change is finished.

[1m2.3.  Reviewer Commands[0m

Procedure:  ael cd -> aecd -> aedless -> [4mview[24m [4moutput,[24m [4mreview[0m
[4msource[24m [4mfiles[24m -> aerpass

Remember: the point of reviews is to find problems, not be a
rubber stamp.  You are expected to fail some reviews.

aerpass
     Review pass.

aerpu
     Review pass undo.

aerfail
     Review fail.

[1m2.4.  Integrator Commands[0m

Procedure: aeib -> aeb -> aet -> aed -> aeipass

There  is an [4maeintegratq[24m(1) script distributed with Aegis to
do this procedure automatically.

aeib[u]
     Integrate begin [undo].

aeipass
     Integrate pass.

aeifail
     Integrate fail.

[1m2.5.  Project Administrator Commands[0m

This includes all of the commands that don't fit  the  cate-
gories above.





Page 6             (lib/en/howto/cheat.so)      Peter Miller





Aegis                                                  Howto


aenc[u]
     Create   a  new  change  [undo].   See  [4maecattr[24m(5)  for
     description of file format, or use [4mtkaenc[24m(1) instead.

aend and aerd
     New developer; remove developer.

aenrv and aerrv
     New reviewer; remover reviewer.

aeni and aeri
     New integrator; remove integrator.

aena and aera
     New (project) administrator; remove administrator.

aepa [-l]
     Edit [list] project attributes (see [4maepattr[24m(5) for file
     format).

aeca [-l]
     Edit  [list] change attributes (see [4maecattr[24m(5) for file
     format).

tkaeca
     Edit change attributes using a GUI.  This makes it much
     easier to type in the description field.






























Peter Miller      (./lib/en/howto/main.ms)            Page 7





Howto                                                  Aegis


[1m3.  How to Start Using Aegis[0m

For  the first-time user, Aegis can appear to be very daunt-
ing.  It has a huge number of configuration alternatives for
each project, and it is difficult to know where to begin.

It is assumed that you already have Aegis installed.  If you
do not, see the section of the [4mReference[24m [4mManual[24m  called  [4mThe[0m
[4mBUILDING[24m  [4mFile[24m.   This reproduces the BUILDING file included
in the Aegis source distribution.

[1m3.1.  First, Create The Project[0m

You need to create a new project.  Follow  the  instructions
in  the [4mHow[24m [4mto[24m [4mCreate[24m [4ma[24m [4mNew[24m [4mProject[24m section, and then return
here.

[1m3.2.  Second, Use a Template Project[0m

The very first time you use Aegis, it will be easiest if you
download  one  of  the  template projects.  This gives you a
project which (almost always) works correctly the first time
"out of the box".

+o The template projects can be found on the Aegis home page:
  http://www.canb.auug.org.au/~millerp/aegis/

+o If you are a long-time GNU Make user,  you  probably  want
  the Make-RCS template, at least to start with.

+o Follow the instructions found on the web page and you will
  have a working Aegis project, complete with self tests.

+o From this starting point, create changes (the [4mtkaenc[24m  com-
  mand  is  good for this, as it gives you a simple GUI) and
  try modifying the calculator, or adding more  programs  to
  the project.

+o The  template projects is intended to be generally useful.
  Many users have simply retained this format  and  inserted
  their  own  projects into it.  (Use a change to delete the
  calculator and its tests.)

[1m3.3.  Second, Copy a Template Project[0m

If this isn't the very first time, you may wish to get  more
adventurous,  and  try  copying  the  relevant bits out of a
working project.  Usually, when sites first  try  this,  the
working  project  will  be one of the template projects from
the previous section.

+o Create a new project.  For  this  exercise,  you  probably
  want a single user project.




Page 8          (lib/en/howto/first_time.so)    Peter Miller





Aegis                                                  Howto


+o Create a new change

+o Copy  the project [4mconfig[24m file, and and files referenced by
  it, such as the new file templates and the build  configu-
  ration file ([4mMakefile[24m or [4mHowto.cook[24m, depending).

+o Copy the sources of the existing project into the develop-
  ment directory.  If you have several  levels  of  directo-
  ries, reproduce this, too.

+o Remove  files which are not primary sources ([4me.g.[24m the gen-
  erated C sources of you have yacc input files).

+o Using the "[4maenf[24m [4m.[24m" command (yes,  that's  a  dot,  meaning
  "the  current directory") you can tell Aegis to add all of
  the source files  in  the  development  directory  to  the
  change set.

+o You will probably need to modify your build method to meet
  Aegis' expectations.  Rather  than  do  this  immediately,
  change  the  [4mbuild_command[24m  in  the project [4mconfig[24m file to
  read "build_command = "exit 0";" and fix it  in  the  next
  change set.

+o Now, build, develop end, review and integrate, as found in
  the [4mUser[24m [4mGuide[24m worked example.  (Except, of course,  there
  is only one member of staff.)

+o Create a second change, and copy the project configuration
  file (called [4maegis.conf[24m by default), and the build config-
  uration  file  (probably  [4mMakefile[24m or [4mHowto.cook[24m) into the
  change.

+o This would be a good time to read the  [4mDependency[24m  [4mMainte-[0m
  [4mnance[24m  [4mTool[24m  chapter  of  the  Aegis  User Guide, and also
  [4mRecursive[24m [4mMake[24m [4mConsidered[24m [4mHarmful[24m (see  the  author's  web
  site) if you haven't already.

+o Edit the build configuration, try the [4maeb[24m command; it will
  probably fail.  Iterate until things build correctly.

+o develop end, review and integrate as normal.  Your project
  is now under Aegis.














Peter Miller      (./lib/en/howto/main.ms)            Page 9





Howto                                                  Aegis


[1m4.  How to Recreate Old Versions[0m

It  is  possible  to  recreate old versions of your project.
This is done using the delta number assigned to  every  com-
pleted change.

[1m4.1.  aecp[0m

Recreating  the  sources  is usually done to recreate a bug.
To this end, it is also usually done from within an existing
change.  The [4maecp[24m(1) command is used to copy histprical file
versions into a change.

The [4maecp[24m(1) command has some options which are used to  per-
form the source recreation:

[1m-DELta [4m[22mnumber[0m
  This option tells [4maecp[24m(1) to extract an historical version
  of the files, rather than the head revision (the one  vis-
  able  in the baseline).  You need to know the [4mdelta[24m number
  of the change,  assigned  at  integration  time,  not  the
  change number.

[1m-BRanch [4m[22mnumber[0m
  If  the  historical  version is on a different branch than
  the one the current change is on, use  this  option.   The
  branch  number  is  to  the  left  of  the  "D" in version
  strings.

[1m-DELta-From-Change [4m[22mnumber[0m
  This option tells [4maecp[24m(1) to extract an historical version
  of  the files, rather than the head revision (the one vis-
  able in the baseline).  You only need the change number to
  use this option.

[1m-DELta-Date "[4m[22mstring[24m[1m"[0m
  [1mThis option tells [4m[22maecp[24m[1m(1) to extract an historical version[0m
  [1mof the files, rather than the head revision (the one  vis-[0m
  [1mable  in the baseline).  You only need the date the change[0m
  [1mwas integrated to use this option.   It  understands  many[0m
  [1mforms of written (English) dates, but try to avoid ambigu-[0m
  [1mous month numbering (it can be confused by  some  European[0m
  [1mvs. American numeric formats, use month names instead).[0m

[1m4.2.  Finding Delta Numbers[0m

You can find delta numbers in a number of ways:

+o The "[4mael[24m [4mchange-details[24m" command will list change details.
If changes are completed, their delta number will appear  at
the top of the listing.

+o  The  "[4mael[24m  [4mproject-history[24m" command lists all integration
for a project, including  their  change  numbers  and  delta



Page 10          (lib/en/howto/recreate.so)     Peter Miller





Aegis                                                  Howto


numbers.

+o  The  [4maeannotate[24m(1) command lists the file source, annota-
tiong each line with the developer, the date  and  the  ver-
sion.   To  the right of the "D" in the version is the delta
number.

+o The [4m#{version}[24m substitution (see [4maesub[24m(5) for more  infor-
mation) is covered in the next section.

In  addition, you may need to use the [1m-BRanch [22moption, if the
historical version is on a different branch than the one the
current  change  is on.  The branch number is to the left of
the "D" in version strings.

[1m4.3.  ${version}[0m

The [4mbuild_command[24m field in the project [4mconfig[24m  file  may  be
given  the  [4m${version}[24m  substitution,  which  you may use to
embed the version string into your executables.  You  could,
for  example, have this string printed when yoiur program is
given the [1m-version [22mcommand line option.  For example:

     % [1maegis --version[0m
     aegis version 4.15.D012
     %


Armed with this version string, you can recreate the sources
for the version being executed.  The command

     % [1maecp --change=4.15.D012 .[0m
     %

would be issued from inside a suitable change.  This form of
the [4maecp[24m [4m-change[24m option  combines  the  [1m-BRanch  [22mand  [1m-DELta[0m
options into a single command line option.

[1m4.4.  Out Of Date[0m

Once  you  have  recreated  your  sources  and  rebuilt your
project, and presumably fixed  the  bug  you  were  hunting,
there are a couple more steps.

+o  The  first  is to remove unchanged sources.  Do this with
the

     % [1maecpu -unchanged[0m
     %

command.  This removes from your change all files which were
not  changed  by this change.  This cuts down on the clutter
and makes the next step much easier.




Peter Miller     (lib/en/howto/recreate.so)          Page 11





Howto                                                  Aegis


+o The next step is to merge  the  files.   Because  you  are
working  with  historical  versions of the files, Aegis will
think they are out-of-date and want you to merge  them.   Do
this  is the usual way (using the [4maem[24m(1) command).  Remember
that Aegis will stash a  backup  copy  with  a  ",B"  suffix
before merging.

You may find the following command

     % [1mael cf | grep '('[0m
     %

useful for finding out-of-date files.

+o  Once  Aegis  thinks all the files are up-to-date you then
need to rebuild and retest before completing development.









































Page 12           (./lib/en/howto/main.ms)      Peter Miller





Aegis                                                  Howto


[1m5.  How to Create a New Project[0m

Before you can do anything  else  with  Aegis,  you  need  a
project  to  do  it  to.  The advantage of this is that each
project is administered and configured independently.

If this is your first time using Aegis, you probably want  a
single-user  project.   You  can  change the number of users
later, if you ever want to add more staff to the project.

You need to select the name with some care, as changing  the
project  name later is tedious.  Adding aliases, however, is
simple.

[1m5.1.  Single User Project[0m

A single suer project is one  where  all  of  the  different
staff  roles  are filled by the same person, and a number of
interlocks are disabled, as you will see in a moment.

Unfortunately, there is no Tcl/Tk GUI for this,  yet,  which
makes this documentation bigger then it needs to be.

[4mDon't[24m [4mdo[24m [4manything[24m [4myet![24m  Read through all of the steps first.

+o You may want to read the [4maenpr[24m(1) man page for more infor-
  mation.

+o The  command  "[4maenpr[24m  name  [4m-version[24m  [4m-[24m"  will  create the
  project with no branches.  This  will  automatically  make
  you  (that is, the executing user) the project administra-
  tor and the project owner.  The [4mumask[24m is remembered,  too.

+o The  root  of  the  project directory will be in your home
  directory, named after the  project  name.   If  you  want
  something else, use the [4maenpr[24m [4m--directory[24m option.

+o The  default group at the time of execution determines the
  file group of the project.  Make sure the account  created
  for the project has the correct group.  (Even if you don't
  understand this, your system administrator should.)

+o The [4mumask[24m at the time of execution  determines  the  group
  access  to  the  project.  Even if you usually work with a
  restrictive [4mumask[24m, set it to the right one for the project
  before running this [4maenpr[24m command.

+o For additional security, it is often [4mvery[24m useful to create
  a UNIX user for each project.  You  may  need  to  consult
  your system administrator for assistance with this.  It is
  usual to name the user and the project the same thing,  to
  avoid  confusion.  Log in as this user to execute the ini-
  tial project creation commands; once completed [1mno one [22mwill
  ever login to this account again.



Peter Miller    (lib/en/howto/new_project.so)        Page 13





Howto                                                  Aegis


+o Add the staff to the project: the "[4maena[24m your-normal-login"
  command adds your normal account as a project  administra-
  tor.   You  need  this  if you are using a special project
  account, so that  your  normal  self  can  administer  the
  project.

+o At  this  point,  log  out of the special project account.
  Ask the system administrator to permanently disable it.

+o Add the rest of the staff: the "[4maend[24m  your-login"  command
  makes  you  a  developer,  the  "[4maenrv[24m your-login" command
  makes you a reviewer and  the  "[4maeni[24m  your-login"  command
  makes you an integrator.

+o You  need  to edit the project attributes next.  The "[4maepa[0m
  [4m-edit[24m" command does this.  You will be placed into a  text
  editor, and will see something similar to this:

       description = "The \"[4mexample[24m\" project";
       developer_may_review = false;
       developer_may_integrate = false;
       reviewer_may_integrate = false;
       developers_may_create_changes = false;
       umask = 022;

  Ignore  any  extra  stuff, you should not change it at the
  moment.  To get a single user project, edit the  field  to
  read

       developer_may_review = true;
       developer_may_integrate = true;
       reviewer_may_integrate = true;
       developers_may_create_changes = true;

  Be extra careful to preserve the semicolons!  You may also
  want to change the description at this time,  too.   Don't
  forget the closing double-quote [4mand[24m semicolon.

+o Create  the  first branch now.  They inherit all staff and
  attributes at creation time, which is why we worked on the
  trunk  project first.  The command "[4maenbr[24m name [4m1[24m" followed
  by followed by "[4maenbr[24m name[4m.1[24m [4m0[24m" will  give  you  a  branch
  called  [4mname[24m.1.0  for  use  wherever Aegis wants a project
  name.  (See the branching chapter of the  User  Guide  for
  more information.)

[1m5.2.  Two User Project[0m

Everything  is  done  as  above,  except you want to project
attributes to look like this:







Page 14         (lib/en/howto/new_project.so)   Peter Miller





Aegis                                                  Howto


     developer_may_review = false;
     developer_may_integrate = true;
     reviewer_may_integrate = true;
     developers_may_create_changes = true;

This says that developers can't review their own work.

You will need to add the  other  person  to  the  developer,
reviewer and integrator roles, too.

Converting  a single user project to a two person project is
simply editing the project  attributes  to  look  like  this
later.   [4mRemember:[24m each branch inherited its attributes when
it was created - you need to  edit  the  ancestor  branches'
project attributes too.

[1m5.3.  Multi User Project[0m

Everything  is  done  as  above,  except you want to project
attributes to look like this:

     developer_may_review = false;
     developer_may_integrate = false;
     reviewer_may_integrate = false;
     developers_may_create_changes = true;

This says that developers can't review their own  work,  and
reviewers  can't  integrate their own reviews.  This ensures
the maximum number of eyes validate each change.

You will need to add the  other  staff  to  the  appropriate
developer,  reviewer  and  integrator  roles.  Staff need to
always be permitted all  roles:  it  is  common  for  junior
staff, for example, [4mnot[24m to be authorized as reviewers.

Converting  a  single user project to a multi-person project
is simply editing the project attributes to look  like  this
later.   [4mRemember:[24m each branch inherited its attributes when
it was created - you need to  edit  the  ancestor  branches'
project attributes too.

[1m5.4.  Warning[0m

The  [4m/usr/local/com/aegis/state[24m  file  contains  pointers to
"system" projects.   [4mPointers.[24m   Users  may  add  their  own
project pointers (to their own projects) by putting a search
path into the [4mAEGIS_PATH[24m environment variable.   The  system
part   is  always  automatically  appended  by  [4mAegis[24m.   The
default, already set by the [4m/usr/local/lib/aegis/cshrc[24m file,
is  [4m$HOME/lib/aegis[24m.  Do not create this directory, [4mAegis[24m is
finicky and wants to do this itself.

     Where projects reside is completely flexible,  be  they
system  projects  or user projects.  They are not kept under



Peter Miller    (lib/en/howto/new_project.so)        Page 15





Howto                                                  Aegis


the [4m/usr/local/com/aegis[24m directory, this directory only con-
tains pointers.

[1m5.4.1.  Creating Projects[0m

When  you  create  a  new  project, the [4mfirst[24m element of the
AEGIS_PATH is used as the  place  to  remember  the  project
[4mpointer[24m.   This  means  the  project will not show up in the
global project list if you have set  AEGIS_PATH  to  include
private projects.

There  are  two  ways  to  make sure that you are creating a
global  project.   Either  "[4munset[24m  [4mAEGIS_PATH[24m"   immediately
before  using  the  "[4maenpr[24m"  command,  or use the "--library
[4m/usr/local/com/aegis[24m" option of the [4maenpr[24m command.

[1m5.4.2.  Web Visibility[0m

If you have a Web server, you may like to install the  Aegis
web  interface.   You  do  this by copying the [4maeget[24m program
from [4m/usr/local/bin/aeget[24m into  your  web  server's  [4mcgi-bin[0m
directory.   There  is  a [4maeget.instal[24m helper script, if you
don't know where your web server's [4mcgi-bin[24m directory is.

You may prefer to use a symbolic link, as this will be  more
stable across Aegis upgrades.  However, this requires a cor-
responding [4mfollow-symlinks[24m setting in your web server's con-
figuration file.  (Use the [4maeget.instal[24m [4m-s[24m option.)

If  you  have a Web server, and aeget was installed, you can
use a wrapper script to set the [4mAEGIS_PATH[24m environment vari-
able,  if  you  want it to be able to see more projects than
just the global projects.

[1m5.5.  Changing The Project Owner[0m

Typically, when folks try Aegis for  the  first  time,  they
don't worry about having a separate user for their projects.
However, once things are ticking along, it is less and  less
attractive  to toss it all and start again cleanly.  So, now
you need to change the  project  owner  from  the  user  who
started  the  Aegis  evaluation  to  the unique project user
account.

1. You need to be [4mroot[24m to perform this procedure.

2. Create the user account.  It  doesn't  need  to  work  to
   login,  so  the  password  can be disabled.  You probably
   want to arrange to have this user's email forwarded some-
   where  sensible  (maybe  see  the Distributed Development
   chapter of the User Guide).

3. The owner of the project is taken from the owner  of  the
   project  directory  tree,  so  this  is  what needs to be



Page 16         (lib/en/howto/new_project.so)   Peter Miller





Aegis                                                  Howto


   changed.  Go to the root of the project tree - the direc-
   tory  which  appears in the "[4mael[24m [4mprojects[24m" listing.  This
   isn't the trunk baseline, but the directory above it (you
   will see [4minfo[24m, [4mhistory[24m and [4mbaseline[24m sub-directories).

4. Use the command

        chown -R [4musername[24m .

   to  change the ownership of this directory, and all files
   and sub-directories below it.  Insert the username of the
   account  you created in step 2.  (You need the [1mdot [22mon the
   end of the command, its not mere punctuation.)

     There is no need to change  the  owner  of  any  active
changes, or any other change attributes.









































Peter Miller      (./lib/en/howto/main.ms)           Page 17





Howto                                                  Aegis


[1m6.  How to Move a Project[0m

By  "move  a  project", you may wish to change the project's
name but leave the project files in the  same  location,  or
you  may  wish  to  change a projects directory location and
leave it with the same name.  This section covers both.

There are two ways to move a project.  One  is  from  within
Aegis,  and  one  is from outside Aegis.  Each section below
covers both methods.

[1m6.1.  Relocating a Project[0m

This section deals with moving a project's  files  from  one
file system location to another.

[1m6.1.1.  From within Aegis[0m

This  works  best  when  you  are  moving a project from one
machine to another.  It is a [4mvery[24m good idea if there are  no
active changes on [4many[24m branch.

Step  1:  You  need  to  know  where  in the file system the
project currently resides.  Take a look in the projects list
([4mael[24m  [4mp[24m) and see the directory reported for the trunk of the
project.  Ignore any active branches.

Step 2: Usually, when you remove a  project,  Aegis  deleted
all  of  the  project  files.  However the aerm -keep option
tells Aegis to remove the project name, but keep all of  the
project files.

Step  3:  Move the files to their new location, you need [4mall[0m
of the files below the directory tree you found in  step  1.
This  may  be a simple file move, or may involve copying the
files to tape, and then unpacking on a new machine.   Remem-
ber  to  make  sure  the file ownerships are set the way you
want (usually, this means "preserved exactly").

Step 4: Tell Aegis where the project is.  To  do  this,  use
the -dir and -keep options of the [4maenpr[24m(1) command.

[1m6.1.2.  From outside Aegis[0m

This  works  best  of  the  project  is  staying on the same
machine, or the same NFS network.

Step 1: You need to  know  where  in  the  file  system  the
project currently resides.  Take a look in the projects list
(ael p) and see the directory reported for the trunk of  the
project.  Ignore any active branches.

Step 2: Move the files to the new location.




Page 18         (lib/en/howto/move_projec.so)   Peter Miller





Aegis                                                  Howto


Step  3:  Edit  the /usr/local/com/aegis/state file and edit
the path appropriately to tell Aegis  where  you  moved  the
files to.  You will need to be root for this step.

[1m6.2.  Renaming a Project[0m

This  section  deals  with changing a project's name without
moving is files.

[1m6.2.1.  From within Aegis[0m

Step 1: You need to  know  where  in  the  file  system  the
project currently resides.  Take a look in the projects list
([4mael[24m [4mp[24m) and see the directory reported for the trunk of  the
project.  Ignore any active branches.

Step  2:  Usually,  when you remove a project, Aegis deleted
all of the project files.  However  the  aerm  -keep  option
tells  Aegis to remove the project name, but keep all of the
project files.

Step 3: Tell Aegis where the project is, using the new name.
To  do  this, use the -dir and -keep options of the [4maenpr[24m(1)
command.

[1m6.2.2.  From outside Aegis[0m

Step 1: Edit the /usr/local/com/aegis/state  file  and  edit
the  name  appropriately  to  tell Aegis the new name of the
project.  You will need to be root for this step.

[1m6.2.3.  Project Aliases[0m

You may need  some  transition  time  for  your  developers.
Either  before or after you rename the project, you may want
to consider adding a project alias (see  [4maenpa[24m(1)  for  more
information)  so  that  the  project  has "both" names for a
while.



















Peter Miller      (./lib/en/howto/main.ms)           Page 19





Howto                                                  Aegis


[1m7.  Working in Teams[0m

Aegis supports teamwork in two basic ways: local development
and  distributed development.  Local development breaks down
into a single machine, and networked machines  on  a  common
LAN.   By  building the description a little at a time, this
section will show how each of these modes of development are
related in the model used by Aegis.

[1m7.1.  Local[0m


[1m7.1.1.  Single User, Single Machine[0m

The simplest case to understand is the single user.  In such
an environment, there  is  a  project  and  the  user  makes
changes  to  this  project in the usual way described in the
User Guide and earlier sections of this How-To.

Even in this environment, it is often the case that a single
user  will  be  working on more than one thing at once.  You
could have a large new feature being added, and a series  of
bug  fixes  happening  in parallel during the course of this
development.  Or some-one may  interrupt  you  with  a  more
important  feature  they need to be added.  Aegis allows you
to simply and rapidly create as many or as  few  independent
changes (and development directories) as required.

By  using  independent  work areas, things which are not yet
completed cannot  be  confused  with  immediate  bug  fixes.
There is no risk of untested code "contaminating" a bug fix,
as would be the case in one large work area.

[1m7.1.2.  Multi User, Single Machine[0m

Having multiple developers working on the  same  project  is
very  little different than having one developer.  There are
simple many changes all being worked on in  parallel.   Each
has  its  own  independent work area.  Each is independently
validated before it may be integrated.

One significant difference with multiple developers is  that
you  now  have  enough people to do real code reviews.  This
can make a huge difference to code quality.

[1m7.1.3.  Multi User, Multi Machine[0m

Aegis assumes that when working on a LAN,  you  will  use  a
networked  file  system,  of some sort.  NFS is adequate for
this task, and commonly available.  By using NFS,  there  is
very  little  difference between the single-machine case and
the multi-machine case.





Page 20          (lib/en/howto/team_work.so)    Peter Miller





Aegis                                                  Howto


There are some system administration constraints imposed  by
this, however: it is assumed that each machine is apparently
"the same", in terms of environment.

[1m7.1.3.1.  General Requirements[0m

You need some sort of network file system  ([4me.g.[24m  NFS,  AFS,
DFS), but it needs working locks ([4mi.e.[24m not CODA at present).
I'll assume the ubiquitous NFS for now.

+o You need exactly the same [4m/etc/passwd[24m and [4m/etc/group[24m  file
  on  every machine.  This gives a uniform environment, with
  uniform security.  (It also gets the UIDs right, which NFS
  needs.)  Keeping [4m/etc/passwd[24m and [4m/etc/group[24m in sync across
  more than about 3 machines can be time consuming and error
  prone  if  done manually - so don't.  Use NIS or similar -
  do sys admin once, automatically takes effect  everywhere.

+o All  of  the  machines  see the same file systems with the
  same path names as all the others.   (Actually,  you  only
  need worry about the ones Aegis is interested in.)  Again,
  you can try to keep all those  [4m/etc/fstab[24m  files  in  sync
  manually,  but  you are better off using NIS (or NIS+) and
  the automounter or amd.

+o All of the machines need their clocks synchronized.   Oth-
  erwise tools which use time stamps (obviously [4mmake[24m(1), but
  also a few others) will get confused.  NTP  or  XNTP  make
  this  simple  and  automatic.   In  a  pinch,  you can use
  [4mrdate[24m(1) from cron every 15 minutes.

+o Many sites are worried about the security  of  NFS.   Usu-
  ally,  you  need to take the root password away from work-
  station users; once the environment is uniform across  all
  of  them,  the  need  for  it usually disappears.  It also
  means they can't abuse NFS,  and  they  can't  run  packet
  sniffers,  either.   By  using  netgroups (I'm [4mnot[24m talking
  about the [4m/etc/groups[24m file) you can further  restrict  who
  NFS  will  talk to.  By using NIS+ and NFSv3 you can quash
  the last couple of security issues, but  unless  you  have
  military contracts, it's rarely worth it.

Fortunately, NFS and NIS readily available, both for propri-
etary systems and open  source  systems.   Large  sites  use
these  techniques successfully and securely - and they [1mdon't[0m
have [4mO(n^2)[24m or even [4mO(n)[24m sys admin issues, they get most sys
admin tasks down to [4mO(1)[24m.

But,  [4mbut[24m,  [1mbut!   [22mMany sites are [4mvery[24m concerned about being
able to work when the server(s) are down.  I agree,  however
I  suggest  sweet talking your sys admin, not bashing NFS or
NIS or Aegis.  It is possible to get very high  availability
from  modern  systems  (and even ancient PCs, using Linux or
BSD).



Peter Miller     (lib/en/howto/team_work.so)         Page 21





Howto                                                  Aegis


The fact is, working in a team requires  interaction.   Lots
of  interaction.   It is an illusion that you can work inde-
pendently indefinitely.  In the  ultimate  siege  mentality,
you  need  a full and complete private copy of everything in
order to pull this off; but expect the other team member  to
carefully inspect everything you produce this way.

[1m7.1.3.2.  Aegis-specific Requirements[0m

There  are  a  couple  of things required, once you have the
above up and running.

+o All of the Aegis distribution can be installed locally for
  performance,  if  that's  what you need.  (Except, see the
  next item.)  Or, you can install it all on an NFS  mounted
  disk,  which guarantees everyone is always running exactly
  the same software revision which can sometimes  be  impor-
  tant (shortens upgrade times, too.)

+o Except  the  [4m${prefix}/com/aegis[24m  directory, which must be
  the one NFS disk mounted by every single  machine  identi-
  cally,  and  must be read write.  [4mI.e.[24m unique to the whole
  network (well, all machines using Aegis).  This  is  where
  the  pointer  to  the projects are kept, and this is where
  the database locks are kept.  If this directory isn't com-
  mon  to  every  machine,  the  Aegis database will quickly
  become corrupted.

+o The project directory tree must be on an  NFS  disk  which
  all  machines  see,  and must be the same absolute path on
  all machines.  This is  so  that  the  absolute  paths  in
  [4m${prefix}/com/aegis/state[24m mean something.

+o The  development directories need to be on NFS disks every
  machine can see.  Usually, this means a common home direc-
  tory  disk,  or a common development directory disk.  This
  can still be a disk local to  the  workstation,  but  they
  must all be exported, and all must appear in the automount
  maps.  This is because Aegis assumes that  every  worksta-
  tion  has  a uniform view of the entire system (so reviews
  can review your development directory, and integrators can
  pick up the new files from your development directory).

Large software shops have used these techniques without dif-
ficulty.

[1m7.1.4.  Known Problems[0m

There is a known problem with the HP/UX NFS clients.  If you
see  persistent  "no  locks  available"  error messages when
[4m/usr/local/lib/aegis[24m  is  NFS  mounted,   try   making   the
[4m/usr/local/lib/aegis/lockfile[24m file world writable.





Page 22          (lib/en/howto/team_work.so)    Peter Miller





Aegis                                                  Howto


     chmod 666 /usr/local/lib/aegis/lockfile

There  is  the  possibility of a denial of service attack in
this mode (which is why the default is 0600) but  since  you
are presently denied service anyway, it's academic.

[1m7.2.  Distributed[0m

The  distributed  functionality  of  Aegis is designed to be
able to  operate  through  corporate  firewalls.   Corporate
firewall  administrators,  however,  take a very dim view of
adding holes to the for proprietary protocols.  Aegis, as  a
result,  requires  none.  Instead it uses existing protocols
such as e-mail, FTP  and  HTTP.   It  will  even  work  with
"sneaker net" (hand carried media).

The  other  aspect of Aegis, which you have probably noticed
already, is that it is very keen on security.   Security  of
the "availability, integrity and confidentiality" kind.

Incoming  change  sets are subject to the same scrutiny as a
change set produced locally.  It  is  dropped  into  a  work
area,  built  and tested, before being presented for review.
Just like any local change set would be.

[1m7.2.1.  Multiple Single-User Sites[0m

In the case of an Open Source project  maintainer,  this  is
essential,  because  incoming  contributions  are of varying
quality, or may interact  in  unfortunate  ways  with  other
received  change sets.  This careful integration checking is
essential.  Imaging the chaos which could ensure  if  change
sets   were   unconditionally  dropped  into  the  baseline.
(Deliberate malice or sabotage, of course, also being a grim
possibility.)

The  careful  reader  will by now be squirming.  "How", they
wonder, "can  the  maintainer  examine  every  change  every
developer makes.  Surely it doesn't scale?"

Indeed, it would not.  Aegis provides a mechanism for aggre-
gating changes into "super changes".  These  larger  changes
can  then  be shipped around.  (See the Branching chapter in
the User Guide for more information.)

In the reverse direction, from the  maintainer  out  to  the
developer,  developers  in  an  Open Source project probably
aren't going to want to see each and every change  set  made
to  the  project.   Again, they can use an aggregation ([4me.g.[0m
grab the latest snapshot when each release is announced)  to
re-sync  in  larger  chunks,  less often.  The chances of an
intersection are fairly low (otherwise someone is  duplicat-
ing effort) so the merge is usually quite simple.




Peter Miller     (lib/en/howto/team_work.so)         Page 23





Howto                                                  Aegis


[1m7.2.2.  Multiple Multi-User Sites[0m

Most  distributed large-scale corporate operations are actu-
ally similar to Open Source projects,  though  they  usually
have  more staff.  There is usually a "senior" site, and the
other sites make their contributions, which are  scrutinized
carefully before being promoted to full acceptance.

Again,  aggregations become essential to the system integra-
tion phase of a product.  There may even be a  hierarchy  of
concentrators along the way.

Junior corporate sites can sync periodically with the senior
site, too, rather than double handle (or worse) every change
set.

[1m7.2.3.  Telecommuting[0m

One of the most desired cases is that of telecommuting.  How
do remote worker, who may never make  it  into  the  office,
develop projects using Aegis?

There are many way to do this, but the simplest is to have a
central cite ("the office") with satellite developers.

[1m7.2.3.1.  Office to Developer[0m

The office makes available a web interface to  Aegis.   From
this,  it is possible to download individual changes, branch
updates, or whole projects.  All of this is already  present
in the Aegis distribution.

However,  many corporate sites are not going to want to make
all of their intimate development details to comprehensively
available  on  the  web.   For  such  sites, I would suggest
either a direct "behind the firewall" dial-in, or some  vir-
tual  private networking software (which means users can use
a local ISP, and still be treated "as if" they  were  behind
the firewall).

If  a VPN won't fly (due to company security policies), then
selected encrypted updates could  be  posted  "outside",  or
perhaps  an procmail "change set service" could be arranged.

[1m7.2.3.2.  Developer to Office[0m

It is unlikely (though possible) that you would have  a  web
server  on the developer's machine - usually you aren't con-
nected, to the office pulling changes sets back is  probably
not viable.

The  simplest  mechanism  is  for the satellite developer to
configure their Aegis project so that the trunk  tracks  the
office  version.   Once  a  week  (or  more often if you get



Page 24          (lib/en/howto/team_work.so)    Peter Miller





Aegis                                                  Howto


notified something significant has happened) pull  down  the
latest version of "the office" as a change set and apply it.
This way, the trunk tracks the official version.

The developer works in a sub-branch, with aeipass configured
to  e-mail  branch  integrations  (but not individual change
sets) back to the office.  In this way, a work  package  can
be  encapsulated  in  a branch, and sent when finished.  You
also have the ability to manually send  the  branch  at  any
earlier  state, and it still encapsulates the set of changes
you have made to date.














































Peter Miller      (./lib/en/howto/main.ms)           Page 25





Howto                                                  Aegis


[1m8.  How to use Aegis with Python[0m

This section describes how to use  Aegis  to  supervise  the
development of Python programs.  Some of the remarks in this
section may also be helpful  to  people  who  use  Aegis  to
supervise development in other non-compiled languages.

This  section  is  contributed courtesy of Tangible Business
Software, www.tbs.co.za.  Python-specific questions relating
to   this   section   may   be   sent  to  Pieter  Nagel  at
<pnagel@tbs.co.za>.

[1m8.1.  Handling Aegis search paths[0m

[1m8.1.1.  The Aegis model vs. the Python model[0m

Aegis' view of a project is that it consists of a  hierarchy
of  project baselines.  Each baseline consists of only those
files that were modified as part of that (sub)project,  plus
all files that were built by the DMT (see the section of the
[4mUser[24m [4mGuide[24m called [4mThe[24m [4mDependency[24m [4mMaintenance[24m  [4mTool[24m).   Aegis
expects  the  DMT  to  be able to collect the entire project
into one piece by searching up this baseline search path for
all needed files.

This  works  fine  when  using statically compiled languages
such as C.  The build process "projects" source  files  from
various  Aegis baselines onto one or more executables.  When
these are run they do not need to search through  the  Aegis
search  path  for parts of themselves; they are already com-
plete.

Python programs, however, are never compiled and linked into
a single executable.  One could say that a Python program is
re-linked each time it is run.  This means that  the  Python
program  will need to be able to find its components at run-
time.  More importantly, it will need to avoid importing the
old  versions of files from the baseline when newer versions
are present in the development or integration directories.

[1m8.1.2.  The solution[0m

The simplest (and only recommended) way to marry  Aegis  and
Python  is  to  configure Aegis to keep all of the project's
files visible in a the development and integration  directo-
ries,  at  all  times.   That way Aegis' search path becomes
irrelevant to Python.

Use Aegis version 3.23 or later, and set  the  following  in
the project [4mconfig[24m file:







Page 26           (lib/en/howto/python.so)      Peter Miller





Aegis                                                  Howto


     create_symlinks_before_build
         = true;
     remove_symlinks_after_integration_build
         = false;

The second directive is not available in earlier versions of
Aegis.

If you keep your Python files  in  a  subdirectory  of  your
project,  such as [4msrc/python[24m, you will need that directory's
relative in your [4mPYTHONPATH[24m  whenever  Aegis  executes  your
code for testing, i.e. by setting

     test_command="\
     PYTHONPATH=$$PYTHONPATH:src/python \
     python [4m...[24m";

in  your  project  configuration  file (example split across
multiple lines for formatting only).

It may seem strange to you that we are not substituting  the
Aegis  [4mSearch_Path[24m variable into [4mPYTHONPATH[24m at all - it does
at first seem to be the solution that is  called  for.   The
reason why we don't is very simple: [4mit[24m [4mdoes[24m [4mnot[24m [4mwork[24m.  It is
worth stressing the following rule:

[1mNever inject any absolute path of any  Aegis  baseline  into[0m
[1mthe Python search path.[0m

[1m8.1.3.  Why setting PYTHONPATH to the Aegis search path will[0m
[1mnot work[0m

The reason why [4mPYTHONPATH[24m does not work as Aegis expects  is
due  to  the  way  Python searches for packages.  For a full
explanation of what packages are, you can see [4mSection[24m [4m6.4[24m of
the  [4mPython[24m [4mTutorial[24m, but the crucial point is that a Python
package consists of a directory with an [4m__init__.py[24m file  in
which  the  other  files  in  that directory which should be
treated as part of that package are listed.

When Python imports anything from a  package,  Python  first
searches for the [4m__init__.py[24m file and remembers the absolute
path of the directory where it found it.  It will thereafter
search  for  all  other parts of the package within the same
directory.   Without  the  [4mcreate_symlinks_before_build[24m  and
[4mremove_symlinks_after_integration_build[24m   settings  enabled,
all the needed files are not guaranteed to [4mbe[24m present in one
directory  at  all  times, however; they will most likely be
spread out over the entire Aegis search path.

The result is that if you were to try and use  the  approach
of  setting the [4mPYTHONPATH[24m to the Aegis search path, package
import will mysteriously fail under (at  least)  two  condi-
tions:



Peter Miller      (lib/en/howto/python.so)           Page 27





Howto                                                  Aegis


+o Whenever  you modify a file in a package without modifying
  the  accompanying  [4m__init__.py[24m,  Python  will   find   the
  [4m__init__.py[24m  file in the baseline and import the [4mold[24m files
  from there.

+o Whenever you modify the [4m__init__.py[24m and leave  some  other
  file  in  the  package  unmodified,  Aegis  will  find the
  [4m__init__.py[24m in the development/integration  directory  but
  fail to find the unmodified files there.

[1m8.2.  The build step[0m

Python programs do not need to be built, compiled, or linked
before they can be run, but Aegis requires a build  step  as
part of the development cycle.

One  perfectly  valid  option  is  to explicitly declare the
build step to be a no-op, by setting

     build_command = "true";

in the project configuration file. [4mtrue[24m(1) is a Unix command
which is guaranteed to always succeed.

In  practice,  however,  there often are housekeeping chores
that can be done as part of the build process,  so  you  can
just as well go ahead and create a Makefile, Cook recipe, or
script that performs these tasks and make  that  your  build
step.

Here are some examples of tasks that can be performed during
the build step:

+o Setting the executable flag on your main  scripts.   Aegis
  does  not  store file modes, but it is often convenient to
  have one or more  of  the  Python  source  files  in  your
  project be executable, so that one does not need to invoke
  Python explicitly to run them.

+o Delete unwanted Python object files ([4m.pyc[24m and [4m.pyo[24m files).
  These  could  arise  when  you  aerm  and  delete a Python
  script, but  forget  to  delete  the  accompanying  Python
  object  file(s).   Other files will then mysteriously suc-
  ceed in importing the removed  scripts,  where  you  would
  expect them to fail.  Your build process could use [4mael[24m [4m-cf[0m
  and [4mael[24m [4m-pf[24m) to get  a  list  of  'allowed'  scripts,  and
  remove  all Python object files which do not correspond to
  any of these.

+o Auto generate your  packages  [4m__init__.py[24m  files.   Python
  wants  you  to  declare  your  intent  to have a directory
  treated as a package  by  creating  the  [4m__init__.py[24m  file
  (otherwise  a  stray  directory  with  a  common name like
  'string', 'test', 'common' or  'foo'  could  shadow  like-



Page 28           (lib/en/howto/python.so)      Peter Miller





Aegis                                                  Howto


  named  packages  later  on in the search path).  But since
  Aegis is, by definition, an authoritative source  on  what
  is  and  what  is  not part of your program it can just as
  well declare your intent for you.

[1m8.3.  Testing[0m

Testing under Aegis using Python is no  different  from  any
other  language, only much more fun.  Python's run-time type
checking makes it  much  easier  to  develop  software  from
loosely-coupled  components.   Such components are much more
suited to unit testing than strongly-coupled components are.

If  the  testing  script which Aegis invokes is part of your
project, there is one important  [4mPYTHONPATH[24m-related  caveat:
when  Aegis  runs the tests, it specifies them with an abso-
lute path.  When Python runs any scripts  with  an  absolute
path, it prepends that path to its search path, and the dan-
ger is that the baseline directory (with the old,  unchanged
versions  of  files)  is  prepended  to the search path when
doing regression testing.

The solution is to use code like this to remove  the  test's
absolute path from the Python path:

     selfdir = os.path.abspath(sys.argv[0])
     if selfdir in sys.path:
         sys.path.remove(selfdir)


Instead  of copying these lines into each new test file, you
may want to centralize that code in  a  test  harness  which
imports  and  runs the tests on Aegis' behalf.  This harness
can also serve as a central place where  you  can  translate
test  success  or  failure  into  the  exit  statuses  Aegis
expects.

The test harness must take care to import  the  file  to  be
tested  without needing to add the absolute path of the file
to [4msys.path[24m.  Use [4mimp.find_module[24m and [4mimp.find_module[24m.

I can strongly recommend [4mPyUnit[24m,  the  [4mPython[24m  [4mUnit[24m  [4mTesting[0m
[4mFramework[24m  by  Steve  Purcell,  available  from  http://pyu-
nit.sourceforge.net.  It is based on  Kent  Beck  and  Erich
Gamma's  [4mJUnit[24m  framework  for Java, and is becoming the [4mde-[0m
[4mfacto[24m standard testing framework for Python.

One bit of advice when using [4mPyUnit[24m: like Aegis, [4mPyUnit[24m also
distinguishes  between  test  failures  as  opposed  to test
errors, but I find it best to report [4mPyUnit[24m test  errors  as
Aegis  test failures.  This is to ensure that baseline tests
fail as Aegis expects them to.  [4mPyUnit[24m will consider a  test
which  raises  anything other than a [4mAssertionError[24m to be an
'error', but in practice baseline test  failures  are  often



Peter Miller      (lib/en/howto/python.so)           Page 29





Howto                                                  Aegis


[4mAttributeError[24m  exceptions which arise when the test invokes
methods not present in the old code.  This is  a  legitimate
way  to  verify,  as  Aegis  wants us to, that the test does
indeed invoke and test functionality which  is  not  present
the old code.

[1m8.4.  Running your programs[0m

Of  course you will at some stage want to run the program(s)
you are developing.

The simplest approach is to have your program's main  script
be   located   at   the  top  of  your  Python  source  tree
([4msrc/python[24m) in our example.  Whenever you run that  script,
Python  will automatically add the directory it was found in
to the Python path, and will find all your other files  from
there.

You  can  safely  let your shell's [4mPATH[24m environment variable
point to that script's location, since the  shell  [4mPATH[24m  and
the [4mPYTHONPATH[24m do not mutually interfere.

Just  avoid  the temptation to set the absolute path of that
script into your [4mPYTHONPATH[24m, or otherwise  your  development
code and baseline code will interfere with each other.  This
is not an Aegis-specific problem, though, since there  would
be potential confusion on any system, in any language, where
two versions of one program are simultaneously visible  from
the same search path.




























Page 30           (./lib/en/howto/main.ms)      Peter Miller





Aegis                                                  Howto


.
























































Peter Miller      (./lib/en/howto/main.ms)           Page 31





Howto                                                  Aegis


[1m9.  Howto End A Branch[0m

"OK,  I  give  up.   I  do  not  understand  the  ending  of
branches."

Usually, you end development of a branch the  same  way  you
end development of a simple change.  In this example, branch
[4mexample.1.42[24m will be ended:

     % [1maede -p example 1 -c 42[0m
     aegis: project "example.1": change 42: file "[4mfubar[24m" in
     the baseline has changed since the last 'aegis -DIFFer-
     ence' command, you need to do a merge
     %

Oops.  Something went wrong.  Don't panic!

I'm going to assume, for the purposes of explanation, that
there have been changes in one of the  ancestor branches,
and thus require a merge, just like file [4mfubar[24m, above.

You need to bring file [4mfubar[24m up-to-date.  How?  You do it in
a change set, like everything else.

At his point you need to do 5 things: (1) create a new
change on example.1.42, (2) copy [4mfubar[24m into it, (3) merge
[4mfubar[24m with branch "example.1" (4) end development of the
change and integrate it, and (5) now you can end exam-
ple.1.42

The -GrandParent option is a special case of the -BRanch
option.  You are actually doing a cross-branch merge, just
up-and-down rather than sideways.

     % [1maem -gp [4m[22mfubar[0m
     %

And manually fix any conflicts... naturally.

At this point, have a look at the file listing, it will show
you something you have never seen before - it will show you
what it is [4mgoing[24m [4mto[24m set the branch's edit_number_origin to
for each file, at [4maeipass[24m.

     % [1mael cf[0m
     Type   Action Edit        File Name
     ------ ------ -------     -----------
     source modify 1.3         aerect/rect.c
                   {cross 1.2}

Now finish the change as usual...  [4maeb,[24m [4maed,[24m [4maede,[24m [4maerpass,[0m
[4maeib,[24m [4m...,[24m [4maeipass[24m nothing special here.





Page 32           (lib/en/howto/branch.so)      Peter Miller





Aegis                                                  Howto


One small tip: merge file files one at a time.  It makes
keeping track of where you are up to much easier.

Now you can end development of the branch, because all of
the files are up-to-date.

In some cases, Aegis has detected a logical conflict where
you, the human, know there is none.  Remember that the [4maem[0m
command saves the old version of the file with a ,B suffix
(`B' for backup).  If you have a file like this, just use

     % [1mmv [4m[22mfubar[24m[1m,B [4m[22mfubar[0m
     %

to discard everything from the ancestor branch, and use the
current branch.









































Peter Miller      (./lib/en/howto/main.ms)           Page 33





Howto                                                  Aegis


[1m10.  How to Become an Aegis Developer[0m

This section describes how to become an Aegis developer, and
gives some procedures, some ideas of areas which need work,
and some general guidelines.

Please note: if these instructions have a problem, let some-
one know!  If you are having a problem, so is the next guy.
[4mPlease[24m send all problem reports to Peter Miller
<millerp@canb.auug.org.au>

[1m10.1.  Required Software[0m

There are a number of pieces of software you will need to
work on Aegis.

+o It will probably come as no surprise that Aegis is devel-
  oped using Aegis (never trust a skinny chef) so the first
  thing you need is to install Aegis and become familiar
  with using it.  You will need Aegis 4.24.3 or later.

+o You will need a C++ compiler.  If your compiler is
  installed in an uncommon directory or has an uncommon
  name, you can set the appropriate attribute by editing the
  [4maegis.conf.d/site.conf[24m file.

+o You will need to install Cook, in order to build things.
  Version 2.8 or later, preferably you should track the lat-
  est release.
  http://www.canb.auug.org.au/~millerp/cook/

+o GNU Autoconf 2.53 or later.
  http://ftp.gnu.org/pub/gnu/autoconf/
  If your tools are installed in an uncommon directory or
  have an uncommon name, you can set the appropriate
  attribute by editing the [4maegis.conf.d/site.conf[24m file.

+o GNU Automake.
  http://ftp.gnu.org/pub/gnu/automake/

+o You will need to install FHist, for the history tool.
  http://fhist.sourceforge.net/

+o You will need to install [4mtardy[24m, for manipulating tarballs.
  http://miller.emu.id.au/pmiller/software/tardy/

+o You will need to install [4mptx[24m(1), for the permuted indexes
  in the documentation.  This is now part of GNU coreutils.
  http://ftp.gnu.org/pub/gnu/coreutils/

+o You need psutils for the [4mpsselect[24m utility, to manipulate
  the documentation files, mostly to put the tables of con-
  tents at the start, rather than at the end as GNU Groff
  generates them.



Page 34          (lib/en/howto/developer.so)    Peter Miller





Aegis                                                  Howto


  http://www.dcs.ed.ac.uk/home/ajcd/psutils/

+o You will need the developer libraries for the [4mrx[24m library
  (if you installed from the tarball, you have these, but if
  you installed from RPM, you need the -devel package as
  well).
  http://ftp.gnu.org/pub/gnu/rx/

+o You will need the developer libraries for the [4mzlib[24m library
  (if you installed from the tarball, you have these, but if
  you installed from RPM, you need the -devel package as
  well).
  http://www.gzip.org/zlib/

+o You will need the developer libraries for the [4mlibcurl[0m
  library (if you installed from the tarball, you have
  these, but if you installed from RPM, you need the -devel
  package as well).
  http://curl.haxx.se/

+o You need UUID generation capability.  This requirement may
  be satisfied in several different ways depending of your
  development platform.
  First, on GNU/Linux you could skip this requirement pro-
  vided that your kernel has support for [4m/proc[24m filesystem.
  Please note: in order to work [4m/proc[24m must be mounted and
  [4m/proc/sys/kernel/random/uuid[24m must be present.
  Second, you could install the developer libraries for the
  [4me2fsprogs[24m package (if you installed from the tarball, you
  have these, but if you installed from RPM you need the
  -devel package as well).
  http://e2fsprogs.sourceforge.net/
  Third, you could install the UUID library from OSSP:
  http://www.ossp.org/pkg/lib/uuid/
  Fourth, if your platform has support for an API compliant
  with DCE 1.1, Aegis also supports the DCE API.

+o The GNOME libxml2 library (http://xmlsoft.org/) is used to
  parse XML, you will need version 1.8.17 or later.  You do
  not have to install the rest of GNOME as this library is
  able to be used by itself.  This package is [1mnot [22moptional,
  you need it to successfully build Aegis.

+o You need to install Bison, the GNU replacement for Yacc.
  http://ftp.gnu.org/pub/gnu/bison/

+o You will need to install Flex, the GNU replacement for
  Lex.
  http://ftp.gnu.org/pub/gnu/non-gnu/flex/

+o You need to GNU Gettext (0.16.1 or later) tools installed.
  Even though Glibc 2.0 and later include Gettext, you need
  the developer tools as well.  (You need GNU Gettext even
  on Solaris, because the Solaris Gettext implementation is



Peter Miller     (lib/en/howto/developer.so)         Page 35





Howto                                                  Aegis


  less than adequate.)
  http://ftp.gnu.org/pub/gnu/gettext/

+o You need GNU Ghostscript, for the ps2pdf utility, so that
  you can create PDF documents.
  http://ftp.gnu.org/pub/gnu/ghostscript/

+o You need a [4muudecode[24m with a -o option (to redirect the out-
  put).  It is part of GNU Sharutils.
  http://ftp.gnu.org/pub/gnu/sharutils/

+o You need to install GNU awk.
  http://ftp.gnu.org/pub/gnu/gawk/

+o You need a [4mctags[24m(1) command with a -L option (to read file
  names from standard input).
  http://ctags.sourceforge.net/

+o You need RCS installed for the automated tests.
  http://ftp.gnu.org/pub/gnu/rcs/

+o You need to install [4msudo[24m(8).  See etc/set-uid-root in the
  distribution for how to configure the [4m/etc/sudoers[24m file.
  ftp://ftp.sudo.ws/pub/sudo/

+o The location box icon is generated using [4mconvert[24m from
  ImageMagick, but the build can cope if you don't have it.
  http://www.imagemagick.org/

+o The PNG images are optimized by the [4mpngcrush[24m command.
  http://pmt.sourceforge.net/pngcrush/

+o The location box icon is generated using [4mpng2ico[24m but the
  build can cope if you don't have it.
  http://www.winterdrache.de/freeware/png2ico/

+o It is possible to use the dmalloc library for debugging
  memory abuses.  Be warned: the dmalloc library can be
  instructed to log to a file, circumventing the Aegis I/O
  layer, thus it's possible to create file owned by root.
  The dmalloc library should only ever be used as a debug-
  ging tool, and [4mnever[24m be used in a production build of
  Aegis.
  http://dmalloc.com/
  On a Debian system, use the apt-get install libdmalloc-dev
  command.
  You will need to aecp the etc/Howto.cook file to alter the
  build to use the dmalloc library.

+o [4mProbably[24m [4mmore[24m [4mthings[24m [4mI've[24m [4mforgotten.[0m

+o Some parts of the build need Perl





Page 36          (lib/en/howto/developer.so)    Peter Miller





Aegis                                                  Howto


[1m10.2.  Create The Aegis Project[0m

The next thing to do is create an Aegis project to hold the
Aegis source.  This is done in the usual way.  I suggest you
create branches which match the current public release, [4me.g.[0m
it is 4.24.3 at present.

The best-practice technique of having a separate user
account to mind the sources is recommended.  The following
commands should be run as that user, not your usual login.
This prevents a variety of accidents which can happen when
you are browsing the baseline (master source).

You could use the following command:

     % [1maenpr aegis.4.24.3[0m
     aegis: project "aegis": created
     aegis: project "aegis.4.24.3": created
     %

but experienced Aegis users will know that this means a
laborious setting of project attributes.  It is easier to
create the top-level project, set the attributes, and the
create the branches, so that they inherit the attributes on
creation.

     % [1maenpr aegis -version -[0m
     aegis: project "aegis": created
     % [1maepa -e -p aegis[0m
     [4medits[24m [4mthe[24m [4mproject[24m [4mattributes[24m [4mfor[24m [4msingle[24m [4muser,[0m
     [4mor[24m [4myou[24m [4mmay[24m [4mfind[24m tkaepa [4measier[0m
     % [1maena -p aegis [4m[22myou[0m
     aegis: user "[4myou[24m" is now a administrator
     % [1maend -p aegis [4m[22myou[0m
     aegis: user "[4myou[24m" is now a developer
     % [1maenrv -p aegis [4m[22myou[0m
     aegis: user "[4myou[24m" is now a reviewer
     % [1maeni -p aegis [4m[22myou[0m
     aegis: user "[4myou[24m" is now an integrator
     % [1maenbr -p aegis 4[0m
     aegis: project "aegis.4": created
     % [1maenbr -p aegis.4 24[0m
     aegis: project "aegis.4.24": created
     % [1maenbr -p aegis.4.24 3[0m
     aegis: project "aegis.4.24.3": created
     %


At this point, the rest of the commands in this chapter may
(should!) be executed as "[4myou[24m," your usual login account.
When you added your normal account as an administrator just
now, you authorized yourself to perform the necessary
actions.




Peter Miller     (lib/en/howto/developer.so)         Page 37





Howto                                                  Aegis


You will need about 120MB of free space to build and inte-
grate Aegis changes, or more, depending on the changes you
make and the size of your development directories.

The [4m.forward[24m file of the "aegis" user needs to be set to
someone appropriate to read mail directed at the project.

You can now set the "aegis" user's password field to "*".
This effectively prevents the "aegis" user from logging in.
Aegis is designed to make this unnecessary from now on.

[1m10.3.  The Download[0m

The Aegis project is distributed in the form of an [4maedist[24m(1)
change set.  The file to download is called
http://aegis.sourceforge.net/aegis-4.24.3.ae and can be
grabbed using your favorite web browser, or [4mwget[24m(1).

The downloaded change set is applied using the following
command

     % [1maedist --receive \[0m
         [1m-f aegis-4.24.3.ae \[0m
         [1m-p aegis.4.24.3[0m
     [4m...lots[24m [4mof[24m [4moutput...[0m
     %


It is a good idea to give the project name on the command
line, or [4maedist[24m will try to use the project name it finds in
the change set, and it probably wont find it if you are
using different numbering to the chief maintainer's copy.

The [4maedist[24m command will, in turn, issue a number of other
commands.  These are all normal Aegis commands you could
issue yourself, if you were familiar with Aegis.  It will,
however, stop with a moderately alarming message:

  Warning: This change contains files which could host a
  Trojan horse attack.    You should review it before build-
  ing it or testing it or completing development.  This
  change remains in the [4mbeing[24m [4mdeveloped[24m state.

This message comes because in order to build the project,
you are going to have to execute a number of commands con-
tained in the project [4maegis.conf[24m file, and in the
[4metc/Howto.cook[24m file.  For your own protection, [4maedist[24m stops
at this point.  You may want to inspect these two files
before continuing.

[4mI[24m [4mreally[24m [4mmust[24m [4mget[24m [4maround[24m [4mto[24m [4msigning[24m [4mit[24m [4mwith[24m [4mPGP.[24m  [4mThis[24m [4mwould[0m
[4mmake[24m [4mthe[24m [4m-notrojan[24m [4moption[24m [4msafe,[24m [4mbecause[24m [4myou[24m [4mcould[24m [4mtell[24m [4mthe[0m
[4mfile[24m [4mis[24m [4mdirect[24m [4mfrom[24m [4mthe[24m [4mchief[24m [4mmaintainer,[24m [4mand[24m [4mthus[24m [4mas[0m
[4mtrustable[24m [4mas[24m [4myou[24m [4mthink[24m [4mthe[24m [4mchief[24m [4mmaintainer[24m [4mhappens[24m [4mto[24m [4mbe.[0m



Page 38          (lib/en/howto/developer.so)    Peter Miller





Aegis                                                  Howto


In order to complete development of the change set, you must
first build it...

     % [1mae_p aegis.4.24.3[0m
     % [1maecd[0m
     % [1maeb[0m
     [4m...you[24m [4mwill[24m [4msee[24m [4mcommands[24m [4mwhich[24m [4mbuild[24m [4mthe[24m [4mproject...[0m
     %


Things that can go wrong...

+o There are checks to make sure that there is no white space
  on the ends of lines.  If you use Emacs, you can add

       (add-hook 'write-file-hooks
           'delete-trailing-whitespace)

  to have this done automagically.  The same checks also
  verify that the text files are all printable, and that
  line lengths are 80 characters or less.  Please don't dis-
  able the checks, it makes accepting your patches more time
  consuming.

+o Each change set has an architecture list associated with
  it.  Initially you won't care, but Aegis does if you see
  the following error message:
    found 1 unlisted architecture, edit the change
    attributes to remove it or edit the project configura-
    tion file to add it
  You need to use the [4maeca[24m [4m-e[24m command ([4mnot[24m the tkaeca com-
  mand).  You will be placed into an editor (usually [4mvi[0m
  unless you have used Aegis before, and know how to config-
  ure it differently).  You need to leave just about every-
  thing alone, except for the architecture specification.
  Change it from

       architecture =
       [
           "unspecified",
       ];

  to something more meaningful on your machine.  For PC
  users, this is almost always

       architecture =
       [
           "linux-i386",
       ];

  The alternatives may be found in the [4mconfig[24m in the current
  directory (search for architecture =).  If you can't see a
  suitable choice, you may need to add one; the [4maepconf[24m(5)
  man page has more information.  Edit the [4mconfig[24m file to



Peter Miller     (lib/en/howto/developer.so)         Page 39





Howto                                                  Aegis


  contain a suitable entry, and then use the [4maeca[24m [4m-e[24m command
  to have the change agree with it.

+o If you don't have Cook installed, the build command (aeb)
  will fail.

+o If you don't have GNU Bison installed, the build will
  fail.

+o If you don't have GNU Gettext installed, the error message
  run-time binaries will not be built.  This isn't an error,
  so you can keep going, but you'll get the shorter, cryptic
  form of the error messages.

+o Please note: if these instructions have a problem, let
  someone know!  If you are having a problem, so is the next
  guy.  [4mPlease[24m send all problem reports to Peter Miller
  <millerp@canb.auug.org.au>

Once the change builds, you need to difference it (this is a
little redundant for this first command, but you'll see how
useful it is later).

     % [1maed[0m
     [4m...you[24m [4mwill[24m [4msee[24m [4mcommands[24m [4mwhich[24m [4m"diff"[24m [4mthe[24m [4mproject...[0m
     %


Things that can go wrong...

+o If you don't have the FHist package installed, the differ-
  ence (aed) will fail.  The [4mfcomp[24m command it is looking for
  is a whole-file context difference command (the GNU [1mdiff[0m
  [1m-c [22mis a bit too terse for humans).

Now you will need to test the change.  This is the basic
test suite for Aegis, it ensures nothing is broken.  It
takes a while, go grab a cup of coffee.

     % [1maet[0m
     [4m...lots[24m [4mof[24m [4moutput...[0m
     %


The change is now ready to end development.

     % [1maede[0m
     aegis: project "aegis.4.24.3": change 10:
         development complete
     %


The change set is now ready to be reviewed.  In a single-
person project like this one, you can review your own work.



Page 40          (lib/en/howto/developer.so)    Peter Miller





Aegis                                                  Howto


Obviously this is a conflict of interest, and larger
projects are usually configured to have Aegis prevent this.

     % [1maerpass -p aegis.4.24.3 -c 10[0m
     aegis: project "aegis.4.24.3": change 10:
         review pass
     %


The change is now ready to be integrated.  Only when inte-
gration is complete are the files actually committed to the
repository.

     % [1maeib -p aegis.4.24.3 -c 10[0m
     % [1maeb[0m
     [4m...you[24m [4mwill[24m [4msee[24m [4mcommands[24m [4mwhich[24m [4mbuild[24m [4mthe[24m [4mproject...[0m
     -rwsr-xr-x 1 root ... [4march[24m/bin/aegis
     -rwsr-xr-x 1 root ... [4march[24m/bin/aeimport
     -rwsr-xr-x 1 root ... [4march[24m/bin/aelock
     Integrator: please do the following:
       sudo .../baseline/etc/set-uid-root [4march[24m aegis aeimport aelock
       if they aren't root already.  See etc/set-uid-root for
       instructions for how to set-up your /etc/sudoers file.
     %


This message at the end of the build is where Aegis is made
set-uid-root in the repository.  You want to do this,
because you are going to symlink out of [4m/usr/local/bin[24m (or
wherever you installed Aegis) right into the baseline.  In
this way, you will be executing your bleeding-edge version
of Aegis, exercising it before you send it to anyone else.
Hang on a bit, the sending part comes later.

Don't know how to set these files set-uid-root?  The above
message includes the command to do it:

     $ [1mcd [4m[22mblahblah[24m[1m/delta*[0m
     [1m$ sudo etc/set-uid-root [4m[22march[24m [1maegis aeimport aelock[0m
     [1m$[0m

You will need to substitute the appropriate architecture
name, although it is likely to be "unspicified on a fresh
project.

Things that can go wrong...

+o If you don't have [4mps2pdf[24m or [4mpsselect[24m or [4mptx[24m installed, it
  won't build the documentation (this isn't an error, just
  keep going).

+o If you don't have [4mtardy[24m(1) install, it won't build the
  tarball (this isn't an error, just keep going).




Peter Miller     (lib/en/howto/developer.so)         Page 41





Howto                                                  Aegis


+o Please note: if these instructions have a problem, let
  someone know!  If you are having a problem, so is the next
  guy.  [4mPlease[24m send all problem reports to Peter Miller
  <millerp@canb.auug.org.au>

If all is OK, continue with the integration...

     % [1maed[0m
     [4m...you[24m [4mwill[24m [4msee[24m [4mcommands[24m [4mwhich[24m [4m"diff"[24m [4mthe[24m [4mproject...[0m
     % [1maet && aet -bl[0m
     [4m...lots[24m [4mof[24m [4moutput...[0m
     % [1mcd[0m
     % [1maeipass[0m
     [4m...you[24m [4mwill[24m [4msee[24m [4mcommands[24m [4mcommitting[24m [4mthe[24m [4mfiles[24m [4mto[24m [4mfhist...[0m
     aegis: project "aegis.1.0": change 10:
         integrate pass
     %


The "[4mcd[24m" command you see is actually important: you need to
be out of the development directory and integration direc-
tory so that they can be cleaned up (deleted) when the
change completes.

[1m10.4.  Supporting Several Architectures[0m

Aegis is able to track architectures to make sure that
change sets have been built and tested on all necessary
architectures.  You may hav notices that Aegis is calling
your architecture "unspecified", you can give it a more
descriptive name, too.

The architecture configuration data is described in the
[4marchitecture[24m field of the [4maepconf[24m(1) man page.  It is based
on the [4muname[24m(2) data, see the man page for how.  You will,
of course, need a change set to change it.

Once you have a change set, you need to create the
[4maegis.conf.d/architecture[24m file.

     % [1maenf aegis.conf.d/architecture[0m
     % [1maefa aegis.conf.d/architecture entire-source-hide[0m
     % [1maefa aegis.conf.d/architecture local-source-hide[0m
     %


Here are some suggestions for what you may like to set for
your architecture or architectures.









Page 42          (lib/en/howto/developer.so)    Peter Miller





Aegis                                                  Howto


     architecture =
     [
       {
         name = "linux-i386";
         pattern = "Linux-*-*-i?86";
       },
       {
         name = "linux-x86_64";
         pattern = "Linux-*-*-x86_64";
       },
       {
         name = "freebsd-i386";
         pattern = "FreeBSD-*-*-i?86";
       },
       {
         name = "sunos-4.1-sparc";
         pattern = "SunOS-4.1*-*-sun4*";
       },
       {
         name = "solaris-2.6-sparc";
         pattern = "SunOS-5.6*-*-sun4*";
       },
       {
         name = "solaris-2.6-i386";
         pattern = "SunOS-5.6*-*-i86pc";
       },
       {
         name = "solaris-7-sparc";
         pattern = "SunOS-5.7*-*-sun4*";
       },
       {
         name = "solaris-7-i386";
         pattern = "SunOS-5.7*-*-i86pc";
       },
       {
         name = "ppc-Darwin-7.x";
         pattern = "Darwin-7.*-Darwin*";
       },
     ];

Remember to only include the architectures from the above
list that you actually have.  Having architectures in this
list that you don't routinely have access to means that you
will not be able to [4maede[24m(1) any change sets.

Occasional architectures can be handled, too:











Peter Miller     (lib/en/howto/developer.so)         Page 43





Howto                                                  Aegis


     architecture =
     [
       {
         name = "ppc-Darwin-7.x";
         pattern = "Darwin-7.*-Darwin*";
         mode = optional;
       },
     ];

Again, only do this with architectures you actually have
access to.

     If you need to have architecture specific options to
some commands, you can also have [4mproject_specific[0m
attributes, too.  [1mNote [22mthat you should [4mfirst[24m look into hav-
ing a $prefix/share/config.site or $prefix/etc/config.site
file for [4m./configure[24m to read.  This is particularly impor-
tant if you want to include [4m/usr/local/include[24m,
[4m/usr/local/lib[24m, [4metc[24m, in the various compiler flags.

[1m10.5.  The Bleeding Edge[0m

As I mentioned above, the next thing to do is create sym-
bolic links out of [4m/usr/local/bin[24m into your Aegis baseline.
The reason for doing this is so that you exercise your Aegis
changes by using Aegis before you send them to anyone else.
(Never trust a skinny chef.)

There is a shell script called [4mae-symlinks[24m in the baseline
[4m$arch/bin[24m direcdtory.  Use it like this:

     $ [1maecd -bl[0m
     # [1msu[0m
     Password:
     # [1mlinux-i486/bin/ae-symlinks aegis.4.24.3[0m
     # [1mexit[0m
     $

The [4mlinux-i486[24m may need to be replaced with the output of
the [4maesub[24m [4m-bl[24m [4m'$arch'[24m command if you are using something
more interesting than a PC.

[1m10.6.  Undiscovered Country[0m

If you got this far, your local Aegis project is ready for
use.

It is strongly suggested that you complete the first change
"as is" and perform your own customizations in later
changes, rather than trying to get the project started and
customize it at the same time.

The rest of this file describes how to perform various com-
mon changes to the example project.



Page 44          (lib/en/howto/developer.so)    Peter Miller





Aegis                                                  Howto


[1m10.7.  Sending Changes[0m

First, read the Distributed Development chapter of the User
Guide.

When you have a change set you wish to have the other Aegis
deveopers try, use a simple command such as:

     aedist --send -p aegis.4.24.3 -c [4mnumber[24m | \
     gpg --clearsign | \
     mail aegis-developers@lists.sourceforge.net

or similar.  (Or maybe [4maepatch[24m(1) instead.)  A suitable sub-
ject line would be very helpful.

[1m10.8.  Guidelines[0m


[1m10.8.1.  What You Can Do[0m

Write more documentation.  There is a crying need for docu-
mentation of all sorts: better manual pages, more and better
information in the User Guide, more and better HOWTOs.  If
you work out how to do something, and it isn't in the docu-
mentation, write some documentation and put it in a change
set because other folks have probably missed it too.

Add more ease-of-use functionality.  Stuff which makes the
development process more efficient, or makes the information
in the repository more accessible.

Extend the GUI.  All of the commands which manipulate the
change while in the [4mbeing[24m [4mdeveloped[24m state are candidates.
Some kind of wrapper that ties it all together would be
good, too.  User preferences, project attributes and creat-
ing projects are candidates, too.

Most new project configuration things belong in the project
[4mconfig[24m file.  Only add new project attributes (aepa -e) for
things which (a) are catch 22 to change in a change set, or
(b) allow a security abuse if in a change set (e.g. the
notify commands, particularly aede), or (c) allow the repos-
itory to be damaged.  (My thanks to Ralf Fassel
<ralf@akutech.de> 2 Feb 1999 for pointing this out.)

[1m10.8.2.  What You Can't Do[0m

You can't change Aegis' semantics.  Developers around the
world, and their managers, rely on Aegis working just the
way it does right now.  You can't change things that will
compromise their ability to get things done.

Particularly, Aegis has a strong security story.  Availabil-
ity, integrity and confidentiality, and all that.  If you



Peter Miller     (lib/en/howto/developer.so)         Page 45





Howto                                                  Aegis


want it more flexible, that's good, but you can't change the
defaults and you can't make it irretrievably weaker.  (You
can, as a [4mnon[24m-default make it weaker, within limits.)

Aegis (the executable, not the whole package) is quite big
enough.  Don't add code to [4march[24m/bin/aegis than can be done
with the report generator, or as a separate program like
aesub or aefind.  More GUI can be added using Tk/Tcl -
unless you have grander plans and even then it [4mstill[0m
shouldn't be added to the set-uid-root executable.

[1m10.9.  Coding Style[0m

Please try to emulate the existing coding style.  (Indents
recently changed from 8 to 4, not all of the code has caugh-
up yet.)  Lines are to be 80 charcters or less wide, limited
to the 95 printable ASCII characters, with no trailing white
space.

Probably need a GNU Indent profile for code formatting, too.

[1m10.10.  Writing Tests[0m

If you have fixed a bug you should write a test to verify
the correct behaviour of Aegis.  Because test file names are
generated automatically starting from your repository state,
it's possible that [4maet[24m will create a test with the same name
as one in the P.Miller repository.  Because Aegis is not yet
able to detect such situation, if you plan to send back your
work to P.Miller you may want to modify your aegis.conf
adding the following lines:

     new_test_filename =
       "test/${zpad $hundred 2}/"
       "t${zpad $number 4}${left $type 1}-${left ${user login} 4}.sh";

In this way the possibility of a name collision should be
reduced.  Invoke [4maent[24m:

     % [1maent[0m
     aegis: appending log to "aegis.log"
     aegis: user "walter", group "projadm"
     aegis: rm -f etc/cook/change_filesf etc/cook/project_files
     aegis: project "aegis.4.16.2": change 11: file "test/01/t0157a-walt.sh" new test
     %

Now you can start to implement the test.  Remember to invoke
the programs under test as $bin/program.

+o In order to improve error messages you should organize
  your script as a sequence of activity and use the [4mactivity[0m
  variable as sketched below:





Page 46          (lib/en/howto/developer.so)    Peter Miller





Aegis                                                  Howto


       #
       # create a new change
       #
       activity="new change 163"
       cat > tmp << 'end'
       brief_description = "The first change";
       cause = internal_bug;
       end
       if test $? -ne 0 ; then no_result; fi
       $bin/aegis -nc 1 -f tmp -p foo > log 2>&1
       if test $? -ne 0 ; then cat log; no_result; fi

  If you are reading this document, you probably don't need
  help to understand this code fragment, the only thing to
  note is that the number in the string (163) refer to the
  current line number and is used when printing a failure
  message.  You don't need to maintain it by hand as
  explained in the following step.

+o You can use test/activity.sh to automatically renumber the
  activity variables of your tests:

       $ [1msh test/activity.sh[0m
       test/01/t0159a-walt.sh...
       test/01/t0160a-walt.sh...
       $

  If you have not modified test/activity.sh you should find
  it as bl/test/activity.sh or blbl/test/activity.sh.

[1m10.11.  Debugging[0m

Aegis, as any other software, may contain undiscovered bugs.
If you are interested in helping to fix these bugs, and as a
developer you should be interested, the first thing to do is
compiling Aegis in DEBUG mode.  In order to do so you must
modify common/main.h and uncomment the DEBUG define.  (If
you use the [4maecp[24m [4m-read-only[24m option, Aegis will remind you to
uncopy the file again before develop end, ensuring that you
don't accidentally integrate this.)

In DEBUG mode the -Trace command line option is available
for most Aegis commands.  This option is followed by the
names of the source files you want to trace, and may be used
more than once.

If you need to add tracing capability to a file, you must
first include trace.h, modify the code in order to use the
trace facility (look at common/trace.h) then build the
change with [4maeb[24m and run the buggy command with the proper
-Trace option.

On Linux >= 2.4 the [4maegis[24m command, wich is set-uid-root, is
enabled to dump core when needed.  If this does not happen,



Peter Miller     (lib/en/howto/developer.so)         Page 47





Howto                                                  Aegis


remember to verify the [4mulimit[24m(1) settings; you may need to
execute the [4mulimit[24m [4m-c[24m [4munlimited[24m command.

[1m10.12.  The To-Do List[0m

+o Add an additonal mode to [4maedist[24m to query an [4maeget[24m server
  for change set UUIDs and download and apply missing change
  sets.  It needs to be able to be run by [4mcron[24m(8).  Submit-
  ted: PMiller, 1-Jun-2004

[1m10.12.1.  aecvsserver[0m

+o The aecvsserver needs to be extensively tested by users.
  Submitted: PMiller, 1-Jun-2004

+o Implement more of the CVS client commands which can be
  sent to the server, usually by saying "yes, bwana" and
  doing nothing.  Submitted: PMiller, 1-Jun-2004

+o Implement a cvs commit against a project (at the moment
  this is not allowed because you have to use a "module"
  named after a change set) which will create a change set
  apply the changes and do everything to get to aede.  Sub-
  mitted: PMiller, 1-Jun-2004

+o Is it possible to use the same techinique to write an SVN
  server?  Submitted: PMiller, 1-Jun-2004

+o Is it possible to use the same techinique to write an arch
  server?  Submitted: PMiller, 1-Jun-2004

+o Arch has the concept (if not the implementation) of an
  SCM-neutral interchange format.  Implement it.  Submitted:
  PMiller, 23-Jan-2004

[1m10.12.2.  Geographically Distributed Development[0m

+o The [4maedist[24m [4m-receive[24m command needs to be enhanced to under-
  stand file attributes.  Submitted: PMiller, 2-Jun-2004

+o The [4maepatch[24m [4m-receive[24m command needs to be enhanced to
  understand file attributes.  Submitted: PMiller,
  2-Jun-2004

+o Enhance the [4maedist[24m [4m-receive[24m command to understand incoming
  files with UUIDs.  Submitted: PMiller, 1-Jun-2004

+o Enhance the [4maepatch[24m [4m-receive[24m command to understand incom-
  ing files with UUIDs.  Submitted: PMiller, 1-Jun-2004

+o Add an additonal mode to [4maedist[24m to query an [4maeget[24m server
  for change set UUIDs and download and apply missing change
  sets.  It needs to be able to be run by [4mcron[24m(8).  Submit-
  ted: PMiller, 1-Jun-2004



Page 48         (lib/en/howto/devel_to_do.so)   Peter Miller





Aegis                                                  Howto


+o Enhance [4maedist[24m to preserve change history (both send and
  receive will need work).  Don't forget backwards compati-
  bility.  Submitted: Jerry Pendergraft, 2003

+o Enhance [4maedist[24m [4m-receive[24m to leave changes in [4mawaiting[0m
  [4mdevelopment[24m or [4mbeing[24m [4mdeveloped[24m if that's the state they
  were in at the origin.  Submitted: Jerry Pendergraft,
  May-2004

+o Enhance [4maepatch[24m [4m-receive[24m to run tests on changes which
  require it.  Submitted: PMiller, 1-Jun-2004

+o Enhance [4maepatch[24m to preserve change history (both send and
  receive will need work).  Incoming patches with no meta-
  data obviously can't do this.  Don't forget meta-data
  backwards compatibility.  Submitted: PMiller, 1-Jun-2004

+o Enhance [4maepatch[24m [4m-receive[24m to leave changes in [4mbeing[24m [4mdevel-[0m
  [4moped[24m if that's the state they were in at the origin.
  Patches with no meta-data stay in [4mbeing[24m [4mdeveloped[24m.  Sub-
  mitted: PMiller, 1-Jun-2004

+o Enhance [4maepatch[24m and [4maedist[24m to automagically sign (send)
  and verify (receive) the contents, using the (revolting)
  library from the [4mgpgme[24m project.  This stupid library
  spawns an [4mgpg[24m(1) instance and talks to it; unlike a sensi-
  ble library [4me.g.[24m the [4mzlib[24m project; why on earth couldn't
  they take the common code from gpg and make a library of
  [4mthat?[24m  Submitted: PMiller, 1-Jun-2004

[1m10.12.3.  Documentation[0m

+o Add a section to the branching chapter of the User Guide,
  describing how a developer may use a branch to temporarily
  waive the build command.  After a series of changes on
  this branch, the build command is restored, and the branch
  development ended.  This allows regular "non working" com-
  mits, without losing any of the strengths of the Aegis
  process.  Submitted: 7-Mar-2000

+o The manual pages need to have an example(s) section added
  to make them clearer.  This isn't just for beginners,
  infrequently used commands need examples even for sophis-
  ticated Aegis users..  Submitted: Geoff Soutter
  <geoff@whitewolf.com.au>, 3 Mar 2000

+o Get tkdiff 3-way merge working with Aegis (see
  http://www.ede.com/free/tkdiff/ for code).  Submitted:
  24-jan-2000

+o Add information to the History Tool chapter, describing
  how to use CVSup to access the RCS history tree.  Submit-
  ted: 28-jan-2000




Peter Miller    (lib/en/howto/devel_to_do.so)        Page 49





Howto                                                  Aegis


+o the RCS history commands in the aegis user guide all use
  the `-u' option for `ci' to check out a copy after regis-
  tering/updating a file.  However `ci -u' always does key-
  word expansion.  To avoid this, we have omitted the -u, so
  the working file is gone after the `ci'.  We check it out
  again using `co', this time with the `-ko' option to avoid
  keyword expansion.  Note that the -ko option is always
  given to the `co' command, never to `ci' or `rcs'.  Sub-
  mitted: Ralf Fassel <ralf@akutech.de>, 18 Jan 2000

+o * diff ; test $? -le 1 -> diff ; test $? -ne 1 means that
  unchanged files prevent aede!!  (Only fly in the ointment
  is moving files - need to cope with this.)  Submitted: Gus
  <gus@getsystems.com> 28 Jul 1999

+o mention in the diff tool part of the User Guide, that you
  can mess with diff_command to exclude with binary files,
  or file with CR in them, or lines too long, [4metc[24m.  Submit-
  ted: PMiller, 28-jun-99

+o in the branching chapter, have a section about using sub-
  branches to turn build_command off (or to ignore exit sta-
  tus), and integrate lots of teensy tiny bug fixes, and
  then turn it on again.  In the front, reference the
  branching chapter in "how to extend the Aegis process"
  Can mention extra review steps there, too.  Submitted:
  choffman@dvcorp.com, 22 Jun 1999

+o Document the build_time_adjust_notify_command in the DMT
  chapter of the User Guide.  Update the example projects to
  use it.  Update the config example to use it.  Submitted:
  PMiller, 4-Apr-99

+o Mention binary files in the diff and merge section (may
  provide aebinfil command to help choose which behavior?)
  Submitted: PMiller, 31-mar-99

+o mention "rcs -ko" in the User Guide and put it into the
  examples AND also fhist keywords in the User Guide and put
  it into the examples.  and make sure the examples all have
  hist_{put,create} the same.  Subject: Ralf Fassel
  <ralf@akutech.de>, 9 Mar 1999

+o worked example, "5.2.7 says that the cook file contains
  all of the above commands but my copy doesn't have them
  ..."  [for config file and howto.cook file] BUT integra-
  tion diffs not in the worked example.  Submitted: Michael
  McCarty <mmccarty@xinetix.com>, 26-Feb-99

+o need discussion (Howto, or maybe the User Guide) of how to
  use Aegis when you site has a mix of Unix and Wintel.
  Submitted: Paolo Supino <paolo@schema.co.il>, 4 Feb 1999





Page 50         (lib/en/howto/devel_to_do.so)   Peter Miller





Aegis                                                  Howto


+o add chapter to User Guide, saying how to config web inter-
  face and how to use it.  Submitted: Graham Wheeler
  <gram@cdsec.com>, 27 Jan 1999

+o User Guide: big changes bouncing: how to use a branch to
  get smaller reviews and smaller diffs.  Submitted: Ralf
  Fassel <ralf@akutech.de>, 27 Jan 1999

+o note for User Guide: metrics software form
  ftp://ftp.qucis.queensu.ca/pub/software-eng/software/-
  Cmetrics/

+o correct documentation of file locking in UG: correct the
  example around the file locking - it gives the wrong text
  of the aede error - and probably other stuff.  also, the
  wrong person comes back from aerobics

[1m10.12.4.  More Reports[0m

+o Add a -REVerse option, so that all of the listings (ael)
  come out in the reverse order to that used at present.
  Submitted: John Darrington <johnd@ot.com.au>, 20-Jul-2001

+o Write an [4maereport[24m file to produce MS-Project views of a
  project, making sure that the states of each change are
  linked, use averages to predict any incomplete states.
  And maybe another to produce HTML pages of the same thing.
  Submitted: 15-Jan-2000

+o On the [4maeget[24m(1) web pages, link the file edit numbers to
  pages which will retrieve the historical version.  Submit-
  ted: Anoop Kulkarni <anoop@sasi.com>, 22 Dec 1999

+o Add a user_change report (just like "ael user_changes")
  which takes a user name, so you can get a list of changes
  by user.  Make [4maeget[24m(1) do this, too.  Submitted: Ralf
  Fassel <ralf@akutech.de>, 9 Dec 1999

+o Add a outstanding_changes report (just like "ael outstand-
  ing_changes") which takes a user name, so you can get a
  list of outstanding changes by user.  Make [4maeget[24m(1) do
  this, too.  Submitted: Ralf Fassel <ralf@akutech.de>, 9
  Dec 1999

+o Write a report which says when you have to do to get a
  change completed Jerry says he has written most of this.
  Submitted: jerry.pendergraft@endocardial.com 3-Nov-99

+o ael change_history - write as a report and then include
  project history for sub branches.  Don't forget the web
  reports, too.  Submitted:Jerry Pendergraft <jerry@endocar-
  dial.com>, 30 Aug 1999





Peter Miller    (lib/en/howto/devel_to_do.so)        Page 51





Howto                                                  Aegis


+o ael outstanding_changes - rewrite as a report and then
  include sub branches.  Don't forget the web reports, too.
  Submitted: Jerry Pendergraft <jerry@endocardial.com>, 30
  Aug 1999

+o ael project_history - rewrite as a report and then include
  parents and sub branches.  Don't forget the web reports,
  too.  Submitted: Jerry Pendergraft <jerry@endocar-
  dial.com>, 30 Aug 1999

+o aer file_history - include parents and sub branches.
  Don't forget the web reports, too.  Submitted: Jerry Pen-
  dergraft <jerry@endocardial.com> 30 Aug 1999

+o Some kind of web report which makes "train track" diagrams
  of file branching.

+o Some kind of web report which makes "train track" diagrams
  of project branching.

+o multivariate linear regression: needed as a report genera-
  tor function: needed for metrics analysis

+o more blurb in the statistics web pages, so they are more
  self-explaining Submitted: Ralf Fassel <ralf@akutech.de>,
  13-Oct-98

+o Add anew report like "ael uc" except that it (optionally)
  takes a user name as well, to list a particular user's
  changes.

+o File Activity Report (web) does not translate user name
  and give email link.  Should also put user name under
  change state, as in change lists.

[1m10.12.5.  Core Enhancements[0m

+o Use the per-file attributes to record the encoding of the
  text (e.g. UTF-8) and the line termination.  Provide a way
  (via the iconv(3) function? via recode(1) command?) to
  change the encoding.  Submitted: PMiller, 23-Jun-2004

+o "I have determined that one reason [that aedeu is used in
  preference to aerfail] is the reviewer is afraid they
  don't understand the change and once explained they would
  not fail it.  Now the fact that the description, comments
  etc did not do the job to explain the change is reason
  enough to fail it notwithstanding...  They are saying if
  they had an aerfu command they would be willing to aerf
  changes. How difficult would that be?"  Not very difficult
  at all.  Provided, of course, that nothing has been
  changed in the mean time (and Aegis has everything it
  needs to check that).  Submitted: Jerry Pendergraft,
  23-Jun-2004



Page 52         (lib/en/howto/devel_to_do.so)   Peter Miller





Aegis                                                  Howto


+o The project_file_roll_forward function needs to be
  enhanced to understand file UUIDs.  Submitted: PMiller,
  1-Jun-2004

+o Now the sources are all being compiled by a C++ cimpiler,
  convert the various OO portions of the code (inout_ty and
  its derived classes, output_ty, etc) to true C++.  Need a
  style guide first, so other developers know how I want it
  done.  See SRecord for examples until this is done.  Sub-
  mitted: PMiller, 1-Jun-2004

+o More doxygen comments in the header files.  Submitted:
  PMiller, 23-Jan-2004

+o Add a "development directory style" configuration option.
  The current styles are "view path" and two types of "sym-
  link farm", although this is well concealed by the code.
  Need to add a hard link (arch-ish) / copyfile (cvs-ish)
  style as well, but only for source files.  The code which
  currently maintains the symlinks can be pressed into doing
  the extra work fairly easily.  Submitted: PMiller,
  1-Jun-2004

+o It would be nice to have a way to specify a timeout for
  aegis tests.  If a single test does not finish within this
  time, it should be aborted and considered `No Result'.
  Then aet should continue with the next test (as appropri-
  ate if --persevere was given).  A `--timeout' argument to
  `aet' would do the trick, and also a project config field.
  The implementation could be interesting, since signaling
  the forked aegis child process might not be enough to stop
  all processes (process groups?).  Submitted: Ralf Fassel
  <ralf@akutech.de>, 24-Jan-2001

+o Problem with aepa that doesn't specify the default values
  for all the test features in aeca (there are three types
  in aeca and only one in aepa).  Submitted: Mark Veltzer
  <mark2776@yahoo.com>, 16 Aug 2001

+o The [4maedist[24m(1) program should send changes with no files,
  or changes in "being developed".  Submitted: Mark Veltzer
  <mark2776@yahoo.com>, 16 Aug 2001

+o Have [4maem[24m merge changes properly if another changed moved
  the file in the baseline.  You need to do this across the
  board, not just in aegis/aed.c Submitted: Ralf Fassel
  <ralf@akutech.de>, 25 Feb 2000

+o Add progress (%) indicators (aeib was specific example,
  but there may be others [4me.g.[24m symlink farms and aecp, even
  aede for big changes) for use by the GUI interfaces - and
  maybe the text interface too.  Submitted: Ralf Fassel
  <ralf@akutech.de> 10 Dec 1999




Peter Miller    (lib/en/howto/devel_to_do.so)        Page 53





Howto                                                  Aegis


+o Extend the create_symlinks_before_build functionality to
  copy, not just symlink.  Because they would edit the files
  direct, we then need an implicit aecpcorne detector.  You
  need to look for other boundary conditions this is also
  going to affect.  You need a remove_symlinks_after_build
  analogue, too.  Submitted: Darrin Thompson <dthomp-
  son@characterlink.net>, 15 Nov 1999

+o os.h is a system header on some systems, so os.h has to
  move Sumbitted: Christophe Broult <broult@info.unicaen.fr>
  30 Sep 1999

+o aedist -rec needs to preserve (a) copyright years, (b)
  test exemptions (subject to permissions), and (c) archi-
  tecture (if possible).  AND CHANGE NUMBER?  Submitted:
  Ewolt Wolters <ewolt@pallas-athena.com>, 27 Jul 1999

+o Aedist to add project history to end of description when
  sending change set.  Submitted: Jerry Pendergraft
  <jerry@endocardial.com>, Dec-2000

+o can we separate change creation from other administrator
  permissions?  can we make "everyone" able to create
  changes?  Submitted: Ewolt Wolters <ewolt@pallas-
  athena.com>, 28 Jun 1999

+o should explicitly mention CPPFLAGS=-I/usr/local/include;
  export CPPFLAGS LDFLAGS=-L/usr/local/lib; export LDFLAGS
  in the configuring section.  Submitted: John Huddleston
  <jhudd@cody.itc.nrcs.usda.gov>, 19 Mar 1999

+o Using file attributes, add coupling between files to form
  file groups; this means when you aecp, you get the whole
  set of related files.  Submitted: PMiller, 18-Feb-99

+o The aed command does not promote aenf->aecp unless the ,D
  file does not exist.  This is annoying, should always do
  it.  (So should some other commands.)  Subject: Ralf Fas-
  sel <ralf@akutech.de>, 1 Feb 1999

+o Add a default_regression_test_exemption project attribute.
  Submitted: Ralf Fassel <ralf@akutech.de>, 31 Jan 1999,
       Jerry Pendergraft <jerry@endocardial.com>, 2 Feb
  2001.

+o Need a clean_exceptions file in the project config file
  (list of strings) so can have local RCS dirs, and do "ci
  `aegis -l cf -ter`" in the develop_end_command Submitted:
  1-Feb-99

+o aenpr -dir -keep: allow directory to already exist if has
  right owner and is empty?  Submitted: Jerry Pendergraft
  <jerry@endocardial.com>, 22 Jan 1999




Page 54         (lib/en/howto/devel_to_do.so)   Peter Miller





Aegis                                                  Howto


+o Add a new post_merge_command so can generate summary of
  files needing editing.  Subject: Ralf Fassel
  <ralf@akutech.de>, 21 Dec 1998

+o Create a new aepatch command: "aepatch -send" to create
  "ordinary" OpenSource source patches, and "aepatch
  -receive" to turn patches into an Aegis change - and not
  necessarily only patches generated with aepatch.  Yes,
  intentionally similar to aedist.

+o integrate difference should look for missing ,D files
  (usually impossible) and re-instate them.  Submitted:
  PMiller, 22-Sep-98

+o tests 7, 20, 70 warn symlink.c: In function `main': sym-
  link.c:5: warning: return type of `main' is not `int' Sub-
  mitted: Bruce Stephen Adams <brucea@cybernet-
  ics.demon.co.uk>, 10 Sep 1998

+o change_set_env needs to set LINES and COLS

+o commands which accept -branch and/or -trunk should also
  accept -grandparent but not all do.  check.

+o Add a --no-baseline-lock option to the aeb and aecp com-
  mands.  Warn them not to in the manual pages.

+o list locks - need to spot the case where *all* of a set
  are taken (all 64k) and report sensibly (not 64K lines)

+o aemv does not correctly check the -to- filename.  (spe-
  cific example = file name length)

+o aefind needs a sort option

+o aefind needs the rest of the find functionality added

+o * Add a -output option to the aent command ([4mothers?[24m)  for
  scripting support.

+o aed - when auto upgrade create to modify, clear move if
  set.

+o aede needs to make sure that the files (and directories)
  are readable (and searchable) by reviewers.

+o make aemv rename files within a change

+o aecp -anticipate

+o Make the listing more specific for aecp aecpu aenfu aentu
  aerm aermu, etc





Peter Miller    (lib/en/howto/devel_to_do.so)        Page 55





Howto                                                  Aegis


+o add a file copy notification command to the project config
  file

+o Add pseudo change do can do many integrations at once
  (this pseudo change would be created by aeib and destroyed
  by aeipass, aeifail or aeibu).

+o Version punctuation: at the moment you gets dots between
  the branch numbers.  Need more flexible punctuation: espe-
  cially, want a hyphen first, then dots (sometimes).

+o * aecp -delta bug      "I've been making good use of the
  "-delta" option of aecp lately.       But there has been a
  complication in its use.  Let's say a file      was
  aerm'ed in delta 100.  Let's further say that we are at
  delta      175 and are trying to restore the source code
  as of delta 75.       If I do a "aecp - delta 75 file.c"
  I'm told that file.c is no      longer part of the
  project."  Should aecp -del fake aenf for deleted files in
  earlier deltas?  Submitted: markm@endo.com

+o internationalize -interactive

+o Enhance aet to allow reviewers to run tests.

+o check library state files on project creation      "I was
  creating a new release from a large project.       After
  copying the      baseline and creating hundreds of history
  files the aenrls failed      because the library dir I
  specified wasn't writable by aegis and no      state file
  was created. Couldn't this be checked first?"  Submitted:
  Lloyd Fischer <lloyd@dvcorp.com>

+o Add precedence constraints: a list of prerequisite
  changes, which must all be in the "completed" state before
  the change may end development.  Submitted: Christian F.
  Goetze <c-goetze@u-aizu.ac.jp>

+o If there is a read error when reading the template source
  file during aent, get a stupid error within error message,
  and never tells you about the file

+o How about "include" support for the config file?  That way
  one could also cover architecture specific things by
  "include ${libdir}/${project}.defs" in the config file.
  Submitted: Jerry Pendergraft <jerry.pendergraft@endocar-
  dial.com>, 7 Sep 2001

+o Add an [4maetouch[24m command, to touch all of the (non-build)
  source files in the change.  Submitted: 2001

+o Have the "aeclean -list" option say what aeclean would do,
  rather than list the change source files.  Submitted: 2001




Page 56         (lib/en/howto/devel_to_do.so)   Peter Miller





Aegis                                                  Howto


+o Have aed (aem) *remember* the previous state when it finds
  a problem (much like aet does, now).  Submitted: Ralf Fas-
  sel <ralf@akutech.de> 3-Mar-2002

[1m10.12.5.1.  More O(1) Scalability[0m

+o Need to supplement the {project,change}_file_find and
  {project,change}_file_nth interfaces with
  {project,change}_file_name_nth interfaces.  Then, use them
  as often as possible.

+o Need the fstate file to have a manifest field; access this
  for file names.  Then, store each file into in a separate
  file; only access this file is file state is required.

+o The presence or absence of the manifest field in the top-
  level fstate file tells you if the old or new file state
  usage is present.

[1m10.12.6.  GUI[0m

+o tkaeca barfs when there are no changes on the branch.
  should be more graceful.  Submitted: Ewolt Wolters
  <ewolt@pallas-athena.com>, 11 Aug 1999

+o using tkaegis: project > branch > role > integrate, a win-
  dow pops up "Error in tcl script, Error: invalid command
  name ".mbar.review.menu"".  Submitted: Ewolt Wolters
  <ewolt@pallas-athena.com> 9 Aug 1999

+o user pasted in text (including back slash) into aeifail
  edit window.  which was accepted, but broke change state
  (illegal escape sequence).  Submitted: Michael McCarty
  <mmccarty@xinetix.com>, 10 May 1999

+o A new ${architecture_list} substitution to give all archi-
  tectures in a command.  Submitted: jerry.pendergraft@endo-
  cardial.com, 31 Mar 1999

+o have aedist -rec accept a -delta option, so you can tell
  it where to apply from.  Anticipated use is "-delta 0"
  meaning start of branch.  (also a -reg option).  Submit-
  ted: PMiller, 22-mar-99

[1m10.12.7.  Release and Build and Install[0m

+o add debian .deb file, add notification to <cd@debian.org>
  for new releases.  Submitted: PMiller, 22-Jun-99

+o building documentation needs to talk about libz some more.
  particularly, you either need it on ROOT's LD_LIBRARY_PATH
  or you need to static link it.  Submitted: Ralf Fassel
  <ralf@akutech.de> 5-Apr-99




Peter Miller    (lib/en/howto/devel_to_do.so)        Page 57





Howto                                                  Aegis


+o have configure script whine about missing libz Submitted:
  PMiller, 7 Apr 99

+o have configure script whine about missing regcomp Submit-
  ted: PMiller, 7 Apr 99

+o Sample documentation needs to make the [4mgroup[24m thing obvi-
  ous.  And also the umask at aenpr time!  Submitted: Alan
  Zimmerman <alanz@electrosolv.co.za>, 5 Apr 1999

+o generated makefile CC=cc needs to quote cc in case has
  spaces Submitted: Aaron Johnson <adj@ccltd.com>, 31 Mar
  1999

+o The BUILDING file needs to mention that you should install
  zlib with --prefix=/usr because many systems think
  /usr/local/lib "insecure directory".  Submitted: Fabien
  Campagne <campagne@Inka.MSSM.EDU>, 26 Mar 1999

+o add piece to BUILDING file saying to get Apache first.
  Submitted: Graham Wheeler <gram@cdsec.com> 27 Jan 1999

[1m10.12.8.  Database[0m

+o Write an ODBC interface to the database?  Submitted: P.
  Miller, 16 Aug 2001

+o Does it make sense to have an NNTP interface?  Would it be
  any use?  Submitted: P. Miller, 16 Aug 2001




























Page 58           (./lib/en/howto/main.ms)      Peter Miller





Aegis                                                  Howto


  .
























































Peter Miller      (./lib/en/howto/main.ms)            Page 1





Aegis                                                  Howto



                      [1mTable of Contents[0m


  1. Introduction  . . . . . . . . . . . . . . . . . . .   3
    1.1. Assumed Knowledge . . . . . . . . . . . . . . .   3
    1.2. Howto Install Aegis . . . . . . . . . . . . . .   3
    1.3. Howto Contribute  . . . . . . . . . . . . . . .   3
  2. Cheat Sheet . . . . . . . . . . . . . . . . . . . .   4
    2.1. Common Commands . . . . . . . . . . . . . . . .   4
    2.2. Developer Commands  . . . . . . . . . . . . . .   5
    2.3. Reviewer Commands . . . . . . . . . . . . . . .   6
    2.4. Integrator Commands . . . . . . . . . . . . . .   6
    2.5. Project Administrator Commands  . . . . . . . .   6
  3. How to Start Using Aegis  . . . . . . . . . . . . .   8
    3.1. First, Create The Project . . . . . . . . . . .   8
    3.2. Second, Use a Template Project  . . . . . . . .   8
    3.3. Second, Copy a Template Project . . . . . . . .   8
  4. How to Recreate Old Versions  . . . . . . . . . . .  10
    4.1. aecp  . . . . . . . . . . . . . . . . . . . . .  10
    4.2. Finding Delta Numbers . . . . . . . . . . . . .  10
    4.3. ${version}  . . . . . . . . . . . . . . . . . .  11
    4.4. Out Of Date . . . . . . . . . . . . . . . . . .  11
  5. How to Create a New Project . . . . . . . . . . . .  13
    5.1. Single User Project . . . . . . . . . . . . . .  13
    5.2. Two User Project  . . . . . . . . . . . . . . .  14
    5.3. Multi User Project  . . . . . . . . . . . . . .  15
    5.4. Warning . . . . . . . . . . . . . . . . . . . .  15
    5.5. Changing The Project Owner  . . . . . . . . . .  16
  6. How to Move a Project . . . . . . . . . . . . . . .  18
    6.1. Relocating a Project  . . . . . . . . . . . . .  18
    6.2. Renaming a Project  . . . . . . . . . . . . . .  19
  7. Working in Teams  . . . . . . . . . . . . . . . . .  20
    7.1. Local . . . . . . . . . . . . . . . . . . . . .  20
    7.2. Distributed . . . . . . . . . . . . . . . . . .  23
  8. How to use Aegis with Python  . . . . . . . . . . .  26
    8.1. Handling Aegis search paths . . . . . . . . . .  26
    8.2. The build step  . . . . . . . . . . . . . . . .  28
    8.3. Testing . . . . . . . . . . . . . . . . . . . .  29
    8.4. Running your programs . . . . . . . . . . . . .  30
  9. Howto End A Branch  . . . . . . . . . . . . . . . .  32
  10. How to Become an Aegis Developer . . . . . . . . .  34
    10.1. Required Software  . . . . . . . . . . . . . .  34
    10.2. Create The Aegis Project . . . . . . . . . . .  37
    10.3. The Download . . . . . . . . . . . . . . . . .  38
    10.4. Supporting Several Architectures . . . . . . .  42
    10.5. The Bleeding Edge  . . . . . . . . . . . . . .  44
    10.6. Undiscovered Country . . . . . . . . . . . . .  44
    10.7. Sending Changes  . . . . . . . . . . . . . . .  45
    10.8. Guidelines . . . . . . . . . . . . . . . . . .  45
    10.9. Coding Style . . . . . . . . . . . . . . . . .  46
    10.10. Writing Tests . . . . . . . . . . . . . . . .  46
    10.11. Debugging . . . . . . . . . . . . . . . . . .  47
    10.12. The To-Do List  . . . . . . . . . . . . . . .  48



Peter Miller      (./lib/en/howto/main.ms)         Page 1001





Howto                                                  Aegis



























































Page 1002                    ()                 Peter Miller


