Author: pfg
Date: Thu Jun 7 03:20:57 2012
New Revision: 1347349
URL: http://svn.apache.org/viewvc?rev=1347349&view=rev
Log:
Add some notes with best practices.
Modified:
incubator/ooo/site/trunk/content/openofficeorg/svn-basics.mdtext
Modified: incubator/ooo/site/trunk/content/openofficeorg/svn-basics.mdtext
URL:
http://svn.apache.org/viewvc/incubator/ooo/site/trunk/content/openofficeorg/svn-basics.mdtext?rev=1347349&r1=1347348&r2=1347349&view=diff
==============================================================================
--- incubator/ooo/site/trunk/content/openofficeorg/svn-basics.mdtext (original)
+++ incubator/ooo/site/trunk/content/openofficeorg/svn-basics.mdtext Thu Jun 7
03:20:57 2012
@@ -219,22 +219,40 @@ If you choose `e`, Subversion will launc
Only Committers can commit directly to the repository. The following example
shows using your Apache ID and password.
- $ svn commit test-file.txt --username your-name --password your-password \
- -m "added new line"
+ $ svn commit test-file.c --username your-name --password your-password \
+ -m "added new C file"
Sending test-file.txt
Transmitting file data .
Committed revision 5.
+In general, you may not have to include always your username or password if
you do a proper setup of your ssh key or have subversion store the password.
+
+Always check your changes with "svn diff" and "svn status". Also be careful to
specify the files and/or directories you want to change, if
+you don't specify, SVN will commit **all** your changes.
+
For further information see the [Basic Work Cycle][8] page from [Subversion
Book][2].
## <a id="commit_message"></a>Commit Message
The examples in the previous sections use a simple commit message with the
"-m" option.
-This is fine for some quick testing or for large bulk commits. However, we ask
that
-your commits include special tagging to appropriately credit the patch.
+This is fine for some quick testing or for large bulk commits of code that you
wrote.
+
+We ask that your commits include special tagging to appropriately credit the
patch.
See the [crediting
section](http://subversion.apache.org/docs/community-guide/conventions.html#crediting)
of the Coding and Commit
Conventions of the Apache Subversion project.
+Log comments are important.
+Information like author, where the change start/ends, the date, the bugzilla
issue, and the author don't really belong
+in the code as SVN can keep it much more effectively without altering the
coding style.
+Always try to use a log file for your commits. The previous commit when done
by an experienced committer
+should actually look like this:
+
+ $ svn ci -F test-log.txt test-file.c
+ Sending test-file.c
+ Transmitting file data .
+ Committed revision 5.
+
+
Use of the special fields will enable processing by scripts like the
[contribulyzer](http://www.red-bean.com/svnproject/contribulyzer/) to help
quickly identify
contributors.
@@ -287,4 +305,4 @@ For more information see:
[8]: http://svnbook.red-bean.com/nightly/en/svn.tour.cycle.html
[9]: http://www.apache.org/dev/committers.html#applying-patches
[10]: http://www.apache.org/dev/contributors.html#patches
-[11]: http://www.apache.org/dev/
+[11]: http://www.apache.org/dev/
\ No newline at end of file
