Difference between revisions of "Subversion"

From Organic Design wiki
m (See also)
m
 
(2 intermediate revisions by 2 users not shown)
Line 1: Line 1:
 +
{{legacy}}
 
MediaWiki's SVN uses SSH public key so you don't need a password, so you'll need to supply your ~/.ssh/id_rsa.pub file to the person setting up your [[MW:Commit access|commit access]] (if that files doesn't exist, run ssh-keygen from non-root shell using blank passwd when prompted, see [http://www.debian.org/devel/passwordlessssh this link] for details). Also, you need to set up your [[MW:Subversion/auto-props|auto-props]]. Note also that the commit's are automatically shown on the ''#mediawiki'' IRC channel (see [http://freenode.net/faq.shtml freenode FAQ] re registering a nickname etc) so it's good to have that open when working on the MediaWiki code.
 
MediaWiki's SVN uses SSH public key so you don't need a password, so you'll need to supply your ~/.ssh/id_rsa.pub file to the person setting up your [[MW:Commit access|commit access]] (if that files doesn't exist, run ssh-keygen from non-root shell using blank passwd when prompted, see [http://www.debian.org/devel/passwordlessssh this link] for details). Also, you need to set up your [[MW:Subversion/auto-props|auto-props]]. Note also that the commit's are automatically shown on the ''#mediawiki'' IRC channel (see [http://freenode.net/faq.shtml freenode FAQ] re registering a nickname etc) so it's good to have that open when working on the MediaWiki code.
  
 
== The WikiMedia repository ==
 
== The WikiMedia repository ==
 
See [[MW:Subversion]] for details about using MediaWikis SVN. Here's some examples showing retrieval of the current version of the code-base, the current version of an extension, and a version of an extension for MediaWiki 1.16 respectively.
 
See [[MW:Subversion]] for details about using MediaWikis SVN. Here's some examples showing retrieval of the current version of the code-base, the current version of an extension, and a version of an extension for MediaWiki 1.16 respectively.
{{code|<bash>
+
<source lang="bash">
 
svn co http://svn.wikimedia.org/svnroot/mediawiki/trunk/phase3
 
svn co http://svn.wikimedia.org/svnroot/mediawiki/trunk/phase3
  
Line 9: Line 10:
  
 
svn co http://svn.wikimedia.org/svnroot/mediawiki/branches/REL1_16/extensions/TreeAndMenu
 
svn co http://svn.wikimedia.org/svnroot/mediawiki/branches/REL1_16/extensions/TreeAndMenu
</bash>}}
+
</source>
  
 
== Usage ==
 
== Usage ==
 
The most important command to know is how to get help;
 
The most important command to know is how to get help;
{{code|<pre>
+
<source>
 
svn help
 
svn help
 
svn help checkout # Help on check(ing)out project to CLIENT copy
 
svn help checkout # Help on check(ing)out project to CLIENT copy
 
svn help commmit  # Help on commit(ting) changes to SERVER
 
svn help commmit  # Help on commit(ting) changes to SERVER
</pre>}}
+
</source>
  
  
 
To obtain a log of the changes made in a svn project;
 
To obtain a log of the changes made in a svn project;
{{code|<pre>
+
<source>
 
svn log -v http://[PATH TO SERVER SVN PROJECT]
 
svn log -v http://[PATH TO SERVER SVN PROJECT]
</pre>}}
+
</source>
  
  
 
Or to get changes between a certain date range in a local repo;
 
Or to get changes between a certain date range in a local repo;
{{code|<pre>
+
<source>
 
svn log -r {2012-02-10}:{2012-02-15}
 
svn log -r {2012-02-10}:{2012-02-15}
</pre>}}
+
</source>
  
  
 
To create a new repository on the server ready for importing a directory of files;  
 
To create a new repository on the server ready for importing a directory of files;  
{{code|<pre>
+
<source>
 
cd /tmp
 
cd /tmp
 
mkdir SERVER
 
mkdir SERVER
 
svnadmin create /tmp/SERVER/newrepos
 
svnadmin create /tmp/SERVER/newrepos
</pre>}}
+
</source>
  
  
 
This creates a concise database directory for the new repository on the SERVER in the directory called /tmp/SERVER;
 
This creates a concise database directory for the new repository on the SERVER in the directory called /tmp/SERVER;
{{code|<pre>
+
<source>
 
ls -l /tmp/SERVER/newrepos
 
ls -l /tmp/SERVER/newrepos
 
total 16
 
total 16
Line 51: Line 52:
 
drwxr-xr-x  11 User  wheel  374 Apr  3 13:58 hooks
 
drwxr-xr-x  11 User  wheel  374 Apr  3 13:58 hooks
 
drwxr-xr-x    4 User  wheel  136 Apr  3 13:58 locks
 
drwxr-xr-x    4 User  wheel  136 Apr  3 13:58 locks
</pre>}}
+
</source>
  
  
 
Create an example directory for upload;
 
Create an example directory for upload;
{{code|<pre>
+
<source>
 
cd /tmp
 
cd /tmp
 
mkdir MYTREE
 
mkdir MYTREE
 
echo '#!/usr/bin/perl -w\nprint "hello world";' > /tmp/MYTREE/helloWorld.pl
 
echo '#!/usr/bin/perl -w\nprint "hello world";' > /tmp/MYTREE/helloWorld.pl
 
svn import /tmp/MYTREE file:///tmp/SERVER/newrepos/some/project
 
svn import /tmp/MYTREE file:///tmp/SERVER/newrepos/some/project
</pre>}}
+
</source>
  
  
 
Listing the contents in the repository directory path;
 
Listing the contents in the repository directory path;
{{code|<pre>
+
<source>
 
svn list file:///tmp/SERVER/newrepos/some/project
 
svn list file:///tmp/SERVER/newrepos/some/project
</pre>}}
+
</source>
  
  
 
To make a local copy you need to use the checkout command. This creates a new directory (default called newrepos) which is a local copy of newrepos.
 
To make a local copy you need to use the checkout command. This creates a new directory (default called newrepos) which is a local copy of newrepos.
{{code|<pre>
+
<source>
 
mkdir CLIENT
 
mkdir CLIENT
 
cd CLIENT
 
cd CLIENT
Line 77: Line 78:
 
rm -rf /tmp/CLIENT   
 
rm -rf /tmp/CLIENT   
 
svn co file:///tmp/SERVER/newrepos/some/project/ /tmp/CLIENT # Creates CLIENT dir
 
svn co file:///tmp/SERVER/newrepos/some/project/ /tmp/CLIENT # Creates CLIENT dir
</pre>}}
+
</source>
 
''Note: The directory the svn command is run in determines where the local checkout directories and files will end up.''
 
''Note: The directory the svn command is run in determines where the local checkout directories and files will end up.''
  
  
 
Now that you have created a local copy all work should be conducted within it. There is a hidden directory called ''.svn'' which contains all the information required for the svn framework;
 
Now that you have created a local copy all work should be conducted within it. There is a hidden directory called ''.svn'' which contains all the information required for the svn framework;
{{code|<pre>
+
<source>
 
cd /tmp/CLIENT # Work in the local copy of svn
 
cd /tmp/CLIENT # Work in the local copy of svn
</pre>}}
+
</source>
  
  
 
To update a file on your CLIENT directory;
 
To update a file on your CLIENT directory;
{{code|<pre>
+
<source>
 
cd /tmp/CLIENT
 
cd /tmp/CLIENT
 
svn update # "." is updated  
 
svn update # "." is updated  
 
cd /tmp
 
cd /tmp
 
svn update /tmp/CLIENT # Specifying path
 
svn update /tmp/CLIENT # Specifying path
</pre>}}
+
</source>
  
  
 
To add a new file to the local svn copy, first make a new file within the directory structure;
 
To add a new file to the local svn copy, first make a new file within the directory structure;
{{code|<pre>
+
<source>
 
cd /tmp/CLIENT
 
cd /tmp/CLIENT
 
echo '#!/usr/bin/perl -w\nprint qq(hello world!);' > /tmp/CLIENT/helloWorld2.pl
 
echo '#!/usr/bin/perl -w\nprint qq(hello world!);' > /tmp/CLIENT/helloWorld2.pl
 
svn add helloWorld2.pl
 
svn add helloWorld2.pl
</pre>}}
+
</source>
  
  
 
The ''status'' command will identify differences between the CLIENT copy and the SERVER copy of the repoistory;
 
The ''status'' command will identify differences between the CLIENT copy and the SERVER copy of the repoistory;
{{code|<pre>
+
<source>
 
svn status /tmp/CLIENT
 
svn status /tmp/CLIENT
</pre>}}
+
</source>
  
  
 
The following list provides the details of ''svn status'' output;
 
The following list provides the details of ''svn status'' output;
{{code|<pre>
+
<source>
 
L      abc.c              # svn has a lock in its .svn directory for abc.c
 
L      abc.c              # svn has a lock in its .svn directory for abc.c
 
M      bar.c              # the content in bar.c has local modifications
 
M      bar.c              # the content in bar.c has local modifications
Line 127: Line 128:
 
R      xyz.c              # this file is scheduled for replacement
 
R      xyz.c              # this file is scheduled for replacement
 
S      stuff/squawk        # this file or dir has been switched to a branch
 
S      stuff/squawk        # this file or dir has been switched to a branch
</pre>}}
+
</source>
  
 
=== Problems ===
 
=== Problems ===
 
When attempting to import the ''/var/www'' structure into the ''/var/svn/www'' repository it bailed after coming across a filename containing special characters with the following fatal error:
 
When attempting to import the ''/var/www'' structure into the ''/var/svn/www'' repository it bailed after coming across a filename containing special characters with the following fatal error:
{{code|<pre>
+
<source>
 
svn: Can't convert string from native encoding to 'UTF-8':
 
svn: Can't convert string from native encoding to 'UTF-8':
 
svn: A?\195?\164o?\195?\188.gif
 
svn: A?\195?\164o?\195?\188.gif
</pre>}}
+
</source>
  
 
== SVN GUI's ==
 
== SVN GUI's ==

Latest revision as of 03:20, 23 April 2020

Legacy.svg Legacy: This article describes a concept that has been superseded in the course of ongoing development on the Organic Design wiki. Please do not develop this any further or base work on this concept, this is only useful for a historic record of work done. You may find a link to the currently used concept or function in this article, if not you can contact the author to find out what has taken the place of this legacy item.

MediaWiki's SVN uses SSH public key so you don't need a password, so you'll need to supply your ~/.ssh/id_rsa.pub file to the person setting up your commit access (if that files doesn't exist, run ssh-keygen from non-root shell using blank passwd when prompted, see this link for details). Also, you need to set up your auto-props. Note also that the commit's are automatically shown on the #mediawiki IRC channel (see freenode FAQ re registering a nickname etc) so it's good to have that open when working on the MediaWiki code.

The WikiMedia repository

See MW:Subversion for details about using MediaWikis SVN. Here's some examples showing retrieval of the current version of the code-base, the current version of an extension, and a version of an extension for MediaWiki 1.16 respectively.

svn co http://svn.wikimedia.org/svnroot/mediawiki/trunk/phase3

svn co http://svn.wikimedia.org/svnroot/mediawiki/trunk/extensions/TreeAndMenu

svn co http://svn.wikimedia.org/svnroot/mediawiki/branches/REL1_16/extensions/TreeAndMenu

Usage

The most important command to know is how to get help;

svn help
svn help checkout # Help on check(ing)out project to CLIENT copy
svn help commmit  # Help on commit(ting) changes to SERVER


To obtain a log of the changes made in a svn project;

svn log -v http://[PATH TO SERVER SVN PROJECT]


Or to get changes between a certain date range in a local repo;

svn log -r {2012-02-10}:{2012-02-15}


To create a new repository on the server ready for importing a directory of files;

cd /tmp
mkdir SERVER
svnadmin create /tmp/SERVER/newrepos


This creates a concise database directory for the new repository on the SERVER in the directory called /tmp/SERVER;

ls -l /tmp/SERVER/newrepos
total 16
-rw-r--r--    1 User  wheel  379 Apr  3 13:58 README.txt
drwxr-xr-x    4 User  wheel  136 Apr  3 13:58 conf
drwxr-xr-x    2 User  wheel   68 Apr  3 13:58 dav
drwxr-xr-x   10 User  wheel  340 Apr  3 13:58 db
-r--r--r--    1 User  wheel    2 Apr  3 13:58 format
drwxr-xr-x   11 User  wheel  374 Apr  3 13:58 hooks
drwxr-xr-x    4 User  wheel  136 Apr  3 13:58 locks


Create an example directory for upload;

cd /tmp
mkdir MYTREE
echo '#!/usr/bin/perl -w\nprint "hello world";' > /tmp/MYTREE/helloWorld.pl
svn import /tmp/MYTREE file:///tmp/SERVER/newrepos/some/project


Listing the contents in the repository directory path;

svn list file:///tmp/SERVER/newrepos/some/project


To make a local copy you need to use the checkout command. This creates a new directory (default called newrepos) which is a local copy of newrepos.

mkdir CLIENT
cd CLIENT
svn co file:///tmp/SERVER/newrepos/some/project/  # fetches project/test.pl
svn co file:///tmp/SERVER/newrepos/some/          # fetches some/project/test.pl
rm -rf /tmp/CLIENT  
svn co file:///tmp/SERVER/newrepos/some/project/ /tmp/CLIENT # Creates CLIENT dir

Note: The directory the svn command is run in determines where the local checkout directories and files will end up.


Now that you have created a local copy all work should be conducted within it. There is a hidden directory called .svn which contains all the information required for the svn framework;

cd /tmp/CLIENT # Work in the local copy of svn


To update a file on your CLIENT directory;

cd /tmp/CLIENT
svn update # "." is updated 
cd /tmp
svn update /tmp/CLIENT # Specifying path


To add a new file to the local svn copy, first make a new file within the directory structure;

cd /tmp/CLIENT
echo '#!/usr/bin/perl -w\nprint qq(hello world!);' > /tmp/CLIENT/helloWorld2.pl
svn add helloWorld2.pl


The status command will identify differences between the CLIENT copy and the SERVER copy of the repoistory;

svn status /tmp/CLIENT


The following list provides the details of svn status output;

L      abc.c               # svn has a lock in its .svn directory for abc.c
M      bar.c               # the content in bar.c has local modifications
M      baz.c               # baz.c has property but no content modifications
X      3rd_party           # this dir is part of an externals definition
?      foo.o               # svn doesn't manage foo.o
!      some_dir            # svn manages this, but it's either missing or incomplete
~      qux                 # versioned as file/dir/link, but type has changed
I      .screenrc           # svn doesn't manage this, and is configured to ignore it
A  +   moved_dir           # added with history of where it came from
M  +   moved_dir/README    # added with history and has local modifications
D      stuff/fish.c        # this file is scheduled for deletion
A      stuff/loot/bloo.h   # this file is scheduled for addition
C      stuff/loot/lump.c   # this file has conflicts from an update
R      xyz.c               # this file is scheduled for replacement
S      stuff/squawk        # this file or dir has been switched to a branch

Problems

When attempting to import the /var/www structure into the /var/svn/www repository it bailed after coming across a filename containing special characters with the following fatal error:

svn: Can't convert string from native encoding to 'UTF-8':
svn: A?\195?\164o?\195?\188.gif

SVN GUI's

See also