swift 08/05/19 19:45:31 Modified: cvs-tutorial.xml Log: Coding style, removing traling whitespace
Revision Changes Path 1.19 xml/htdocs/doc/en/cvs-tutorial.xml file : http://sources.gentoo.org/viewcvs.py/gentoo/xml/htdocs/doc/en/cvs-tutorial.xml?rev=1.19&view=markup plain: http://sources.gentoo.org/viewcvs.py/gentoo/xml/htdocs/doc/en/cvs-tutorial.xml?rev=1.19&content-type=text/plain diff : http://sources.gentoo.org/viewcvs.py/gentoo/xml/htdocs/doc/en/cvs-tutorial.xml?r1=1.18&r2=1.19 Index: cvs-tutorial.xml =================================================================== RCS file: /var/cvsroot/gentoo/xml/htdocs/doc/en/cvs-tutorial.xml,v retrieving revision 1.18 retrieving revision 1.19 diff -u -r1.18 -r1.19 --- cvs-tutorial.xml 23 May 2005 12:06:22 -0000 1.18 +++ cvs-tutorial.xml 19 May 2008 19:45:31 -0000 1.19 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8"?> -<!-- $Header: /var/cvsroot/gentoo/xml/htdocs/doc/en/cvs-tutorial.xml,v 1.18 2005/05/23 12:06:22 neysx Exp $ --> +<!-- $Header: /var/cvsroot/gentoo/xml/htdocs/doc/en/cvs-tutorial.xml,v 1.19 2008/05/19 19:45:31 swift Exp $ --> <!DOCTYPE guide SYSTEM "/dtd/guide.dtd"> @@ -120,9 +120,9 @@ first is that in order to connect to a CVS repository, you first need to know a path called the "CVSROOT". The CVSROOT is a string, like a URL, that tells the cvs command where the remote repository is and how we'd like to connect to -it. Just to make things interesting, CVS has a number of CVSROOT formats, -depending on whether the CVS repository is local or remote and what method -you're going to use to connect to it. Here are some example CVSROOTs, along +it. Just to make things interesting, CVS has a number of CVSROOT formats, +depending on whether the CVS repository is local or remote and what method +you're going to use to connect to it. Here are some example CVSROOTs, along with explanations... </p> @@ -229,7 +229,7 @@ <p> Here are the commands needed to get a current copy of the developer sources. -You may want to jump forward to the next panel to read the explanation of +You may want to jump forward to the next panel to read the explanation of these commands, and then jump back here: </p> @@ -259,7 +259,7 @@ CVS client to check out ("co") the samba module using a gzip compression level of 5 ("-z5") to speed up the transfer over a slow link. For every new file that is created locally, cvs prints out a "U [path]" indicating that this -particular file has been updated on disk. +particular file has been updated on disk. </p> </body> @@ -269,13 +269,13 @@ <body> <p> -Once the checkout command completes, you'll see a "samba" directory in your -current working directory that contains the latest sources. You'll also notice -that all the directories have a "CVS" directory inside them -- CVS stores +Once the checkout command completes, you'll see a "samba" directory in your +current working directory that contains the latest sources. You'll also notice +that all the directories have a "CVS" directory inside them -- CVS stores accounting information inside these directories, and they can safely be ignored. -From this point forward, we don't need to worry about having the CVSROOT -environment variable set nor do we need to specify it on the command line -because it's now cached inside all those extra "CVS" directories. Remember -- +From this point forward, we don't need to worry about having the CVSROOT +environment variable set nor do we need to specify it on the command line +because it's now cached inside all those extra "CVS" directories. Remember -- you only need to have the CVSROOT set for the initial login and checkout. </p> @@ -323,10 +323,10 @@ <body> <p> -Also, notice the two command-line options we used for "cvs update". "-d" tells -cvs to create any new directories that may have been added to the repository -(this doesn't happen by default), and "-P" tells cvs to remove any empty -directories from your locally checked-out copy of the sources. "-P" is a good +Also, notice the two command-line options we used for "cvs update". "-d" tells +cvs to create any new directories that may have been added to the repository +(this doesn't happen by default), and "-P" tells cvs to remove any empty +directories from your locally checked-out copy of the sources. "-P" is a good idea, because cvs has a tendency to collect a lot of empty (once used, but now abandoned) directory trees over time. </p> @@ -371,16 +371,16 @@ current version in the repository -- but what happens to the changes you've made? Don't worry, they aren't thrown away. If another developer made changes to a file that you haven't touched, your local file will be updated so that -it's in-sync with the version on the repository. +it's in-sync with the version on the repository. </p> <p> -And, if you modified lines 1-10 of a local file, and another developer deleted +And, if you modified lines 1-10 of a local file, and another developer deleted lines 40-50, added 12 new lines at the end of the file, modified lines 30-40 and -then committed their changes to the repository before you, cvs will -intelligently merge these changes into your locally modified copy so that none -of your changes are lost. This allows two or more developers to work on -different parts of the same file at the same time. +then committed their changes to the repository before you, cvs will +intelligently merge these changes into your locally modified copy so that none +of your changes are lost. This allows two or more developers to work on +different parts of the same file at the same time. </p> </body> @@ -438,7 +438,7 @@ <p> It's really easy to view the complete history of a particular file, along -with any comments that the developers (including you) may have made when +with any comments that the developers (including you) may have made when committing. To view this information, type: </p> @@ -462,9 +462,9 @@ <body> <p> -You may want to use another editor than the one cvs starts by default when you +You may want to use another editor than the one cvs starts by default when you type "cvs commit". If so, simply set the EDITOR environment variable to the name -of the editor you want to use. Putting a setting such as this one in your +of the editor you want to use. Putting a setting such as this one in your <path>~/.bashrc</path> would be a good idea: </p> @@ -473,7 +473,7 @@ </pre> <p> -Alternatively, you can also specify a log message as a command line option so +Alternatively, you can also specify a log message as a command line option so that cvs doesn't need to load up an editor in the first place: </p> @@ -489,14 +489,14 @@ <p> Before we continue looking at more cvs commands, I recommend setting up a -<path>~/.cvsrc</path> file. By creating a <path>.cvsrc</path> file in your -home directory, you can tell cvs to use preferred command-line options by -default so that you don't have to remember to type them in each time. Here's a +<path>~/.cvsrc</path> file. By creating a <path>.cvsrc</path> file in your +home directory, you can tell cvs to use preferred command-line options by +default so that you don't have to remember to type them in each time. Here's a recommended default <path>.cvsrc</path> file: </p> <pre caption="Recommended defaults"> -cvs -q +cvs -q diff -u -b -B checkout -P update -d -P @@ -510,9 +510,9 @@ <p> In addition to setting useful options for a bunch of cvs commands, the first -line of the <path>.cvsrc</path> puts cvs into quiet mode, which has the primary +line of the <path>.cvsrc</path> puts cvs into quiet mode, which has the primary benefit of making the <c>cvs update</c> output more consise and readable. Also, -once you have this .cvsrc in place, you can type <c>cvs update</c> instead of +once you have this .cvsrc in place, you can type <c>cvs update</c> instead of typing <c>cvs update -dP</c>. </p> @@ -523,7 +523,7 @@ <body> <p> -It's really easy to add a source file to CVS. First, create the file with your +It's really easy to add a source file to CVS. First, create the file with your favorite text editor. Then, type the following: </p> @@ -576,7 +576,7 @@ <pre caption="Adding a file, but receive a failure"> # <i>cvs add myfile.c</i> cvs add: cannot open CVS/Entries for reading: No such file or directory -cvs [add aborted]: no repository +cvs [add aborted]: no repository </pre> </body> @@ -587,9 +587,9 @@ <p> Before we take a look at how to resolve conflicts, let's get familiar with the -output of the "cvs update" command. If you created a ~/.cvsrc file that -contains a "cvs -q" line, you'll find "cvs update" output a lot easier to read. -"cvs update" informs you of what it does and sees by printing out a single +output of the "cvs update" command. If you created a ~/.cvsrc file that +contains a "cvs -q" line, you'll find "cvs update" output a lot easier to read. +"cvs update" informs you of what it does and sees by printing out a single character, a space, and a filename; as an example: </p> @@ -597,7 +597,7 @@ # <i>cvs update -dP</i> ? distfiles ? packages -? profiles +? profiles </pre> </body> @@ -607,9 +607,9 @@ <body> <p> -"cvs update" uses the "?" character to tell you that it doesn't know anything +"cvs update" uses the "?" character to tell you that it doesn't know anything about these particular files that it finds in the local copy of your repository. -They're not officially part of the repository, nor have they been scheduled for +They're not officially part of the repository, nor have they been scheduled for addition. Here's a list of all the other single-character informational messages that CVS uses: </p> @@ -619,7 +619,7 @@ </pre> <p> -Used when a new file is created in your local repository, or an untouched (by +Used when a new file is created in your local repository, or an untouched (by you) file has been updated. </p> @@ -628,7 +628,7 @@ </pre> <p> -This file is scheduled for addition and will be officially added to the +This file is scheduled for addition and will be officially added to the repository when you do a <c>cvs commit</c>. </p> @@ -643,7 +643,7 @@ </pre> <p> -Like "A", an "R" lets you know that this file is scheduled for removal. The +Like "A", an "R" lets you know that this file is scheduled for removal. The file will be removed from the repository as soon as you <c>cvs commit</c>. </p> @@ -652,7 +652,7 @@ </pre> <p> -This means that this file has been modified by you; additionally, it's possible +This means that this file has been modified by you; additionally, it's possible that new changes from the repository were merged into this file successfully. </p> @@ -661,7 +661,7 @@ </pre> <p> -The "C" character indicates that this file has a conflict and requires manual +The "C" character indicates that this file has a conflict and requires manual fixing before you can "cvs commit" your changes. </p> @@ -677,7 +677,7 @@ We developers spend most of our time hacking away at the sources inside the "gentoo-x86" module. Inside the gentoo-x86 module, we have a file called "ChangeLog" that houses (you guessed it) a description of the major changes we -make to the files in the repository. +make to the files in the repository. </p> </body> @@ -695,21 +695,21 @@ <pre caption="ChangeLog entry"> date 25 Feb 2001 - + This is the thing I added myself </pre> <p> However, let's say that before I'm able to commit these three new lines, another -developer adds these lines to the top of the ChangeLog and commits their +developer adds these lines to the top of the ChangeLog and commits their changes: </p> <pre caption="ChangeLog entry 2"> date 25 Feb 2001 - + This is the part added by another developer -</pre> +</pre> </body> @@ -719,9 +719,9 @@ <body> <p> -Now, when I run <c>cvs update -dP</c> (as you should before every commit), cvs -isn't able to merge the changes into my local copy of ChangeLog because we -both have added lines to the exact same part of the file -- how is cvs to know +Now, when I run <c>cvs update -dP</c> (as you should before every commit), cvs +isn't able to merge the changes into my local copy of ChangeLog because we +both have added lines to the exact same part of the file -- how is cvs to know which version to use? So, I get the following error from CVS: </p> @@ -750,14 +750,14 @@ <pre caption="ChangeLog conflict"> <<<<<<< ChangeLog date 25 Feb 2001 - + This is the thing I added myself - + ======= date 25 Feb 2001 - + This is the part added by another developer - + >>>>>>> 1.363 </pre> @@ -785,8 +785,8 @@ </pre> <p> -Now that I've replaced the conflicting region of the file with the appropriate -text (and removed the "=======", etc markers), I can now commit my changes to +Now that I've replaced the conflicting region of the file with the appropriate +text (and removed the "=======", etc markers), I can now commit my changes to cvs without any problems. </p> @@ -803,7 +803,7 @@ also obviously very important to remove the special markers that cvs added to the conflicting file. Another tip -- if you make a mistake while fixing the conflict and then ("D'oh!") accidentally save your changes, you can find an -original copy of your version in the file ".#filename.version". +original copy of your version in the file ".#filename.version". </p> </body> @@ -813,9 +813,9 @@ <body> <p> -Now, it's time to learn our final CVS skill -- removing files from the -repository. Removing a file is a two-stage process. First, delete the file -from your local copy of the sources, and then execute the appropriate <c>cvs +Now, it's time to learn our final CVS skill -- removing files from the +repository. Removing a file is a two-stage process. First, delete the file +from your local copy of the sources, and then execute the appropriate <c>cvs remove</c> command: </p> @@ -840,9 +840,9 @@ </p> <p> -<c>cvs remove</c> is recursive, which means that you can delete a bunch of -files, and then run the <c>cvs remove</c> command with no other arguments from -a parent directory. Doing this will cause all of the deleted files to be tagged +<c>cvs remove</c> is recursive, which means that you can delete a bunch of +files, and then run the <c>cvs remove</c> command with no other arguments from +a parent directory. Doing this will cause all of the deleted files to be tagged for removal at the next commit. </p> @@ -887,7 +887,7 @@ </pre> <p> -Notice that removing the directory didn't require another commit -- directories +Notice that removing the directory didn't require another commit -- directories are added to and removed from the repository in real-time. </p> @@ -898,26 +898,26 @@ <body> <p> -Your introduction to CVS is complete -- I hope that this tutorial has been -helpful. There's much more to CVS than I've been able to cover in this -introductory tutorial, but thankfully there are a bunch of great CVS resources -you can use to further expand your CVS knowledge: +Your introduction to CVS is complete -- I hope that this tutorial has been +helpful. There's much more to CVS than I've been able to cover in this +introductory tutorial, but thankfully there are a bunch of great CVS resources +you can use to further expand your CVS knowledge: </p> <ul> <li> <uri>http://www.cvshome.org</uri> is the home of CVS development, - and offers a bunch of documentation on CVS, including the <uri - link="http://www.cvshome.org/docs/manual";>official CVS + and offers a bunch of documentation on CVS, including the <uri + link="http://www.cvshome.org/docs/manual";>official CVS documentation online</uri> </li> <li> - The <uri link="http://www.durak.org/cvswebsites/";>CVS Version Control for + The <uri link="http://www.durak.org/cvswebsites/";>CVS Version Control for Web Site Projects site</uri> has good info on how to use CVS for developing web sites </li> <li> - Karl Fogel has written a book called <uri + Karl Fogel has written a book called <uri link="http://cvsbook.red-bean.com/";>Open Source Development with CVS</uri>. A number of chapters are available for free from the website. </li> @@ -927,7 +927,7 @@ repository; excellent for browsing. </li> <li> - The <uri link="http://www.loria.fr/~molli/cvs-index.html";>CVS Bubbles</uri> + The <uri link="http://www.loria.fr/~molli/cvs-index.html";>CVS Bubbles</uri> site has a bunch of good resources including a CVS FAQ-o-matic. </li> </ul> -- [email protected] mailing list
