Annotation for CVS examples
| Project: | Documentation |
| Component: | Developer Guide |
| Category: | feature request |
| Priority: | normal |
| Assigned: | Unassigned |
| Status: | active |
The "CVS quick-start guide for module and theme maintainers" and other pages that explain CVS have a number of useful examples of sample CVS commands:
http://drupal.org/handbook/cvs/quickstart
This would be more useful still if it could be annotated with an explanation of what the code is doing. For example, here's an example CVS command that I found on the quick-start guide:
cvs update -dP -r DRUPAL-6--2
As someone who doesn't use CVS regularly (I only use it when I have to commit a change to my project in the Drupal repository), I have a hard time understanding what a command like this actually DOES, so I find myself following the examples blindly. In the line above, I didn't know what the -dP and -r options meant, and fact I didn't know what "update" meant either. (The first several times I used it, I thought the command listed above meant "update the repository to DRUPAL 6.2," which I now realize is actually done by the "cvs tag" command.)
It would be nice if CVS examples could be annotated. I'm envisioning some kind of javascript popup so readers could click on a link that says, "Explain this code" and see a detailed explication.
