The LDP is in the process of providing CVS access to authors. There are a few good reasons for this:
CVS will keep an off-site backup of your documents. In the event that you hand over a document to another author, they can just retrieve the document from CVS and continue on. In the event you need to go back to a previous version of a document, you can retrieve it as well.
It's great if you have many people working on the same document. You can have CVS tell you what changes were made while you were editing your copy by another author, and integrate those changes in.
Keeps a log of what changes were made. These logs (and a date stamp) can be placed automatically inside the document when you use some special tags that get processed before the SGML processor.
Can provide for a way for a program to automatically update the LDP web site with new documentation as it's written and submitted. This is not in place yet, but is a potential goal. Currently, CVS updates signal the HOWTO coordinator to update the LDP web page, meaning that if you use CVS, you're not required to e-mail your SGML code.
If you're completely new to CVS, there are a few web pages you may want to look at which can help you out:
First you'll need to get an account at the LDP's CVS Repository. This is pretty much the root directory that is used by CVS, with various projects (HOWTOs, mini HOWTOs, etc.) created as subdirectories of that.
You will need to create a hashed password and userid for your account. The hashed password allows you to send an encrypted password to the CVS group without them needing to know your password. You can do this with the following command, from bash (or sh):
bash$ echo your_password | perl -e "print crypt(<>,\
join '',('.', '/', 0..9, 'A'..'Z', 'a'..'z')[rand 64, rand 64]),\"\n\"" |
Take the output of this command, and send it with your proposed userid to <cvsadmin@cvslist.linuxdoc.org>. Your unique CVSROOT directory will be created and you'll get an e-mail with a response. When you get your response, log into your CVSROOT and make sure everything is set up properly:
bash$ export CVSROOT=:pserver:your_userid@cvs.linuxdoc.org:/cvsroot bash$ cvs -d $CVSROOT login |
(Replace the your_userid with what you were sent in the response e-mail).
You will be asked for your password, and then given access to the CVS Repository in read-write mode. Once you've used cvs login once and have been given access to the system, your password is stored in .cvsroot and you will not have to use cvs login again. Just set the CVSROOT and continue on. You can get the entire linuxdoc repository with this command:
bash$ cvs get LDP |
Or you can get the SGML source for your own document with these commands:
bash$ cvs get howto/YOUR-HOWTO.sgml bash$ cvs get minihowto/YOURDOC.sgml |
Anonymous CVS access is available for those who do not require an account (such as those wishing to publish LDP documents). This repository is read-only:
bash$ cvs -d :pserver:cvs@anoncvs.linuxdoc.org:/cvsroot login |
As a password, use cvs. You can then get linuxdoc modules as above. Note that changes to the anoncvs site may be a half an hour behind the main site.
You can access the CVS repository via the web at http://cvsweb.linuxdoc.org/index.cgi/linuxdoc.
There are graphical interfaces to CVS, and you can get a list of them at http://freshmeat.net/appindex. Search for CVS.
CVS has a special tag, $Id, that you can use to automatically insert the date and version directly into the document. After committing, CVS will turn this tag into $Id: HOWTO-HOWTO.sgml,v 1.4 2000/06/12 20:49:54 markk Exp $. By including this tag in your document, you can have that automatically change each time you change the file, allowing the revision mark to increment each time.
When you're ready to upload changes to the CVS server, use the command cvs ci -m "comment" YOUR-HOWTO.sgml. The -m "comment" isn't necessary, but if you don't include it, you'll be brought into the editor (usually vi, or whatever your EDITOR environment variable is) and be given the chance to add a comment about the changes.
You can follow more of the CVS discussion on the ldp-discuss list. For the time being, LDP submissions should still be sent to <ldp-submit@lists.linuxdoc.org>.