Subversion

From VideoLAN Wiki
Revision as of 07:35, 21 December 2006 by J-b (talk | contribs)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search

The VideoLAN's repository is now using Subversion, which is ever so slightly trendier than CVS but provides a pretty similar interface so should not be too disruptive. It also provides a better control over the repository.

Currently the repository is hosted on one of the VideoLAN Servers.

To use it, you have to download the official command line Subversion client. You can also use alternative clients, such as the graphical TortoiseSVN for Windows.

Subversion's command-line interface is generally pretty similar to CVS. This is a basic and partial guide of the most useful commands. For a complete guide, use the book Version Control with Subversion. If you have a write access to the server, it's very recommended that you read it and know about the advanced features of Subversion, because you might use them sooner or later.

Anonymous use

If you don't have a write access to the repository, you have to access it anonymously, via regular SVN. However, most of the techniques shown here may be useful also for developer use, so please read it even if you don't have to access the server anonymously.

Check out

First, you have to check out the code of VLC media player. Use the following syntax: 

 svn checkout svn://svn.videolan.org/vlc/trunk vlc-trunk

You can browse the code structure using the Trac's web interface (Trac). Use the three folders there for different purposes:

  • Trunk is the main development branch.
  • The branches are used for stable versions and for the development of complex features.
  • The tags are used to track the released versions.

The URL structure is:

transport 
svn://svn.videolan.org
project repository 
/vlc
branch/tag 
/trunk, or /branches/0.8.6, or /tags/0.8.5
files 
/README

You can also checkout a portion of the SVN using the URL.

Don't leave off the "trunk" or branch part! If you leave that off you check out every revision of every file in the repo, which is pretty silly.

Projects on VideoLAN's SVN

   * svn://svn.videolan.org/vlc: VLC media player;
   * svn://svn.videolan.org/vls: VideoLAN Server;
   * svn://svn.videolan.org/libdvdcss: library for decrypting DVDs, used by VLC media player and VLS.
   * svn://svn.videolan.org/libdvdplay: library for DVD navigation, used by VLC media player.
   * svn://svn.videolan.org/libdvbpsi: library for parsing Program Specific Information from MPEG and DVB streams, used by VLC and VLS.
   * svn://svn.videolan.org/x264: library for H.264/AVC encoding, used by VLC media player.
   * svn://svn.videolan.org/videolan/www.videolan.org: the website (no trunk or branches)
   * svn://svn.videolan.org/videolan/developers.videolan.org: the developers website (no trunk or branches)


Updating the working copy

To update your working copy and get the latest files, use the following command: 

svn update

Note that SVN, unlike CVS, doesn't need to be told to prune removed files or create new directories. This is automagic.

Making a diff

Diffs, or patches, are text files which include all the changes done in the working copy. If you suggest a new feature in Bugzilla and like to suggest a change which fixes it, upload a patch.

To create a diff from the current repository, use the following command: 

svn diff

Normally, unlike CVS, you don't have to tell SVN which files you changed; however, you may like to diff only a part of the repository. To do that, specify the files to diff: 

svn diff includes/SpecialMyAwesomePage.php

Note that SVN defaults to the "unified" diff format, so the "-u" option doesn't have to be passed.

Applying a diff

Subversion does not contain a built in command to apply diffs to the current working copy (for example, to review or commit diffs published in Bugzilla); instead, you can use the regular patch unix utility: 

patch -p0 < patch

TortoiseSVN has a built-in support for applying a diff.

Changing file structure

You can add files or folders to the working copy, to be included in the next diff or commit, using the command: 

svn add file.name

If you add a folder, it will add all the files included in the folder, except for files in the ignored list.

You can delete files or folders from the working copy, to be deleted in the next commit or marked as such in the next diff, using the command (which will automatically delete the files from the working copy, but won't delete folders in such way): 

svn delete file.name

Make sure the file or folder do not have local modifications, else they won't be deleted unless you force the deletion.

Reverting your changes

If your changes in the working copy are not useful in your opinion, you can revert them using the following command: 

svn revert

You must use parameters for this command. To revert all your changes in the working copy, use: 

svn revert -R .

To revert the changes in a specific file, use: 

svn revert file.name

Reverting can also remove added files (they won't be deleted, just removed and considered "unknown files", just like you didn't use svn add at first), and restore deleted files (both deleted by hand and deleted by svn delete).

Checking the status of the working copy

You can check the status of your working copy using the following command: 

svn status

These are several important letters in the first column of the item, which show the status:

  • M = the item was modified by you
  • A = the item was added by you (using svn add)
  • D = the item was deleted by you (using svn delete)
  •  ? = the item is not under the version control, but exist
  •  ! = the item is missing (under the version control, but not exist - probably deleted without using svn delete) or incomplete

Developer use

If you have a write access for the server, you can use an SSH access instead of HTTP access. This might change later.

Create SSH key

Follow the instructions in Sourceforge to create an SSH key when requested. Remember the passphrase, keep the private key, and send the public key.

URLs

Replace the server name http://svn.wikimedia.org to svn+ssh://your_user_name@svn.wikimedia.org in all the commands (e.g. svn checkout), then you will be able to use the normal functions, when you will have to enter your passphrase for a functions require web access. Sometimes you will be required to enter your passphrase more than once. If you will make a mistake in the passphrase, you will be requested to type it again.

For example, to check out the latest trunk as an anonymous, you use: 

svn checkout http://svn.wikimedia.org/svnroot/mediawiki/trunk/phase3 wiki

To check it out as a developer, use: 

svn checkout svn+ssh://your_user_name@svn.wikimedia.org/svnroot/mediawiki/trunk/phase3 wiki

Auto properties

See Subversion/auto-props for how to enable automatic line-ending conversion for files you add. Every developer should use it.

Commits

Commits, or check ins, are the action of applying your changes from the working copy to the web repository. Use the following command to do that: 

svn commit

Using the command without the parameters will fail, unless you've configured an editor, because you have to enter a comment for the file logs. You can use one of the following forms: 

svn commit --message="This is the log comment."
svn commit --file=file_with_log_comment

Converting a CVS checkout to SVN

Assuming you don't want to keep any local changes to files in the repository, it's easy to just overwrite everything with a fresh checkout. This will keep your local files, such as LocalSettings.php and custom skins. 

svn co http://svn.wikimedia.org/svnroot/mediawiki/trunk/phase3 temp-checkout
rsync -a temp-checkout/ /path/to/phase3/

The following works if you didn't delete any directories: 

svn revert -R /path/to/phase3

And if you want to get rid of the old CVS dirs: 

find . -type d -name CVS -print0 | xargs -0r rm -rf

Be careful with that one. ;)

See also

External links

Retrieved from "https://wiki.videolan.org/index.php?title=Subversion&oldid=6892"