Changes between Version 2 and Version 3 of SVN_Basics


Ignore:
Timestamp:
03/22/11 11:18:17 (4 years ago)
Author:
Anna
Comment:

Text enhancement and proof-reading. Links updated.

Legend:

Unmodified
Added
Removed
Modified
  • SVN_Basics

    v2 v3  
     1[[TOC]]
     2
    13= SVN Basics =
    24
    3 [http://subversion.tigris.org/ Subversion] (SVN) is a version control system. It is designed to be distributed, concurrent and expandable.
     5[http://subversion.apache.org/ Subversion] (SVN) is a version control system. It is designed to be distributed, concurrent, and expandable.
    46
    5 [http://svnbook.red-bean.com/ Version Control with Subversion] is a wonderful book to help on making the first steps inside Subversion. You may also ready it online.
     7[http://svnbook.org/ Version Control with Subversion] is a wonderful book to help you take the first steps into the world of Subversion. You may also ready it online.
    68
    79== SVN Client ==
    810
    9 To work on the CKEditor SVN, you need a '''SVN client''' software. There are two options that we recommend:
     11To work on the CKEditor SVN, you need an '''SVN client''' software. There are two options that we recommend:
    1012
    11  * [http://tortoisesvn.sourceforge.net/ TortoiseSVN] (strongly recommended), for Microsoft Windows.
     13 * [http://tortoisesvn.net/ TortoiseSVN] (strongly recommended) for Microsoft Windows.
    1214
    13  * [http://subversion.tigris.org/ The official SVN client], included in most Linux and BSD distributions; available for Linux, BSD, Mac OS X, and Windows.
     15 * [http://subversion.apache.org/ The official SVN client], included in most Linux and BSD distributions; available for Linux, BSD, Mac OS X, and Windows.
    1416
    15 == Checkout the CKEditor trunk ==
     17== Checkout the CKEditor Trunk ==
    1618
    17 '''Checkout''' is the act of downloading the CKEditor code from our SVN server inside a local folder in your computer. This folder is called "local copy".
     19'''Checkout''' is the act of downloading the CKEditor code from our SVN server into a local folder on your computer. This folder is called a "local copy".
    1820
    1921=== With TortoiseSVN ===
    2022
    21  1. Create an empty folder, which will be your local copy root. You may give any name for it, like "ckeditor".
     23 1. Create an empty folder, which will be your local copy root. You may give it any name you wish, like {{{ckeditor}}}.
    2224
    23  2. Right-click on the new folder and select '''SVN Checkout...'''.
     25 2. Right-click the new folder and select '''SVN Checkout'''.
    2426
    25  3. In the URL of repository, paste the following URL:
     27 3. In the URL field for the repository paste the following URL:
    2628
    2729{{{
    28 http://svn.fckeditor.net/CKEditor/trunk/
     30http://svn.ckeditor.com/CKEditor/trunk/
    2931}}}
    3032
    3133=== With SVN ===
    3234
    33  1. In the command line, go to the folder where you want your local copy folder reside in.
     35 1. In the command line go to the folder where you want your local copy to reside in.
    3436
    3537 2. Type the following to checkout the trunk:
    3638
    3739{{{
    38 svn checkout http://svn.fckeditor.net/CKEditor/trunk/ ckeditor
     40svn checkout http://svn.ckeditor.com/CKEditor/trunk/ ckeditor
    3941}}}
    4042
    41 Your local copy will be found in the "ckeditor" folder.
     43Your local copy will be found in the {{{ckeditor}}} folder.
    4244
    4345== Updating your Local Copy ==
    4446
    45 At any moment, you may '''update''' your local copy to grab the code changes introduced in the repository since the checkout or the last update call.
     47At any moment you may '''update''' your local copy to grab the code changes introduced in the repository since the checkout or the last update call.
    4648
    4749=== With TortoiseSVN ===
    4850
    49  1. Right-click on your local copy folder.
     51 1. Right-click your local copy folder.
    5052
    5153 2. Select '''SVN Update'''.
     
    5355=== With SVN ===
    5456
    55  1. In the command line, move to your local copy folder.
     57 1. In the command line go to your local copy folder.
    5658
    5759 2. Type:
     
    6365== Creating Patches ==
    6466
    65 Suppose you are working to provide a fix for a ticket, for example ticket number 240. The first thing to be sure is that your local copy is fresh, so update it (see above).
     67Suppose you are working to provide a fix for a ticket, for example ticket number {{{240}}}. The first thing to check is that your local copy is fresh, so start with updating it (see above).
    6668
    67 Then, start coding inside your local copy. You can do any kind of change. Everything will be done in your computer locally. Nothing will automatically end up in the SNV server. So, you can safely play with the code.
     69Then start coding inside your local copy. You can do any kind of change. All the changes will be done locally on your computer and nothing will automatically end up in the SVN server. This means that you can safely play with the code.
    6870
    69 Once you have completed coding and well tested it, you may return your changes back to the SVN, so it will be available to everybody (other than being a license requirement :). At that point, you create a '''patch file''' to attach to the ticket.
     71Once you have completed your code and properly tested your changes you may return your changes back to the SVN, so they will be available to everybody. At that point you create a '''patch file''' to attach to the ticket.
    7072
    7173=== With TortoiseSVN ===
    7274
    73  1. Right-click on your local copy folder.
     75 1. Right-click your local copy folder.
    7476
    75  2. Select '''Create patch...'''.
     77 2. Select '''Create patch'''.
    7678
    7779 3. TortoiseSVN will list all files that have been changed. You may select the files that are relevant to the patch. Remember that each patch must be relative to a single ticket or feature. Do not mix ticket fixes or several different features.
    7880
    79  4. Clicking "Ok", save the patch file with the appropriate name. If the patch is supposed to fix a ticket, just use the ticket number for it, like "240.patch".
     81 4. Click "OK" to save the patch file with the appropriate name. If the patch is supposed to fix a ticket, just use the ticket number for it, like {{{240.patch}}}.
    8082
    81 The patch file is ready to be attached to the ticket.
     83The patch file is now ready to be attached to the ticket.
    8284
    8385=== With SVN ===
    8486
    85  1. In the command line, move to your local copy folder.
     87 1. In the command line go to your local copy folder.
    8688
    87  2. Type the following, supposing you are creating a patch file for ticket 240:
     89 2. Type the following (suppose you are creating a patch file for ticket {{{240}}}):
    8890
    8991{{{
     
    9193}}}
    9294
    93 The patch file is ready to be attached to the ticket.
     95The patch file is now ready to be attached to the ticket.
    9496
    9597== Applying Patches ==
     
    99101=== With TortoiseSVN ===
    100102
    101  1. Right-click on your local copy folder.
     103 1. Right-click your local copy folder.
    102104
    103  2. Select '''Apply patch...'''.
     105 2. Select '''Apply patch'''.
    104106
    105107 3. Select the patch file. You will be presented with the "Diff" tool, so you can review all changes.
     
    109111=== With SVN ===
    110112
    111 The official SVN program doesn't include a built in command to apply patches. To do that, you can use the regular "patch" Unix utility:
     113The official SVN program does not include a built-in command to apply patches. To do that, you can use the regular {{{patch}}} Unix utility:
    112114
    113115{{{
© 2003 – 2015 CKSource – Frederico Knabben. All rights reserved. | Terms of use | Privacy policy