INSTRUCTIONS FOR EDITING PMFIND CODE
These rules must be followed for the code to be maintained
properly.
We use CVS to manage our code. When in doubt, check the
manual.
GET A COPY OF THE LATEST PMFIND CODE:
Use: cvs checkout module
This command makes a copy of the latest version of the code in
the current directory. Possible modules are:
- pmfind: the main tree. Checking pmfind out gets you all other modules
at the same time.
- pmauto: subdirectory that has scripts that run all the pmfind code.
- pmbirdie: subdirectory that has the source code for initial interference rejection.
- pmcommon: subdirectory that has all routines common to more than
one subdirectory. This was created to remind the programmer
that her/his changes may affect others.
- pminterf: subdirectory that has the source code for interference rejection at pmview_suspect.
- pmminifind: subdirectory that has the source code for the actual search code.
- pmsuspect_fdot: subdirectory that has suspect pdm code for acceleration code.
- pmsuspect_find: subdirectory that has suspect pdm code.
- pmtools: subdirectory holding miscellaneous handy tools.
- pmtree_master: subdirectory for dedispersion code.
- pmview_suspect: subdirectory for source code to view suspects following pmsuspect_find.
- pmview_suspect_fdot: subdirectory for source code to view suspects following pmsuspect_fdot.
It is also possible to check out just one file, but you will probably
do this rarely.
KEEP OTHERS FROM EDITING A FILE SIMULTANEOUSLY:
Use: cvs admin -l filename
This is how you lock a file in cvs. When you have locked
the file, no one else can check it in. You MUST lock the
file you intend to change. You also MUST unlock it once you have
checked it back in. That way, when you go off on vacation after
making your cvs mods, the rest of us won't say nasty things about you.
UNLOCK A FILE YOU HAVE LOCKED:
Use: cvs admin -u filename
Self-explanatory. If Mr. Pinhead has gone off on vacation without unlocking
his files, it is possible to break the lock. I don't know how.
Check the
manual.
CHECK THE STATUS OF YOUR PRIVATE VERSION OF THE CODE:
Use: cvs status
Use this command from within the directory of interest. You want
to use this command fairly often. It will tell you which of your
files differs from the repository and whether you need to use
cvs update (see below). The message "Needs Patch" tells you just
that.
UPDATE YOUR VERSION OF THE CODE WITH RECENT CHANGES OTHERS HAVE CHECKED IN:
Use: cvs update
Use this command from within the directory of interest.
TO CHECK IN CHANGES:
Use: cvs commit -m "descriptive comment" filename
This is how you make your code changes official. Note that
though you generally check out a module, you check back in a file.
Using -m allows you to include adescriptive comment of your
most recent changes on the command line. For longer comments,
omit the -m and you can type in your comments using your favorite
editor (set by the CVSEDITOR environment variable). Note that
committing automatically unlocks the file.
COMMUNICATE YOUR CHANGES TO OTHERS
Use: email/phone
It is the responsibility of the programmer who made the changes to
routines in the pmcommon subdiretory to ensure that s/he has announced
this to everyone.
Jodrell pm scripts documentation
Jodrell pm documentation on how to run the scripts
Jodrell pmproc documentation
overview of birdie code
Vicky's homepage
last update: May 14, 1998.