merge from 2.2
[samba.git] / docs / docbook / projdoc / CVS-Access.sgml
1 <chapter>
2
3
4 <chapterinfo>
5         <author>
6                 <affiliation>
7                         <orgname>Samba Team</orgname>
8                 </affiliation>
9         </author>
10         
11                 
12         <pubdate> (22 May 2001) </pubdate>
13 </chapterinfo>
14
15 <title>HOWTO Access Samba source code via CVS</title>
16
17 <sect1>
18 <title>Introduction</title>
19
20 <para>
21 Samba is developed in an open environnment.  Developers use CVS
22 (Concurrent Versioning System) to "checkin" (also known as 
23 "commit") new source code.  Samba's various CVS branches can
24 be accessed via anonymouns CVS using the instructions
25 detailed in this chapter.
26 </para>
27
28 <para>
29 This document is a modified version of the instructions found at
30 <ulink url="http://samba.org/samba/cvs.html">http://samba.org/samba/cvs.html</ulink>
31 </para>
32
33 </sect1>
34
35
36 <sect1>
37 <title>CVS Access to samba.org</title>
38
39 <para>
40 The machine samba.org runs a publicly accessible CVS 
41 repository for access to the source code of several packages, 
42 including samba, rsync and jitterbug. There are two main ways of 
43 accessing the CVS server on this host.
44 </para>
45
46 <sect2>
47 <title>Access via CVSweb</title>
48
49 <para>
50 You can access the source code via your 
51 favourite WWW browser. This allows you to access the contents of 
52 individual files in the repository and also to look at the revision 
53 history and commit logs of individual files. You can also ask for a diff 
54 listing between any two versions on the repository.
55 </para>
56
57 <para>
58 Use the URL : <ulink
59 url="http://samba.org/cgi-bin/cvsweb">http://samba.org/cgi-bin/cvsweb</ulink>
60 </para>
61 </sect2>
62
63 <sect2>
64 <title>Access via cvs</title>
65
66 <para>
67 You can also access the source code via a 
68 normal cvs client.  This gives you much more control over you can 
69 do with the repository and allows you to checkout whole source trees 
70 and keep them uptodate via normal cvs commands. This is the 
71 preferred method of access if you are a developer and not
72 just a casual browser.
73 </para>
74
75 <para>
76 To download the latest cvs source code, point your
77 browser at the URL : <ulink url="http://www.cyclic.com/">http://www.cyclic.com/</ulink>.
78 and click on the 'How to get cvs' link. CVS is free software under 
79 the GNU GPL (as is Samba).  Note that there are several graphical CVS clients
80 which provide a graphical interface to the sometimes mundane CVS commands.
81 Links to theses clients are also available from http://www.cyclic.com.
82 </para>
83
84 <para>
85 To gain access via anonymous cvs use the following steps. 
86 For this example it is assumed that you want a copy of the 
87 samba source code. For the other source code repositories 
88 on this system just substitute the correct package name
89 </para>
90
91 <orderedlist>
92 <listitem>
93         <para>
94         Install a recent copy of cvs. All you really need is a 
95         copy of the cvs client binary. 
96         </para>
97 </listitem>
98
99
100 <listitem>
101         <para>
102         Run the command 
103         </para>
104
105         <para>
106         <command>cvs -d :pserver:cvs@samba.org:/cvsroot login</command>
107         </para>
108         
109         <para>
110         When it asks you for a password type <userinput>cvs</userinput>.
111         </para>
112 </listitem>
113
114
115 <listitem>
116         <para>
117         Run the command 
118         </para>
119         
120         <para>
121         <command>cvs -d :pserver:cvs@samba.org:/cvsroot co samba</command>
122         </para>
123         
124         <para>
125         This will create a directory called samba containing the 
126         latest samba source code (i.e. the HEAD tagged cvs branch). This 
127         currently corresponds to the 3.0 development tree. 
128         </para>
129         
130         <para>
131         CVS branches other HEAD can be obtained by using the <parameter>-r</parameter>
132         and defining a tag name.  A list of branch tag names can be found on the
133         "Development" page of the samba web site.  A common request is to obtain the
134         latest 2.2 release code.  This could be done by using the following command.
135         </para>
136         
137         <para>
138         <command>cvs -d :pserver:cvs@samba.org:/cvsroot co -r SAMBA_2_2 samba</command>
139         </para>
140 </listitem>
141
142 <listitem>
143         <para>
144         Whenever you want to merge in the latest code changes use 
145         the following command from within the samba directory: 
146         </para>
147         
148         <para>
149         <command>cvs update -d -P</command>
150         </para>
151 </listitem>
152 </orderedlist>
153         
154 </sect2>
155 </sect1>
156
157 </chapter>