← Back to branch summary

~svn/ubuntu/raring/subversion/ppa

« back to all changes in this revision

Viewing changes to README

  • Committer: Bazaar Package Importer
  • Author(s): Adam Conrad
  • Date: 2005-12-05 01:26:14 UTC
  • mfrom: (1.1.2 upstream)
  • Revision ID: james.westby@ubuntu.com-20051205012614-qom4xfypgtsqc2xq
Tags: 1.2.3dfsg1-3ubuntu1
Merge with the final Debian release of 1.2.3dfsg1-3, bringing in
fixes to the clean target, better documentation of the libdb4.3
upgrade and build fixes to work with swig1.3_1.3.27.

Show diffs side-by-side

added added

removed removed

Lines of Context:
README
 
1
 
 
2
               Subversion, a version control system.
 
3
               =====================================
 
4
 
 
5
$LastChangedDate: 2005-01-21 15:33:50 -0500 (Fri, 21 Jan 2005) $
 
6
 
 
7
Contents:
 
8
 
 
9
     I. A FEW POINTERS
 
10
    II. DOCUMENTATION
 
11
   III. PARTICIPATING IN THE SUBVERSION COMMUNITY
 
12
    IV. QUICKSTART GUIDE
 
13
     V. CONVERTING FROM CVS
 
14
 
 
15
 
 
16
I.    A FEW POINTERS
 
17
 
 
18
      For an overview of the Subversion project, visit
 
19
 
 
20
         http://subversion.tigris.org/
 
21
 
 
22
      Once you have a Subversion client you can get the latest version
 
23
      of the code with the command:
 
24
 
 
25
         $ svn co http://svn.collab.net/repos/svn/trunk subversion
 
26
 
 
27
 
 
28
 
 
29
II.   DOCUMENTATION
 
30
 
 
31
      The main documentation is the Subversion Book, written in
 
32
      DocBook XML, which lives in the doc/ tree.  If you wish to build
 
33
      the documentation from source, read doc/book/README.  Otherwise,
 
34
      an on-line version of the book can be found at
 
35
      http://svnbook.red-bean.com.
 
36
 
 
37
      See COPYING for copyright information.
 
38
      See HACKING for development information.
 
39
      See INSTALL for installation information.
 
40
 
 
41
 
 
42
 
 
43
III.  PARTICIPATING IN THE SUBVERSION COMMUNITY
 
44
 
 
45
      First, read the HACKING file!  It describes Subversion coding and
 
46
      log message standards, as well as how to join discussion lists.
 
47
 
 
48
      Talk on IRC with developers:  irc.freenode.net, channel #svn.
 
49
 
 
50
      Read the FAQ:  http://subversion.tigris.org/faq.html
 
51
 
 
52
 
 
53
 
 
54
IV.   QUICKSTART GUIDE
 
55
 
 
56
      Please note that this section is just a quick example for people
 
57
      who want to see Subversion run immediately.  It's not an excuse
 
58
      to ignore the book!
 
59
 
 
60
      The Subversion client has an abstract interface for accessing a
 
61
      repository.  Three "Repository Access" (RA) implementations
 
62
      currently exist as libraries:
 
63
 
 
64
      libsvn_ra_dav:   accesses a networked repository using WebDAV.
 
65
      libsvn_ra_local: accesses a local repository using Berkeley DB.
 
66
      libsvn_ra_svn:   accesses a remote repository using a custom protocol.
 
67
 
 
68
      You can see which methods are available to your 'svn' client by
 
69
      running 'svn --version'.  The following example assumes that
 
70
      ra_local is available to your client.  (If you don't see
 
71
      ra_local, it probably means that Berkeley DB wasn't found when
 
72
      compiling your client binary.)
 
73
 
 
74
 
 
75
     1.  svnadmin create /path/to/repos    
 
76
  
 
77
          - this creates a new directory, 'repos'.  Make sure that
 
78
            /path/to/repos/ is on local disk, NOT a network share.
 
79
 
 
80
          - make SURE you have complete recursive read/write access to
 
81
            the newly created 'repos' directory.
 
82
 
 
83
          - understand that the repository is mainly a collection of
 
84
            BerkeleyDB files;  you won't actually see your versioned
 
85
            data if you peek in there.
 
86
 
 
87
     2.  svn import /tmp/project file:///path/to/repos -m "Initial import"
 
88
 
 
89
          - /tmp/project is a tree of data you've pre-arranged.
 
90
            If you can, use this layout, as it will help you later on:
 
91
 
 
92
               /tmp/project/branches/
 
93
               /tmp/project/tags/
 
94
               /tmp/project/trunk/
 
95
                               foo.c
 
96
                               bar.c
 
97
                               baz.c
 
98
                               etc.
 
99
 
 
100
     3. svn checkout file:///path/to/repos/trunk project
 
101
 
 
102
          - this creates a 'project' directory which is a working copy of
 
103
            the /trunk directory in the repository.
 
104
 
 
105
     4. Try using the repository:
 
106
 
 
107
          - edit a file in your working copy.
 
108
          - run 'svn diff' to see the changes.
 
109
          - run 'svn commit' to commit the changes.
 
110
          - run 'svn up' to bring your working copy up-to-date.
 
111
 
 
112
        Be sure to read chapters 2 and 3, they're a critical
 
113
        introduction to the svn commandline client.
 
114
 
 
115
     5. Get a real server process running (either apache or svnserve)
 
116
        so that your repository can be made available over a network.
 
117
        Read chapters 5 and 6 to learn about how to administer a
 
118
        repository and how to set up a server process.
 
119
 
 
120
      *** NEWBIES BEWARE:
 
121
 
 
122
      The absolute most common stumbling block for newbies is problems
 
123
      with permissions and ownership on the repository.  Any process
 
124
      that opens the repository must have complete read/write access
 
125
      to it.  This goes for any tool ('svnadmin', 'svnlook') or any
 
126
      server process (apache, svnserve), or your own svn client, if
 
127
      it's accessing via file:///.
 
128
 
 
129
      Look at the last section in chapter 6 to understand how to tweak
 
130
      repository ownership and permissions for multiple users and
 
131
      processes.
 
132
 
 
133
 
 
134
 
 
135
V.   CONVERTING FROM CVS
 
136
 
 
137
     If you're a CVS user trying to move your CVS history over to
 
138
     Subversion, then be sure to visit the 'cvs2svn' project:
 
139
 
 
140
          http://cvs2svn.tigris.org
 
141
 
 
142
     You can get the latest released version of the cvs2svn converter
 
143
     from the project downloads area:
 
144
 
 
145
          http://cvs2svn.tigris.org/servlets/ProjectDocumentList?folderID=2976
 
146
 
 
147
     Please note that the cvs2svn project is a *separate* project from
 
148
     Subversion.  If you have problems with cvs2svn or are confused,
 
149
     please email the cvs2svn project's mailing lists, not the
 
150
     Subversion lists.
 
151
 
 
152
     Finally, be sure to see Appendix A in the Subversion book.  It
 
153
     contains a very quick overview of the major differences between
 
154
     CVS and Subversion.