diff options
Diffstat (limited to 'gnu/usr.bin/cvs/doc')
| -rw-r--r-- | gnu/usr.bin/cvs/doc/ChangeLog | 93 | ||||
| -rw-r--r-- | gnu/usr.bin/cvs/doc/RCSFILES | 65 | ||||
| -rw-r--r-- | gnu/usr.bin/cvs/doc/cvsclient.texi | 27 |
3 files changed, 171 insertions, 14 deletions
diff --git a/gnu/usr.bin/cvs/doc/ChangeLog b/gnu/usr.bin/cvs/doc/ChangeLog index 9a01d1b6a79..a779ff62877 100644 --- a/gnu/usr.bin/cvs/doc/ChangeLog +++ b/gnu/usr.bin/cvs/doc/ChangeLog @@ -1,3 +1,80 @@ +1998-05-12 Jim Meyering <meyering@ascend.com> + + * cvs.texinfo: Add an info dir entry. + Remove trailing white space. + +1998-05-05 Jim Kingdon <kingdon@harvey.cyclic.com> + + * cvs.texinfo (Wrappers): Be more explicit that -m 'COPY' has no + effect on binary files. + +1998-05-02 Jim Kingdon <kingdon@harvey.cyclic.com> + + * RCSFILES: Add more discussion of the order of the revisions. + +1998-04-27 Jim Kingdon <kingdon@harvey.cyclic.com> + + * cvs.texinfo (loginfo example): Also give example of sending + mail. Use internal variable $USER rather than expecting CVS to + set the environment variable $USER. Change unnecessary 'sed' + invocation to 'cat' (it suffered from the same problem in terms of + internal variables versus environment variables). + + * cvs.texinfo (Error messages): Add "conflict: removed FILE was + modified by second party". + +1998-04-20 Jim Kingdon <kingdon@harvey.cyclic.com> + + * cvs.texinfo (Common options): Update comment about meaning of + HEAD in cvs diff. + +1998-04-12 Jim Kingdon <kingdon@harvey.cyclic.com> + + * cvsclient.texi (Dates): Also mention log -d. + + * cvs.texinfo (Invoking CVS): No space is allowed between -r or -w + and its argument, for the log command. + +1998-04-11 Jim Kingdon <kingdon@harvey.cyclic.com> + + * cvsclient.texi (Dates): New section, explaining the deal with + date formats. + +1998-04-09 Jim Kingdon <kingdon@harvey.cyclic.com> + + * cvs.texinfo (Global options, Invoking CVS): Fix typo + ("files files" -> "files"). + (Invoking CVS): Make -q and -Q more concise. + (Invoking CVS): Use @var for metavariables in "diff -r". + +1998-03-17 Jim Kingdon <kingdon@harvey.cyclic.com> + + * cvs.texinfo (~/.cvsrc): In example, put "checkout" rather than + "co" into .cvsrc; we just finished explaining that only the former + works! Thanks to Lenny Foner for reporting this. + + * cvs.texinfo (Copying): Remove this node. This basically + restores the status quo prior to 18 Oct 1996 (before then the node + existed but was empty). + (before Top): Adjust copyright notice accordingly. + +1998-03-12 Tim Pierce <twp@skepsis.com> + + * RCSFILES: Updated description of `hardlinks' newphrases. + +1998-03-07 Jim Kingdon <kingdon@harvey.cyclic.com> + + * cvs.texinfo (Tags, Sticky tags, Creating a branch, Accessing + branches): Rename release-0-1 tag to rel-0-1 and likewise for + release-0-1-patches and release-0-4. This fixes an overfull hbox. + (diff options): Reformat table to fix underfull hboxes and such. + +1998-03-07 Tim Pierce <twp@skepsis.com> + + * cvs.texinfo (Editing files, Special Files): Document hardlinks. + Various cleanups to PreservePermissions text. + * RCSFILES: Document PreservePermissions newphrases. + 1998-03-04 Jim Kingdon <kingdon@harvey.cyclic.com> * cvs.texinfo (Special Files): Add notes about client/server CVS @@ -213,13 +290,13 @@ Sun Nov 30 20:38:17 1997 Jim Kingdon <kingdon@harvey.cyclic.com> * cvs.texinfo (Wrappers): Add comment: we don't document %s. -Mon Nov 24 23:00:09 1997 Karl Fogel <kfogel@floss.red-bean.com> +Mon Nov 24 23:00:09 1997 Karl Fogel <kfogel@floss.red-bean.com> and Jim Kingdon <kingdon@harvey.cyclic.com> * cvsclient.texi: Move Protocol Notes node to the end. * cvsclient.texi (Request intro): new node/section. - (Protocol): added some introductory material. + (Protocol): added some introductory material. Rearranged menu into General Conventions, Protocol specification, and Example etc sections. (File Modes): replaces Modes, for consistency. @@ -418,7 +495,7 @@ Sat Sep 6 11:29:15 1997 Jim Kingdon <kingdon@harvey.cyclic.com> Fri Sep 5 14:42:39 1997 Jim Kingdon <kingdon@harvey.cyclic.com> * cvs.texinfo (BUGS): Remove mention of unsupported resources page - on http://www.cyclic.com, as it might go away in a future + on http://www.cyclic.com, as it might go away in a future reorganization. * DIFFUTILS-2.7-BUG: Further info from Eggert. @@ -1229,7 +1306,7 @@ Tue Mar 18 15:50:47 1997 Jim Kingdon <kingdon@harvey.cyclic.com> (A sample session): Add comment about how we need an introduction and what might go into one. Also bring in the paragraph from Basic concepts introducing modules, but comment it out. - (Viewing differences): Add comment about + (Viewing differences): Add comment about (Basic concepts): Removed; its content has been farmed out as described above, and as the comment said, it was fundamentally flawed. @@ -1544,7 +1621,7 @@ Thu Nov 14 10:22:58 1996 Jim Kingdon <kingdon@harvey.cyclic.com> chunks, and about atomicity to be focused more on the protocol than the current implementation. (Notes): Remove this node. The attempt to describe the basic - model has pretty much been replaced by the Introduction. + model has pretty much been replaced by the Introduction. The material about how to start the client is incomplete and better left to cvs.texinfo. And the item about the lack of SERVER_FLOWCONTROL is obsolete now that SERVER_FLOWCONTROL is the @@ -1700,7 +1777,7 @@ Mon Sep 30 18:17:34 1996 Greg A. Woods <woods@most.weird.com> GREPBIN. (export examples): add one. (import options): describe the effect of '-b 1'. - + Mon Sep 30 08:09:53 1996 Jim Kingdon <kingdon@harvey.cyclic.com> * cvs.texinfo: Adjust comments concerning A4 vs. US letter, @@ -2404,14 +2481,14 @@ Sun Dec 31 10:53:47 1995 Jim Kingdon <kingdon@harvey.cyclic.com> Sun Dec 24 02:37:51 1995 Karl Fogel <kfogel@floss.cyclic.com> - * cvs.texinfo (Using the client with password authentication): + * cvs.texinfo (Using the client with password authentication): tixed fypos. Sun Dec 24 00:00:16 1995 Karl Fogel <kfogel@floss.cyclic.com> * cvs.texinfo (Remote repositories): use @code{rsh} most places, because it is the name of a program, and because I am a pedant. - Refer to new node "Password authenticated". + Refer to new node "Password authenticated". (Password authenticated): new node. (Setting up the server for password authentication): new node. (Using the client with password authentication): new node. diff --git a/gnu/usr.bin/cvs/doc/RCSFILES b/gnu/usr.bin/cvs/doc/RCSFILES index 6d600b8028b..13c4f93c796 100644 --- a/gnu/usr.bin/cvs/doc/RCSFILES +++ b/gnu/usr.bin/cvs/doc/RCSFILES @@ -24,12 +24,33 @@ several other output formats. If you just want some source code to look at, the part of CVS which applies these is RCS_deltas in src/rcs.c. -The first time I read rcsfile.5 I didn't really notice the part about -the order of the revisions. This order _is_ important and CVS relies -on it. It is documented but it would be clearer if the example in -rcsfile.5 also showed the order of the revisions (and the "next" and -"branch" fields and anything else where it would be useful to have an -example of how a revision tree is represented in an RCS file). +The rcsfile.5 documentation only _very_ briefly touches on the order +of the revisions. The order _is_ important and CVS relies on it. +Here is an example of what I was able to find, based on the join3 +sanity.sh testcase (and the behavior I am documenting here seems to be +the same for RCS 5.7 and CVS 1.9.27): + + 1.1 -----------------> 1.2 + \---> 1.1.2.1 \---> 1.2.2.1 + +Here is how this shows up in the RCS file (omitting irrelevant parts): + + admin: head 1.2; + deltas: + 1.2 branches 1.2.2.1; next 1.1; + 1.1 branches 1.1.2.1; next; + 1.1.2.1 branches; next; + 1.2.2.1 branches; next; + deltatexts: + 1.2 + 1.2.2.1 + 1.1 + 1.1.2.1 + +Yes, the order seems to differ between the deltas and the deltatexts. +I have no idea how much of this should actually be considered part of +the RCS file format, and how much programs reading it should expect to +encounter any order. The rcsfile.5 grammar shows the {num} after "next" as optional; if it is omitted then there is no next delta node (for example 1.1 or the @@ -62,6 +83,38 @@ rules. the current CVS death support, which uses a state "dead" rather than a "dead" newphrase. +CVS does use newphrases to implement the `PreservePermissions' +extension introduced in CVS 1.9.26. The following new keywords are +defined when PreservePermissions=yes: + + owner + group + permissions + special + symlink + hardlinks + +The contents of the `owner' and `group' field should be a numeric uid +and a numeric gid, respectively, representing the user and group who +own the file. The `permissions' field contains an octal integer, +representing the permissions that should be applied to the file. The +`special' field contains two words; the first must be either `block' +or `character', and the second is the file's device number. The +`symlink' field should be present only in files which are symbolic +links to other files, and absent on all regular files. The +`hardlinks' field contains a list of filenames to which the current +file is linked, in alphabetical order. Because files often contain +characters special to RCS, like `.' and sometimes even contain spaces +or eight-bit characters, the filenames in the hardlinks field will +usually be enclosed in RCS strings. For example: + + hardlinks README @install.txt@ @Installation Notes@; + +The hardlinks field should always include the name of the current +file. That is, in the repository file README,v, any hardlinks fields +in the delta nodes should include `README'; CVS will not operate +properly if this is not done. + The rules regarding keyword expansion are not documented along with the rest of the RCS file format; they are documented in the co(1) manpage in the RCS 5.7 distribution. See also the "Keyword diff --git a/gnu/usr.bin/cvs/doc/cvsclient.texi b/gnu/usr.bin/cvs/doc/cvsclient.texi index 56577c29e2b..3b4ab41142f 100644 --- a/gnu/usr.bin/cvs/doc/cvsclient.texi +++ b/gnu/usr.bin/cvs/doc/cvsclient.texi @@ -320,6 +320,7 @@ General protocol conventions: * Filenames:: Conventions regarding filenames * File transmissions:: How file contents are transmitted * Strings:: Strings in various requests and responses +* Dates:: Times and dates The protocol itself: @@ -468,6 +469,32 @@ existing practice is probably to just transmit whatever the user specifies, and hope that everyone involved agrees which character set is in use, or sticks to a common subset. +@node Dates +@section Dates + +The protocol contains times and dates in various places. + +For the @samp{-D} option to the @code{annotate}, @code{co}, @code{diff}, +@code{export}, @code{history}, @code{rdiff}, @code{rtag}, @code{tag}, +and @code{update} requests, the server should support two formats: + +@example +26 May 1997 13:01:40 GMT ; @r{RFC 822 as modified by RFC 1123} +5/26/1997 13:01:40 GMT ; @r{traditional} +@end example + +The former format is preferred; the latter however is sent by the CVS +command line client (versions 1.5 through at least 1.9). + +For the @samp{-d} option to the @code{log} request, servers should at +least support RFC 822/1123 format. Clients are encouraged to use this +format too (traditionally the command line CVS client has just passed +along the date format specified by the user, however). + +For @code{Mod-time}, see the description of that response. + +For @code{Notify}, see the description of that request. + @node Request intro @section Request intro |