ViewVC Help
View File | Revision Log | Show Annotations | Root Listing
root/cvsroot/UserCode/README
Revision: 1.1
Committed: Thu Sep 21 12:33:49 2006 UTC (18 years, 7 months ago) by elmer
Branch: MAIN
Branch point for: codeHeavyBaryons
Log Message:
Add README file for UserCode area.

File Contents

# User Rev Content
1 elmer 1.1
2     $Id:$
3    
4     Creating a user area in the CMSSW repository
5     --------------------------------------------
6    
7     There is an area called "UserCode" in the CMSSW repository where you can
8     create yourself a package to store your code and cfg files, for example:
9    
10     UserCode/PElmer
11    
12     Note that this area is primarily intended for "user" code which will never
13     go into CMSSW software releases. If you intend for your code to go into
14     CMSSW releases, you should probably just request a normal package with the
15     normal procedure via the Tag Collector.
16    
17     To create such a user CVS area for yourself, do the following:
18    
19     1) Choose a packagename for yourself. Typically this should be your
20     name (e.g. with some capitalization as above, or your CERN unix
21     username, etc.) so that it is semi-obvious whose package it is.
22    
23     2) Then create your package (here for an example "JohnDoe" user):
24    
25     (set your CVSROOT to point to the CMSSW CVS repository)
26     ('cd' to some temporary area)
27     cvs co UserCode/README
28     mkdir UserCode/JohnDoe
29     cvs add UserCode/JohnDoe
30    
31     In general it is advisable to structure it like a normal CMSSW package,
32     i.e. with the same subdirectory structure. To do this, you can do:
33    
34     mkdir UserCode/JohnDoe/src UserCode/JohnDoe/interface
35     cvs add UserCode/JohnDoe/src UserCode/JohnDoe/interface
36     mkdir UserCode/JohnDoe/data UserCode/JohnDoe/test
37     cvs add UserCode/JohnDoe/data UserCode/JohnDoe/test
38    
39     If you do not think you need some of these subdirectories at the
40     moment, you simply do not 'mkdir' and 'cvs add' them.
41    
42     3) Then you can 'cd' into the "src" area of some scram working/developer
43     area and do:
44    
45     cvs co UserCode/JohnDoe
46    
47     and begin to add your code and cfg files to the subdirectories. If you
48     need a BuildFile, you can copy an example from a normal CMSSW package
49     and edit it to serve your purposes.
50    
51     *********************************************************************
52     ** Please note that you should _not_ commit files to the UserCode **
53     ** directory itself, but only in your equivalent of the "JohnDoe" **
54     ** sub-directory.... **
55     *********************************************************************
56