ViewVC Help
View File | Revision Log | Show Annotations | Root Listing
root/cvsroot/UserCode/README
Revision: 1.5
Committed: Fri Feb 18 14:26:35 2011 UTC (14 years, 2 months ago) by cmsbuild
Branch: MAIN
Changes since 1.4: +2 -1 lines
Log Message:
testing

File Contents

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