AlliedModders Wiki - User contributions [en]

Compiling libprotobuf

2016-04-15T22:50:49Z

Galeksandrp:

Examples for compiling a 32-bit libprotobuf and other protobuf libraries using the protobuf-2.5.0 source.

''For Dota 2, replace version 2.5.0 with 2.6.1.''

==Windows==
The following was tested on Windows 8.1 with Visual Studio 2013. Not all projects built after conversion, but only libprotobuf and dependencies were necessary.

* Download protobuf-2.5.0.zip from https://github.com/google/protobuf/releases
* Extract and navigate to protobuf-2.5.0/vsprojects/
* Open protobuf.sln in the version of Visual Studio corresponding with the VC abi version that you wish to compile for.
* Walk through project conversion steps if necessary.
* Right-click the libprotobuf project and choose properties.
* In Configuration Properties > C/C++ -> Code Generation, set Runtime Library to /MT for Release or /MTd for Debug.
* If building the Debug configuration, also add _ITERATOR_DEBUG_LEVEL=0 in Configuration Properties > C/C++ > Preprocessor > Preprocessor Defintions
* Right-click the libprotobuf project and choose Build.

libprotobuf.lib will be in Release/ or Debug/, depending on build configuration.

==Linux (32-bit host)==
The following was tested on Debian 6 (Lenny) 32-bit.

<pre>
wget https://github.com/google/protobuf/releases/download/v2.5.0/protobuf-2.5.0.tar.gz
tar -xvzf protobuf-2.5.0.tar.gz
cd protobuf-2.5.0
./configure
make
</pre>

For a debug build, replace <tt>./configure</tt> with:
<pre>
./configure CXXFLAGS="-g3 -ggdb3"
</pre>
This will also override protobuf's default CXXFLAGS of <tt>-DNDEBUG</tt>

The library will be in src/.libs/

==Linux (64-bit host)==
This hasn't been tested, but ''should'' work on most or all 64-bit distributions.

<pre>
wget https://github.com/google/protobuf/releases/download/v2.5.0/protobuf-2.5.0.tar.gz
tar -xvzf protobuf-2.5.0.tar.gz
cd protobuf-2.5.0
./configure --build=i686-pc-linux-gnu CFLAGS="-m32 -DNDEBUG" CXXFLAGS="-m32 -DNDEBUG" LDFLAGS=-m32
make
</pre>

For a debug build, replace <tt>./configure</tt> with:
<pre>
./configure --build=i686-pc-linux-gnu CFLAGS="-m32" CXXFLAGS="-m32 -g3 -ggdb3" LDFLAGS=-m32
</pre>
This will also override protobuf's default CXXFLAGS of <tt>-DNDEBUG</tt>

The library will be in src/.libs/

==Mac==
The following was tested on OS X 10.7 (Lion) and ensures that the outputted binaries are 32-bit.

<pre>
wget https://github.com/google/protobuf/releases/download/v2.5.0/protobuf-2.5.0.tar.gz
tar -xvzf protobuf-2.5.0.tar.gz
cd protobuf-2.5.0
./configure --build=x86-apple-darwin ABI=standard CFLAGS="-DNDEBUG -m32" CXXFLAGS="-m32 -DNDEBUG" LDFLAGS=-m32
make
</pre>

For a debug build, replace <tt>./configure</tt> with:
<pre>
./configure --build=x86-apple-darwin ABI=standard CFLAGS="-m32" CXXFLAGS="-m32 -g3 -ggdb3" LDFLAGS=-m32
</pre>
This will also override protobuf's default CXXFLAGS of <tt>-DNDEBUG</tt>

The library will be in src/.libs/

Building SourceMod

2016-04-15T22:42:43Z

Galeksandrp: /* Source and Dependencies */

Compiling SourceMod is not difficult, but requires a number of prerequisites. This article details the requirements and steps to being able to build working SourceMod binaries.

Note that specific compiler versions are required to maintain ABI compatibility with Source engine binaries.

=Requirements=

