Changes between Version 24 and Version 25 of SVN


Ignore:
Timestamp:
Mar 21, 2011, 2:16:30 PM (8 years ago)
Author:
Anna Tomanek
Comment:

Text enhancement and proof-reading

Legend:

Unmodified
Added
Removed
Modified
  • SVN

    v24 v25  
    66http://svn.ckeditor.com
    77
    8 The SVN contains the "development version" of CKEditor. It doesn't reflect the contents of public distributions. Actually, some files are not present in the public downloads (like the "_dev" folder or the compressed "js" files, for example).
     8The SVN contains the '''development version''' of CKEditor. It does not reflect the contents of public distributions. Actually, some files are not present in the public downloads (like the {{{_dev}}} folder or the compressed {{{.js}}} files, for example).
    99
    10 '''We don't recommend using this version on production'''. There are also security implications on doing so. To make the SVN version "production safe", it must be processed with CKReleaser (available inside _dev). A safer and easier option is to simply use the Nightly Build, which is already processed.
     10'''We do not recommend using this version in a production environment'''. There are also security implications in doing so. To make the SVN version "production safe", it must be processed with CKReleaser (available inside the {{{_dev}}} folder). A safer and easier option is to simply use the Nightly Build, which is already processed.
    1111
    1212== Nightly Build ==
    1313
    14 Every night, at 0:30 PST, a "'''Nightly Build'''" is generated, from the SVN version. Visit the following web site to download it:[[BR]]
     14Every night, at 0:30 PST, a "'''Nightly Build'''" is generated from the SVN version. Visit the following web site to download it:[[BR]]
    1515http://nightly.ckeditor.com/
    1616
    17 You may also test the nightly online directly [http://nightly.ckeditor.com/demo here].
     17You may also directly test the nightly build online [http://nightly.ckeditor.com/demo here].
    1818
    19 The nightly is processed for public distribution. As the fixes and features available on nightlies are still under testing and development, it may be used on production systems at your own risk.
     19The nightly build is processed for public distribution. As the fixes and features available on nightlies are still under testing and development, it may be used on production systems at your own risk.
    2020
    2121== Working with SVN ==
     
    2525== Testing Old Revisions ==
    2626
    27 There are occasions during the development, when bugs are introduced by recent changes in the code. To precisely understand and find when things changed, we have created a dedicated web site with a list of all revisions available for the trunk:
     27There are occasions during the development, when bugs are introduced by recent changes in the code. In order to be able to determine when things changed, we have created a dedicated website with a list of all revisions done to the trunk:
    2828
    2929http://rev.ckeditor.com/
    3030
    31 The list in the above site is quite similar to the [log:CKEditor/trunk trunk log page], with the exception that it contains and additional column called "Test". A link can be found there to open the sample pages of CKEditor, generated for each precise revision.
     31The list on the above site is quite similar to the [log:CKEditor/trunk trunk log page], with the exception that it contains an additional column called "Test". A link can be found there to open the sample pages of CKEditor generated for each precise revision.
    3232
    3333== Repository Structure ==
    3434
    3535{{{
    36 CKEditor -----------+ Every subproject will have a directory in the root.
     36CKEditor ------------+ Every subproject will have a directory in the root.
    3737    trunk -----------+ This is the development place.
    3838    branches
     
    4949All subprojects in the repository will present a structure similar to the above.
    5050
    51 === The "trunk" ===
     51=== The "Trunk" ===
    5252
    53 The trunk is the effective place we'll be working everyday. Usually we'll have local working copies of the trunk only (and possibly some branches).
     53The '''trunk''' is the effective place we will be working with everyday. Usually we will have local working copies of the trunk only (and possibly some branches).
    5454
    55 Starting from version 2.4, the trunk will always have stable code which we can publish to the public SVN, and eventually release officially. So, only important bugs and small changes will be committed here, while more delicate and extensive developments will be done in a "branch".
     55Starting from version 2.4, the trunk will always have stable code which we can publish to the public SVN, and eventually release officially. As a result, only important bugs and small changes will be committed here, while more delicate and extensive developments will be done in a "branch".
    5656
    5757=== Branches ===
    5858
    59 Branches give us isolated environments for development, and once tested and confirmed a new work is ready, it can be simply merged in the trunk.
     59'''Branches''' give us isolated environments for development, and once tested and confirmed a new code chunk is ready, it can simply be merged into the trunk.
    6060
    61 For code that doesn't bring instability, like trivial fixes or small features, there is no need to work on a separated branch. It can be committed directly to the trunk if you feel the code is ok and it is well tested. It makes the management easier.
     61For code that does not bring instability, like trivial fixes or small features, there is no need to work in a separated branch. Such code can be committed directly to the trunk if you feel the code is OK and it is well tested. This approach makes the code management easier.
    6262
    6363The branches could be created in the following spaces:
    6464
    65  * '''branches/developers''': each developer may have a private branch under this directory. The directory name is the developer name (fredck, for example). The developer himself can decide to use it or not, and have complete freedom for it.
    66  * '''branches/features''': if a feature is too big and complex, a developer could decide to create a dedicated branch for it.
    67  * '''branches/versions''': there could be branches for future versions, waiting while previous ones are being tested and released.
     65 * '''{{{branches/developers}}}''': each developer may have a private branch under this directory. The directory name is the developer name ("fredck", for example). The developer himself can decide to use it or not, and have complete freedom for it.
     66 * '''{{{branches/features}}}''': if a feature is too big and complex, a developer can decide to create a dedicated branch for it.
     67 * '''{{{branches/versions}}}''': there could be branches for future versions, waiting while the previous ones are being tested and released.
    6868
    6969==== Merging Branches ====
    7070
    71 A common task during a branch development, is to '''merge changes made in the trunk to the branch''', leaving it always up to date with the trunk. Remember that merges must be done from the last revision merged, starting from the revision from which the branch has been created.
     71A common task during the branch development is to '''merge changes made in the trunk to the branch''', leaving it always up to date with the trunk. Remember that merges must be done from the last revision merged, starting from the revision from which the branch was created.
    7272
    73 When '''merging branches to the trunk''', first merge the trunk to the branch and check that everything is ok. Make the necessary changes and commit the branch. Then switch to the trunk and merge the differences between the branch HEAD and the last trunk revision you have just merged to the branch (usually HEAD). Then, if the branch is not anymore needed, just delete it (SVN delete I mean).
     73When '''merging branches to the trunk''', first merge the trunk to the branch and check that everything is ok. Make the necessary changes and commit the branch. Then switch to the trunk and merge the differences between the branch {{{HEAD}}} and the last trunk revision you have just merged to the branch (usually {{{HEAD}}}). Then, if the branch is not needed anymore, just delete it by using SVN delete.
    7474
    75 If you are unsure, don't be afraid of asking others to execute this task for you.
     75If you are unsure about the process, do not be afraid of asking others to execute this task for you.
    7676
    77 TortoiseSVN offers a nice tool to track the creation an life-cicle of branches. It is called "Revision graph". The SVN log can also be used for it.
     77TortoiseSVN offers a nice tool to track the creation and life cicle of branches. It is called "Revision graph". The SVN log can also be used for it.
    7878
    7979=== Tags ===
     
    8383== Committing ==
    8484
    85 Try to make a single commit for each fix or feature. Avoid making big commits with lots of changes. This separation makes each commit an isolate thing. It makes code review and merge tasks easy.
     85Try to make a single commit for each fix or feature. Avoid making big commits with lots of changes. This separation makes each commit an isolated thing. It makes code review and merge tasks easy.
    8686
    87 The commit log message is very important. Don't underestimate it. It must be well written and informative. Whenever possible, make references to related Trac items, like tickets or changesets. You may use one of the "standard" messages, like the following examples:
     87The commit log message is very important. Do not underestimate it. It must be well-written and informative. Whenever possible, make references to related Trac items, like tickets or changesets. You may use one of the "standard" messages, like the following examples:
    8888
    8989 * !#81: IE has a DOM bug that caused FCKDomTools.RTrimNode to break.
     
    9696http://tortoisesvn.tigris.org/
    9797
    98 '''Subversion''': the official SVN command line. Windows binaries can be found in the download page:[[BR]]
     98'''Subversion''': the official SVN command line tool. Windows binaries can be found on the download page:[[BR]]
    9999http://subversion.tigris.org/
    100100
    101 Book - '''Version Control with Subversion''': a good book about SVN:[[BR]]
     101Book - '''Version Control with Subversion''': a recommended book about SVN:[[BR]]
    102102http://svnbook.red-bean.com/
    103103
© 2003 – 2017 CKSource – Frederico Knabben. All rights reserved. | Terms of use | Privacy policy