home *** CD-ROM | disk | FTP | other *** search
/ Peanuts NeXT Software Archives / Peanuts-2.iso / Unix / developer / NeXT-rcs.README < prev    next >
Encoding:
Text File  |  1991-01-04  |  11.4 KB  |  278 lines
  1. /* Copyright (C) 1982, 1988, 1989 Walter Tichy
  2.    Copyright 1990 by Paul Eggert
  3.    Distributed under license by the Free Software Foundation, Inc.
  4.  
  5. This file is part of RCS.
  6.  
  7. RCS is free software; you can redistribute it and/or modify
  8. it under the terms of the GNU General Public License as published by
  9. the Free Software Foundation; either version 1, or (at your option)
  10. any later version.
  11.  
  12. RCS is distributed in the hope that it will be useful,
  13. but WITHOUT ANY WARRANTY; without even the implied warranty of
  14. MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15. GNU General Public License for more details.
  16.  
  17. You should have received a copy of the GNU General Public License
  18. along with RCS; see the file COPYING.  If not, write to
  19. the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.
  20.  
  21. Report problems and direct all questions to:
  22.  
  23.     rcs-bugs@cs.purdue.edu
  24.  
  25. */
  26.  
  27. $Id: README,v 5.6 1990/12/13 06:54:04 eggert Exp $
  28.  
  29. This directory contains complete sources for RCS version 5.5.
  30.  
  31.  
  32. Installation notes:
  33.  
  34.   RCS requires a diff that supports the -n option.
  35.   Get GNU diff (version 1.15 or later) if your diff lacks -n.
  36.  
  37.   RCS works best with a diff that supports -a, -L, and (diff3 only) -m.
  38.   GNU diff supports these options.
  39.  
  40.   Sources for RCS are in the src directory.
  41.   Read the directions in src/Makefile to set up the options
  42.   for building RCS on your system.
  43.   If `make' fails to build src/conf.h, look in src/conf.error
  44.   to see what went wrong in the src/conf.sh shell file.
  45.   If all else fails, create src/conf.h manually by editing a
  46.   copy of src/conf.heg.
  47.  
  48.   Manual entries reside in man.
  49.  
  50.   To test your installation of RCS, run the shell file src/rcstest.
  51.  
  52.   Troff source for the paper `RCS--A System for Version Control', which
  53.   appeared in _Software--Practice & Experience_, is in rcs.ms.
  54.  
  55.  
  56. RCS compatibility notes:
  57.  
  58.   RCS version 5 reads RCS files written by any RCS version released since 1982.
  59.   It also writes RCS files that these older versions of RCS can read,
  60.   unless you use one of the following new features:
  61.  
  62.     checkin times after 1999/12/31 23:59:59 GMT
  63.     checking in non-text files
  64.     non-Ascii symbolic names
  65.     rcs -bX, where X is nonempty
  66.     rcs -kX, where X is not `kv'
  67.     RCS files that exceed hardcoded limits in older RCS versions
  68.  
  69.  
  70. Features new to RCS version 5 include:
  71.  
  72.   RCS can check in arbitrary files, not just text files, if diff -a works.
  73.   RCS can merge lines containing just a single `.' if diff3 -m works.
  74.   GNU diff supports the -a and -m options.
  75.  
  76.   RCS can now be installed as a setgid or setuid program
  77.   if the setegid() and seteuid() system calls work.
  78.   Setid privileges yield extra security if RCS files are protected so that
  79.   only the effective group or user can write RCS directories.
  80.   RCS uses the real group and user for all accesses other than to RCS files.
  81.   On older hosts lacking setegid() and seteuid(), RCS uses the effective group
  82.   and user for all accesses; formerly it was inconsistent.
  83.  
  84.   New options to co, rcsdiff, and rcsmerge give more flexibility to keyword
  85.   substitution.
  86.  
  87.     -kkv substitutes the default `$Keyword: value $' for keyword strings.
  88.     However, a locker's name is inserted only as a file is being locked,
  89.     i.e. by `ci -l' and `co -l'.  This is normally the default.
  90.  
  91.     -kkvl acts like -kkv, except that a locker's name is always inserted
  92.     if the given revision is currently locked.  This was the default in
  93.     version 4.  It is now the default only with when using rcsdiff to
  94.     compare a revision to a working file whose mode is that of a file
  95.     checked out for changes.
  96.  
  97.     -kk substitutes just `$Keyword$', which helps to ignore keyword values
  98.     when comparing revisions.
  99.  
  100.     -ko retrieves the old revision's keyword string, thus bypassing keyword
  101.     substitution.
  102.  
  103.     -kv retrieves just `value'.  This can ease the use of keyword values, but
  104.     it is dangerous because it causes RCS to lose track of where the keywords
  105.     are, so for safety the owner write permission of the working file is
  106.     turned off when -kv is used; to edit the file later, check it out again
  107.     without -kv.
  108.  
  109.   rcs -ko sets the default keyword substitution to be in the style of co -ko,
  110.   and similarly for the other -k options.  This can be useful with binary file
  111.   formats that cannot tolerate changing the lengths of keyword strings.
  112.   However it also renders a RCS file readable only by RCS version 5 or later.
  113.   Use rcs -kkv to restore the usual default substitution.
  114.  
  115.   RCS can now be used by development groups that span timezone boundaries.
  116.   All times are now displayed in GMT, and GMT is the default timezone.
  117.   To use local time with co -d, append ` LT' to the time.
  118.   When interchanging RCS files with sites running older versions of RCS,
  119.   users may encounter discrepancies of up to 13 hours in old time stamps.
  120.   The list of timezone names has been modernized.
  121.  
  122.   Dates are now displayed using four-digit years, not two-digit years.
  123.   Years given in -d options must now have four digits.
  124.   This change is required for RCS to continue to work after 1999/12/31.
  125.   The form of dates in version 5 RCS files will not change until 2000/01/01,
  126.   so in the meantime RCS files can still be interchanged with sites
  127.   running older versions of RCS.  To make room for the longer dates,
  128.   rlog now outputs `lines: +A -D' instead of `lines added/del: A/D'.
  129.  
  130.   To help prevent diff programs that are broken or have run out of memory
  131.   from trashing an RCS file, ci now checks diff output more carefully.
  132.  
  133.   ci -k now handles the Log keyword, so that checking in a file
  134.   with -k does not normally alter the file's contents.
  135.  
  136.   RCS no longer outputs white space at the ends of lines
  137.   unless the original working file had it.
  138.   For consistency with other keywords,
  139.   a space, not a tab, is now output after `$Log:'.
  140.   Rlog now puts lockers and symbolic names on separate lines in the output
  141.   to avoid generating lines that are too long.
  142.   A similar fix has been made to lists in the RCS files themselves.
  143.  
  144.   RCS no longer outputs the string `Locker: ' when expanding Header or Id
  145.   keywords.  This saves space and reverts back to version 3 behavior.
  146.  
  147.   The default branch is not put into the RCS file unless it is nonempty.
  148.   Therefore, files generated by RCS version 5 can be read by RCS version 3
  149.   unless they use the default branch feature introduced in version 4.
  150.   This fixes a compatibility problem introduced by version 4.
  151.  
  152.   RCS can now emulate older versions of RCS; see `co -V'.
  153.   This may be useful to overcome compatibility problems
  154.   due to the above changes.
  155.  
  156.   Programs like Emacs can now interact with RCS commands via a pipe:
  157.   the new -I option causes ci, co, and rcs to run interactively,
  158.   even if standard input is not a terminal.
  159.   These commands now accept multiple inputs from stdin separated by `.' lines.
  160.  
  161.   ci now silently ignores the -t option if the RCS file already exists.
  162.   This simplifies some shell scripts and improves security in setuid sites.
  163.  
  164.   Descriptive text may be given directly in an argument of the form -t-string.
  165.  
  166.   The character set for symbolic names has been upgraded
  167.   from Ascii to ISO 8859.
  168.  
  169.   rcsdiff now passes through all options used by GNU diff;
  170.   this is a longer list than 4.3BSD diff.
  171.  
  172.   merge's new -L option gives tags for merge's overlap report lines.
  173.   This ability used to be present in a different, undocumented form;
  174.   the new form is chosen for compatibility with GNU diff3's -L option.
  175.  
  176.   rcsmerge and merge now have a -q option, just like their siblings do.
  177.  
  178.   RCS now attempts to ignore parts of an RCS file that look like they come
  179.   from a future version of RCS.
  180.  
  181.   When properly configured, RCS now strictly conforms with Posix 1003.1-1988.
  182.   Normally, RCS file names contain `,', which is outside the Posix portable
  183.   filename character set; but in impoverished Posix environments, you can
  184.   compile RCS so that the RCS file for Foo is named just RCS/Foo.
  185.   RCS can still be compiled in non-Posix traditional Unix environments,
  186.   and can use common BSD and USG extensions to Posix.
  187.   RCS is a conforming ANSI C program, and also compiles under traditional C.
  188.  
  189.   Arbitrary limits on internal table sizes have been removed.
  190.   The only limit now is the amount of memory available via malloc().
  191.  
  192.   File temporaries, lock files, signals, and system call return codes
  193.   are now handled more cleanly, portably, and quickly.
  194.   Some race conditions have been removed.
  195.  
  196.   A new compile-time option RCSPREFIX lets administrators avoid absolute path
  197.   names for subsidiary programs, trading speed for flexibility.
  198.  
  199.   The configuration procedure is now more automatic.
  200.  
  201.   Snooping has been removed; it did not work in version 4.
  202.  
  203.  
  204. Version 4 was the first version distributed by FSF.
  205. Beside bug fixes, features new to RCS version 4 include:
  206.  
  207.   The notion of default branch has been added; see rcs -b.
  208.  
  209.  
  210. Version 3 was included in the 4.3BSD distribution.
  211.  
  212.  
  213. Further projects:
  214.  
  215.   Improve performance when checking out branch revisions;
  216.   see the `piece table' comments in rcs.ms.
  217.   Joe Berkovitz of Stratus has written some fast revision extraction code;
  218.   unfortunately there wasn't enough time to integrate it into RCS version 5.
  219.   It's probably best to use mmap() here if available.
  220.  
  221.   Let the user mark an RCS revision as deleted; checking out such a revision
  222.   would result in no working file.  Similarly, using `co -d' with a date either
  223.   before the initial revision or after the file was marked deleted should
  224.   remove the working file.  For extra credit, extend the notion of `deleted' to
  225.   include `renamed', i.e. when an RCS file gets renamed.
  226.  
  227.   Use a better scheme for locking revisions; the current scheme requires
  228.   changing the RCS file just to lock or unlock a revision.
  229.   The new scheme should coexist as well as possible with older versions of RCS.
  230.  
  231.   Permit multiple option-filename pairs, e.g. co -r1.4 a -r1.5 b.
  232.  
  233.   Add rcs options for changing keyword names, e.g. XConsortium instead of Id.
  234.  
  235.   If there are multiple locks by a user, ci should fall back on ci -k's
  236.   method to figure out which version it is.
  237.  
  238.   Add frozen branches a la SCCS.  In general, be able to emulate all of
  239.   SCCS, so that an SCCS-to-RCS program can be practical.
  240.  
  241.   Improve RCS's method for storing binary files.
  242.   Although it is more efficient than SCCS's,
  243.   the diff algorithm is still line oriented,
  244.   and often generates long output for minor changes to an executable file.
  245.  
  246.   Port binary file handling to non-Unix hosts where fopen(F,"r") and
  247.   fopen(F,"rb") are quite different beasts.
  248.  
  249.   Extend the grammar of RCS files so that keywords need not be in a fixed order.
  250.  
  251.   Clean up the source code with a consistent indenting style.
  252.  
  253.   Update the date parser to use the more modern getdate.y by Bellovin, Salz,
  254.   and Berets.
  255.  
  256.   Internationalize messages; unfortunately, there's no common standard yet.
  257.  
  258.   Prune the unnecessary keyword substitution baggage from the rcs command.
  259.  
  260.   Break up the code into a library so that it's easier to write new programs
  261.   that manipulate RCS files.
  262.  
  263.  
  264. Credits:
  265.  
  266.   RCS was designed and built by Walter F. Tichy of Purdue University.
  267.   RCS version 3 was released in 1983.
  268.  
  269.   Thomas Narten, Dan Trinkle, and others of Purdue supported RCS through
  270.   version 4.2, released in 1989.  Guy Harris of Sun contributed many porting
  271.   fixes.  Paul Eggert of System Development Corporation contributed bug fixes
  272.   and tuneups.  Jay Lepreau contributed 4.3BSD support.
  273.  
  274.   Paul Eggert of Twin Sun wrote the changes for RCS version 5, released in
  275.   1990.  Ideas for setgid support were contributed by Bill Hahn of Stratus.
  276.   Test case ideas were contributed by Matt Cross of Stratus.
  277.   Adam Hammer of Purdue QAed.
  278.