==Windows==
<ol>
<li>Install Visual Studio or Visual C++. VS/VC 2010 or above is required for SourceMod 1.6.x and earlier. VS/VC 2013 Update 2 or above is required for SourceMod 1.7.x and later. Express editions should work fine. If you use 2013 or higher, make sure to get the "Desktop" version: [http://www.visualstudio.com/downloads/download-visual-studio-vs#d-express-windows-desktop Visual Studio Express 2013 for Desktop].</li>
<li>Install [http://git-scm.com/ Git]. Make sure that you select the option that adds Git to PATH.</li>
<li>Next, you will need to start an environment capable of running Python and interacting with the Visual Studio compiler. There are two ways to do this.
<ul>
<li>Use [https://wiki.mozilla.org/MozillaBuild MozillaBuild]. MozillaBuild comes with Python, Mercurial, and a unix-like shell.
<ol>
<li>Install MozillaBuild to <tt>C:\mozilla-build</tt>.</li>
<li>Navigate to <tt>C:\mozilla-build</tt> and run as administrator the batch file corresponding to your Visual Studio version. For example, <tt>start-msvc10.bat</tt> for Visual Studio 2010 (10.0). Do not run an x64 version.</li>
<li>Add Git to MozillaBuild's <tt>PATH</tt>. The easiest way to do this is to enter the following commands:
<pre>
echo "export PATH=\$PATH:/c/Program\ Files\ $x86$/Git/bin" >> ~/.profile
source ~/.profile
</pre>
</li>
</ol>
</li>
<li>Or, you can manually set up a shell.
<ol>
<li>Install [http://python.org/ Python] 2.7. It will install to C:\Python27 by default. (Version 3.4 will work, but is not recommended for compatibility with other tools).</li>
<li>Add Python to your <tt>PATH</tt> variable. Go to Control Panel, System, Advanced, Environment Variables. Add <tt>C:\Python27;C:\Python27\Scripts</tt> to <tt>PATH</tt> (or wherever your Python install is).</li>
<li>Under Start, Programs, Microsoft Visual Studio, select the "Visual Studio Tools" folder and run "Visual Studio Command Prompt". Alternately, open a normal command prompt and run <tt>"C:\Program Files (x86)\Microsoft Visual Studio 10.0\VC\bin\vcvars.bat"</tt>. Substitute your Visual Studio version if needed.</li>
</ol>
</li>
</ul>
</ol>

==Linux==
<ol>
<li>Install Git, via either system packages or from the [http://git-scm.com/ Git] distribution.</li>
<li>Install either the GNU C Compiler or the Clang compiler.
<ul>
<li>For GCC, version 4.4 or higher is required for SourceMod 1.6.x and earlier, and version 4.7 or high for SourceMod 1.7.x and later. On Debian/Ubuntu-based systems, the commands below will install GCC (the second set of packages is required for building on 64-bit systems).
<pre>
sudo apt-get install gcc g++
sudo apt-get install gcc-multilib g++-multilib
</pre>
</li>
<li>For Clang, 3.2 or higher is required. On Debian/Ubuntu-based systems, the packages needed are:
<pre>
sudo apt-get install clang
</pre>
</li>
</ul>
</li>
<li>If building on a 64-bit system, a few additional packages may be required. For example on Debian/Ubuntu they are:
<pre>
sudo apt-get install ia32-libs
sudo apt-get install lib32z1 lib32z1-dev
sudo apt-get install libc6-dev-i386 libc6-i386
</pre>

Newer versions, for example Debian 7.0+ or Ubuntu 13.04+ require slightly different packages:
<pre>
sudo apt-get install lib32stdc++-4.8-dev
sudo apt-get install lib32z1 lib32z1-dev
sudo apt-get install libc6-dev-i386 libc6-i386
</pre>
</li>
</ol>

''You can find the latest release of Clang in LLVM's apt repositories for Debian and Ubuntu. Information on this is at http://llvm.org/apt/''

==Archlinux==

# Enable multilib repository as described in the [https://wiki.archlinux.org/index.php/multilib Archlinux wiki page].
# Install the following packages:
#:<pre>pacman -S git python2 gcc-multilib lib32-glibc lib32-libstdc++5 lib32-zlib</pre>

==Mac OS X==
Mac OS X 10.7 or higher is required to build, however, SourceMod will work on 10.5. SourceMod will neither build nor run on older PPC Macs.

<ol>
<li>Install the Xcode Command Line Tools.
<ul>
<li>For OS X 10.9 or higher, run the command below in Terminal and click the Install button in the window that appears.
<pre>
xcode-select --install
</pre>
</li>
<li>For earlier versions of OS X, download and install Xcode from the App Store. Launch Xcode and then navigate to Preferences -> Downloads -> Components -> Command Line Tools -> Install. If you have recently upgraded Xcode, you will need to perform this step again. SourceMod cannot build without Xcode's command line tools.</li>
</ul>
</ol>

=Source and Dependencies=

First, grab the SourceMod source tree. We recommend placing it inside its own folder, since we'll also need to download its dependencies.

'''You should do a recursive checkout of the git repo since the sourcepawn repo is a submodule of sourcemod now, see https://stackoverflow.com/questions/3796927/how-to-git-clone-including-submodules to do that.'''
<pre>
mkdir -p alliedmodders
cd alliedmodders
git clone --recursive https://github.com/alliedmodders/sourcemod
</pre>

Next, run the <tt>checkout-deps.sh</tt> script. This will download all dependencies and attempt to install AMBuild. If you are using Linux or OS X, it may prompt you for your sudo password at the very end. If you want to skip this and install AMBuild manually, just Ctrl+C. (Do not run the checkout script with sudo.)
<pre>
bash sourcemod/tools/checkout-deps.sh
</pre>

After it's done, you should see a large number of hl2sdk folders and other assorted dependencies, like MySQL, Metamod:Source, and AMBuild.

If you are on Windows, but not using MozillaBuild, then you won't be able to use the checkout-deps script. Instead, you'll have to manually clone the following repositories:
<pre>
git clone --mirror https://github.com/alliedmodders/hl2sdk hl2sdk-proxy-repo
# For each SDK you want to build with:
# git clone hl2sdk-proxy-repo hl2sdk-<SDK> -b <SDK>
# e.g. git clone hl2sdk-proxy-repo hl2sdk-csgo -b csgo

git clone https://github.com/alliedmodders/metamod-source mmsource-1.10 -b 1.10-dev
wget https://cdn.mysql.com/archives/mysql-5.0/mysql-noinstall-5.0.24a-win32.zip mysql-noinstall-5.0.24a-win32

# Install AMBuild
git clone https://github.com/alliedmodders/ambuild
cd ambuild
C:\Python27\python.exe setup.py install
</pre>

Note that you can skip MySQL and SDK versions you don't plan to build.

=Configuring=

The first time you are building a SourceMod tree, you must ''configure'' the build. This step initializes some basic information and allows some customization around how things get compiled.

First create a build folder within your sourcemod folder, and then run <tt>configure.py</tt>. For example:
<pre>
cd sourcemod
mkdir build
cd build
python ../configure.py
</pre>

It is safe to reconfigure over an old build. However, it's probably a bad idea to configure inside a random, non-empty folder.

There are a few extra options you can pass to <tt>configure</tt>:
*--enable-debug - Compile with symbols and debug checks/assertions.
*--enable-optimize - Compile with optimizations.
*--no-sse - Disable floating point optimizations (if you have a very, very old CPU).
*--no-mysql - Don't build the MySQL database module.
*--sdks css - Only build css.

See configure.py for all the options.

=Building=

To build SourceMod, simply type:
<pre>
ambuild
</pre>

In your build folder. Alternately, you can specify the path of the build folder:
<pre>
ambuild debug-build
</pre>

The full package layout that would be shipped for release is in the <tt>package</tt> folder of the build.

=Deprecated Tools=
==Visual Studio Project Files==
In the future, we will use AMBuild to automatically generate project files, and the existing project files will be removed from the SourceMod tree. In the meantime however, it is possible to use these files. Unfortunately, they require a bit of extra work to use.

First, make sure you've downloaded all necessary dependencies (SDKs, Metamod:Source source code, and MySQL) via the <tt>checkout-windows-deps.bat</tt> script. Next,
#Open the Control Panel (for example, via Start -> Settings).
#Open the System control. If you don't see it, you may need to switch to "Classic view" (either via the left-hand pane or by going to Tools -> Folder Options).
#Click the Advanced tab.
#Click the Environment Variables button.

Now, add your environment variables to either your User settings or your System settings. Create a new variable for each item in the list below. You may omit SDKs that you do not plan to build against. The item names are in <tt>fixed-width font</tt> and their value descriptions follow.
*<tt>MMSOURCE19</tt> - Path to Metamod:Source 1.10+
*<tt>MMSOURCE18</tt> - Path to Metamod:Source 1.10+
*<tt>HL2SDK</tt> - Path to HL2SDK Ep1/Original
*<tt>HL2SDKOB</tt> - Path to HL2SDK Ep2/OrangeBox for mods
*<tt>HL2SDKOBVALVE</tt> - Path to HL2SDK Source 2009 (HL2:DM, DoD:S, TF2)
*<tt>HL2SDK-SWARM</tt> - Path to HL2SDK Alien Swarm
*<tt>HL2SDK-BGT</tt> - Path to HL2SDK for Bloody Good Time
*<tt>HL2SDKCSGO</tt> - Path to HL2SDK CS:GO
*<tt>HL2SDKCSS</tt> - Path to HL2SDK CS:S
*<tt>HL2SDK-DARKM</tt> - Path to HL2SDK Dark Messiah
*<tt>HL2SDK-EYE</tt> - Path to HL2SDK E.Y.E.: Divine Cybermancy
*<tt>HL2SDKL4D</tt> - Path to HL2SDK L4D1
*<tt>HL2SDKL4D2</tt> - Path to HL2SDK L4D2
*<tt>HL2SDK-DOTA</tt> - Path to HL2SDK DOTA 2
*<tt>MYSQL5</tt> - Path to the folder that contains MySQL's <tt>include</tt> and <tt>lib</tt> folders.

==Makefiles==
Makefiles are deprecated and will be removed from the tree soon.

[[Category:SourceMod Documentation]]
[[Category:SourceMod Development]]

Building SourceMod

2016-04-15T22:27:15Z

Galeksandrp: /* Source and Dependencies */

Compiling SourceMod is not difficult, but requires a number of prerequisites. This article details the requirements and steps to being able to build working SourceMod binaries.

Note that specific compiler versions are required to maintain ABI compatibility with Source engine binaries.

=Requirements=

==Windows==
<ol>
<li>Install Visual Studio or Visual C++. VS/VC 2010 or above is required for SourceMod 1.6.x and earlier. VS/VC 2013 Update 2 or above is required for SourceMod 1.7.x and later. Express editions should work fine. If you use 2013 or higher, make sure to get the "Desktop" version: [http://www.visualstudio.com/downloads/download-visual-studio-vs#d-express-windows-desktop Visual Studio Express 2013 for Desktop].</li>
<li>Install [http://git-scm.com/ Git]. Make sure that you select the option that adds Git to PATH.</li>
<li>Next, you will need to start an environment capable of running Python and interacting with the Visual Studio compiler. There are two ways to do this.
<ul>
<li>Use [https://wiki.mozilla.org/MozillaBuild MozillaBuild]. MozillaBuild comes with Python, Mercurial, and a unix-like shell.
<ol>
<li>Install MozillaBuild to <tt>C:\mozilla-build</tt>.</li>
<li>Navigate to <tt>C:\mozilla-build</tt> and run as administrator the batch file corresponding to your Visual Studio version. For example, <tt>start-msvc10.bat</tt> for Visual Studio 2010 (10.0). Do not run an x64 version.</li>
<li>Add Git to MozillaBuild's <tt>PATH</tt>. The easiest way to do this is to enter the following commands:
<pre>
echo "export PATH=\$PATH:/c/Program\ Files\ $x86$/Git/bin" >> ~/.profile
source ~/.profile
</pre>
</li>
</ol>
</li>
<li>Or, you can manually set up a shell.
<ol>
<li>Install [http://python.org/ Python] 2.7. It will install to C:\Python27 by default. (Version 3.4 will work, but is not recommended for compatibility with other tools).</li>
<li>Add Python to your <tt>PATH</tt> variable. Go to Control Panel, System, Advanced, Environment Variables. Add <tt>C:\Python27;C:\Python27\Scripts</tt> to <tt>PATH</tt> (or wherever your Python install is).</li>
<li>Under Start, Programs, Microsoft Visual Studio, select the "Visual Studio Tools" folder and run "Visual Studio Command Prompt". Alternately, open a normal command prompt and run <tt>"C:\Program Files (x86)\Microsoft Visual Studio 10.0\VC\bin\vcvars.bat"</tt>. Substitute your Visual Studio version if needed.</li>
</ol>
</li>
</ul>
</ol>

==Linux==
<ol>
<li>Install Git, via either system packages or from the [http://git-scm.com/ Git] distribution.</li>
<li>Install either the GNU C Compiler or the Clang compiler.
<ul>
<li>For GCC, version 4.4 or higher is required for SourceMod 1.6.x and earlier, and version 4.7 or high for SourceMod 1.7.x and later. On Debian/Ubuntu-based systems, the commands below will install GCC (the second set of packages is required for building on 64-bit systems).
<pre>
sudo apt-get install gcc g++
sudo apt-get install gcc-multilib g++-multilib
</pre>
</li>
<li>For Clang, 3.2 or higher is required. On Debian/Ubuntu-based systems, the packages needed are:
<pre>
sudo apt-get install clang
</pre>
</li>
</ul>
</li>
<li>If building on a 64-bit system, a few additional packages may be required. For example on Debian/Ubuntu they are:
<pre>
sudo apt-get install ia32-libs
sudo apt-get install lib32z1 lib32z1-dev
sudo apt-get install libc6-dev-i386 libc6-i386
</pre>

Newer versions, for example Debian 7.0+ or Ubuntu 13.04+ require slightly different packages:
<pre>
sudo apt-get install lib32stdc++-4.8-dev
sudo apt-get install lib32z1 lib32z1-dev
sudo apt-get install libc6-dev-i386 libc6-i386
</pre>
</li>
</ol>

''You can find the latest release of Clang in LLVM's apt repositories for Debian and Ubuntu. Information on this is at http://llvm.org/apt/''

==Archlinux==

# Enable multilib repository as described in the [https://wiki.archlinux.org/index.php/multilib Archlinux wiki page].
# Install the following packages:
#:<pre>pacman -S git python2 gcc-multilib lib32-glibc lib32-libstdc++5 lib32-zlib</pre>

==Mac OS X==
Mac OS X 10.7 or higher is required to build, however, SourceMod will work on 10.5. SourceMod will neither build nor run on older PPC Macs.

<ol>
<li>Install the Xcode Command Line Tools.
<ul>
<li>For OS X 10.9 or higher, run the command below in Terminal and click the Install button in the window that appears.
<pre>
xcode-select --install
</pre>
</li>
<li>For earlier versions of OS X, download and install Xcode from the App Store. Launch Xcode and then navigate to Preferences -> Downloads -> Components -> Command Line Tools -> Install. If you have recently upgraded Xcode, you will need to perform this step again. SourceMod cannot build without Xcode's command line tools.</li>
</ul>
</ol>

=Source and Dependencies=

First, grab the SourceMod source tree. We recommend placing it inside its own folder, since we'll also need to download its dependencies.
<pre>
mkdir -p alliedmodders
cd alliedmodders
git clone --recursive https://github.com/alliedmodders/sourcemod
</pre>

Next, run the <tt>checkout-deps.sh</tt> script. This will download all dependencies and attempt to install AMBuild. If you are using Linux or OS X, it may prompt you for your sudo password at the very end. If you want to skip this and install AMBuild manually, just Ctrl+C. (Do not run the checkout script with sudo.)
<pre>
bash sourcemod/tools/checkout-deps.sh
</pre>

After it's done, you should see a large number of hl2sdk folders and other assorted dependencies, like MySQL, Metamod:Source, and AMBuild.

If you are on Windows, but not using MozillaBuild, then you won't be able to use the checkout-deps script. Instead, you'll have to manually clone the following repositories:
<pre>
git clone --mirror https://github.com/alliedmodders/hl2sdk hl2sdk-proxy-repo
# For each SDK you want to build with:
# git clone hl2sdk-proxy-repo hl2sdk-<SDK> -b <SDK>
# e.g. git clone hl2sdk-proxy-repo hl2sdk-csgo -b csgo

git clone https://github.com/alliedmodders/metamod-source mmsource-1.10 -b 1.10-dev
wget https://cdn.mysql.com/archives/mysql-5.0/mysql-noinstall-5.0.24a-win32.zip mysql-noinstall-5.0.24a-win32

# Install AMBuild
git clone https://github.com/alliedmodders/ambuild
cd ambuild
C:\Python27\python.exe setup.py install
</pre>

Note that you can skip MySQL and SDK versions you don't plan to build.

=Configuring=

The first time you are building a SourceMod tree, you must ''configure'' the build. This step initializes some basic information and allows some customization around how things get compiled.

First create a build folder within your sourcemod folder, and then run <tt>configure.py</tt>. For example:
<pre>
cd sourcemod
mkdir build
cd build
python ../configure.py
</pre>

It is safe to reconfigure over an old build. However, it's probably a bad idea to configure inside a random, non-empty folder.

There are a few extra options you can pass to <tt>configure</tt>:
*--enable-debug - Compile with symbols and debug checks/assertions.
*--enable-optimize - Compile with optimizations.
*--no-sse - Disable floating point optimizations (if you have a very, very old CPU).
*--no-mysql - Don't build the MySQL database module.
*--sdks css - Only build css.

See configure.py for all the options.

=Building=

To build SourceMod, simply type:
<pre>
ambuild
</pre>

In your build folder. Alternately, you can specify the path of the build folder:
<pre>
ambuild debug-build
</pre>

The full package layout that would be shipped for release is in the <tt>package</tt> folder of the build.

=Deprecated Tools=
==Visual Studio Project Files==
In the future, we will use AMBuild to automatically generate project files, and the existing project files will be removed from the SourceMod tree. In the meantime however, it is possible to use these files. Unfortunately, they require a bit of extra work to use.

First, make sure you've downloaded all necessary dependencies (SDKs, Metamod:Source source code, and MySQL) via the <tt>checkout-windows-deps.bat</tt> script. Next,
#Open the Control Panel (for example, via Start -> Settings).
#Open the System control. If you don't see it, you may need to switch to "Classic view" (either via the left-hand pane or by going to Tools -> Folder Options).
#Click the Advanced tab.
#Click the Environment Variables button.

Now, add your environment variables to either your User settings or your System settings. Create a new variable for each item in the list below. You may omit SDKs that you do not plan to build against. The item names are in <tt>fixed-width font</tt> and their value descriptions follow.
*<tt>MMSOURCE19</tt> - Path to Metamod:Source 1.10+
*<tt>MMSOURCE18</tt> - Path to Metamod:Source 1.10+
*<tt>HL2SDK</tt> - Path to HL2SDK Ep1/Original
*<tt>HL2SDKOB</tt> - Path to HL2SDK Ep2/OrangeBox for mods
*<tt>HL2SDKOBVALVE</tt> - Path to HL2SDK Source 2009 (HL2:DM, DoD:S, TF2)
*<tt>HL2SDK-SWARM</tt> - Path to HL2SDK Alien Swarm
*<tt>HL2SDK-BGT</tt> - Path to HL2SDK for Bloody Good Time
*<tt>HL2SDKCSGO</tt> - Path to HL2SDK CS:GO
*<tt>HL2SDKCSS</tt> - Path to HL2SDK CS:S
*<tt>HL2SDK-DARKM</tt> - Path to HL2SDK Dark Messiah
*<tt>HL2SDK-EYE</tt> - Path to HL2SDK E.Y.E.: Divine Cybermancy
*<tt>HL2SDKL4D</tt> - Path to HL2SDK L4D1
*<tt>HL2SDKL4D2</tt> - Path to HL2SDK L4D2
*<tt>HL2SDK-DOTA</tt> - Path to HL2SDK DOTA 2
*<tt>MYSQL5</tt> - Path to the folder that contains MySQL's <tt>include</tt> and <tt>lib</tt> folders.

==Makefiles==
Makefiles are deprecated and will be removed from the tree soon.

[[Category:SourceMod Documentation]]
[[Category:SourceMod Development]]

Subversion Tutorial

2016-04-15T22:24:03Z

Galeksandrp: /* Introduction */

Subversion (SVN) is a version control system designed specifically to be a modern replacement for [[CVS_Tutorial|CVS]]. This article briefly overviews the essentials of SVN, as well as using SVN on Linux and on Windows (through TortoiseSVN).

{{Note| AlliedModders no longer uses SVN as the main method of distrobution. Please check out the [[Mercurial_Tutorial]]}}

=Essentials=
==Introduction==
The best analogy for SVN's model is a library. The library maintains the "master" copies of all the source code. To obtain the source code, you "check out" a copy. You can then make revisions to your copy. When you're ready to return your changes to the master copy, it is called a "commit."

SVN source code repositories can separated into "modules," which are simply sub-directories of the repository. Each module can have directories or files (both text and binary).

Access to SVN repositories is generally based on three methods:
* Local filesystem or network filesystem, accessed by client directly (via file://)
* WebDAV/DeltaV (over HTTP or HTTPS) using the mod_dav_svn module for Apache 2
* Custom "svn" protocol using svnserve, either plain text (svn://) or over SSH (svn+ssh://)

==Basic Commands==

These are the four essential SVN operations:
*<tt>co</tt> (or <tt>checkout</tt>) - Retrieves the current copy of the source tree.
*<tt>update</tt> - Updates your local copy to sync any changes from the master.
*<tt>add</tt> - Adds a file or directory to the local source tree.
*<tt>commit</tt> - Commits any local changes to the master (including adds).

===Checkouts===
Normally, you only need to checkout code once. After this, you can simply update your code to acquire any changes. A clean checkout often helps remove stale files.

===Updates===
In practice, you should always update your local source copy before editing. This is to prevent merge problems, where two developers edit the same file and try to commit it at the same time.

Some people prefer to keep two copies of the source locally. The first copy is used only for committing changes and updating, and the second copy is only used for editing. This essentially keeps a local master and a local volatile copy.

===Adds/Removals===
SVN adds are also complemented by removals (the command is <tt>remove</tt> or <tt>delete</tt>). Both are considered changes to the source tree, and thus, they do not take effect until committed.

===Commits===
SVN commits are always atomic and transactional. That means if you commit a set of changes while your copy is older than the master, or otherwise unsynced, that file cannot be committed (and you may have to manually merge changes in). Furthermore, when committing a set of files, if one fails, the entire commit should fail.

When commits do fail, it is important to review why. Otherwise, you could risk reverting changes from another author.

==Differences From CVS==
While SVN is fairly similar to [[CVS_Tutorial|CVS]], there are some important differences that should be noted.

===Revisions===
In CVS, revisions are on a per-file basis. In Subversion, the repository looks like a single filesystem. Thus, each commit results in an entirely new filesystem tree and each tree is given a revision number. When someone speaks of revision 25, they are referring to the way the SVN repository looked after the 25th commit. In short, revision numbers refer to a particular state of the repository.

===Directories===
In CVS, directories are merely containers for other files or directories. But in SVN, directories are versioned in the same way files are. If a new commit only contains directory changes then a new revision number will be assigned to that commit. This means that the <tt>remove</tt> or <tt>delete</tt> commands work on directories.

===Branches and Tags===
SVN does not distinguish between filesystem space and “branch” space. Branches and tags are regular directories within the repository filesystem.

In general, the root directory of a repository might contain three directories: <tt>trunk</tt>, <tt>tags</tt>, and <tt>branches</tt>. The trunk can be compared to a CVS repository's "head" or it could be considered as the main branch of a project. The tags and branches directories are self-explanatory.

Creating a tag or branch simply involves using SVN's <tt>copy</tt> command to copy the trunk or a specfic revision into the tags or branches directory.

=TortoiseSVN=
==Introduction==
TortoiseSVN is a Windows Explorer/Shell SVN integration tool. Most users like it for its inherent simplicity and the quick ability to checkout source from within any Windows directory.

TortoiseSVN can be downloaded from: https://tortoisesvn.net/downloads.html

Once installed, you should either kill and restart all explorer.exe instances, or simply reboot. Once installed, read below.

==Basic Usage==
To start, create an empty folder anywhere on your computer. Open it and right click somewhere inside. You should see a "SVN Checkout" option similar to below. Click it.

[[Image:TortoiseSVN Checkout.png|thumb|250px|Empty TortoiseSVN Menu]]

The dialog box will say "Checkout." This is where you enter the information about the SVN server.
*<tt>URL of repository:</tt> - This is where you enter the server's path to the SVN repository. You must know this in advance.
*<tt>Checkout directory:</tt> - This is where the working copy of the repository will be stored. This is usually automatically filled.

For example, SVN connections to alliedmods.net generally look like:

[[Image:TortoiseSVN CheckoutSample.png]]

If you have an account on the server, and you know you have SSH based access to the repository, then <tt>svn+ssh://</tt> should be at the beginning of the URL, followed by your account user name and a <tt>@</tt>. This is shown in the example image. However, if you wish to anonymously check out a repository or do not have an actual account on the server, then <tt>svn://</tt> must be at the beginning, followed by the path to repository with no user name specified. For example, it might look like this:
<pre>svn://alliedmods.net/sourcemm/trunk</pre>

If the repository you are checking out has the tag/branch/trunk directory structure, you should be certain to check out the trunk or a specific branch or tag. Otherwise you may end up downloading every tag and branch along with the trunk.

Once all the files are downloaded, you will see them in the folder. You can then perform general SVN operations, such as committing, by right clicking in the empty spaces.

To operate on a specific file, you can simply right click on the file. TortoiseSVN addd overlays to the file icons based on their status. A green checkmark means "unmodified locally," a red exclamation point means "modified locally," and an orange exclamation point means "merge conflict." Files not in the repository do not have any overlay icons.

To commit changes, simply right click and choose "Commit." You can either commit all changes to the local scope or one single file. When you commit, you are allowed to attach a text comment to your revision. This is a good way to let people watching or reading the SVN repository to see an overview of your changes.

[[Image:TortoiseSVN Menu.png]]

==Adding/Removing Files and Directories==
Right click on the new file and then choose "Add". Click OK on the dialog box. You will need to commit.

[[Image:TortoiseSVN Adding.png]]

To add a directory and all its files, right click on the directory and click "Add." You will get a dialog box similar to below. It is important to uncheck files that might accidentally get merged in, such as password text files, binaries, et cetera.

[[Image:TortoiseSVN AddFolder.png]]

Likewise, to remove a file, simply right click it and use "Remove." Directories are removable as well.

=Linux/Command Line SVN=
==Introduction==
Command line SVN requires the SVN binary to be installed and ideally accessible from your PATH environment variable.

Before you begin, you should also know whether or not the repository you are trying to checkout will be accessed via SSH or not. If you have an account on the server containing the repository, then it is likely you will be using SSH via the <tt>svn+ssh://</tt> protocol when you enter the URL to the repository. If you wish to anonymously checkout a repository or do not have an account on the server then you will be using the <tt>svn://</tt>.

==Basic Usage==
The checkout example from TortoiseSVN would look like:
<pre>svn co svn+ssh://dscrab@alliedmods.net@alliedmods.net/sourcemm/trunk sourcemm</pre>

This will create a new directory called "source" which will contain all the downloaded files from the master's trunk.

To then update this copy, you simply need to type "svn update" while inside the directory.

Similarly, "svn commit" will attempt to commit the files in the current directory. It will bring up an editor (defined in the <tt>SVN_EDITOR</tt> or <tt>EDITOR</tt> environment variables) so you can type your comment -- simply save and exit the editor once done.

You can "svn add <file>" or "svn remove <file>" as well.

==Creating Repositories/Modules==
If your SVN is local, you can create a new repository like this:
<pre>svnadmin create mysvn</pre>
This will create a directory in the current location named <tt>mysvn</tt> which will contain the new repository.

To create a new module, create an empty directory somewhere. Then use "svn import" as shown. Note that if you use this with a directory that contains files, the files will be added as the initial import. This is a good idea if you already have the source code structure in place.
<pre>mkdir trunk
svn import -m "Initial import" trunk file:///home/users/damagedsoul/mysvn
</pre>
The URL to the file can also use <tt>svn+ssh://</tt> or <tt>svn://</tt> if you so desire.

=SSH Authentication=
If you are accessing your repository via SSH using the <tt>svn+ssh</tt> protocol, you may have noticed that you must enter your password more than once on certain occasions. When checking out a repository, you may have to enter your password three or four times. Operations such as adding, removing, or committing usually only ask for your password once. But other commands may also require it more than once.

However, there is way around this through the use of a private-public key pair. See [[SSH_Keys|SSH Keys]] for more details.

=External Links=
*[http://subversion.tigris.org/ Subversion Home Page]
*[http://tortoisesvn.tigris.org/ TortoiseSVN Home Page]
*[http://svnbook.red-bean.com/ Version Control with Subversion] - free online book about Subversion with lots of helpful information
*[http://en.wikipedia.org/wiki/Subversion_%28software%29 Subversion Wikipedia article]

[[Category:Version Control Systems]]