home *** CD-ROM | disk | FTP | other *** search
/ Club Amiga de Montreal - CAM / CAM_CD_1.iso / files / 317a.lha / RCS / doc / rcsfile.5l.doc < prev    next >
Text File  |  1989-12-05  |  6KB  |  199 lines
  1.  
  2.  
  3.  
  4. RCSFILE(5L)       UNKNOWN SECTION OF THE MANUAL       RCSFILE(5L)
  5.  
  6.  
  7.  
  8. NAME
  9.      rcsfile - format of RCS file
  10.  
  11. DESCRIPTION
  12.      An RCS file is an ASCII file. Its contents are described  by
  13.      the  grammar  below.  The text is free format, i.e., spaces,
  14.      tabs and new lines have no significance except  in  strings.
  15.      Strings are enclosed by `@'.  If a string contains a `@', it
  16.      must be doubled.
  17.  
  18.      The meta syntax uses the following  conventions:  `|'  (bar)
  19.      separates   alternatives;   `{'  and  `}'  enclose  optional
  20.      phrases; `{' and `}*' enclose phrases that may  be  repeated
  21.      zero  or  more times; `{' and '}+' enclose phrases that must
  22.      appear at least once  and  may  be  repeated;  `<'  and  `>'
  23.      enclose nonterminals.
  24.  
  25.  
  26.      <rcstext>      ::=  <admin> {<delta>}* <desc> {<deltatext>}*
  27.  
  28.      <admin>        ::=  head      {<num>};
  29.                          branch    {<num>};
  30.                          access    {<id>}*;
  31.                          symbols   {<id> : <num>}*;
  32.                          locks     {<id> : <num>}*;
  33.                          comment   {<string>};
  34.  
  35.      <delta>        ::=  <num>
  36.                          date      <num>;
  37.                          author    <id>;
  38.                          state     {<id>};
  39.                          branches  {<num>}*;
  40.                          next      {<num>};
  41.  
  42.      <desc>         ::=  desc      <string>
  43.  
  44.      <deltatext>    ::=  <num>
  45.                          log       <string>
  46.                          text      <string>
  47.  
  48.  
  49.      <num>          ::=  {<digit>{.}}+
  50.  
  51.      <digit>        ::=  0 | 1 | ... | 9
  52.  
  53.      <id>           ::=  <letter>{<idchar>}*
  54.  
  55.      <letter>       ::=  A | B | ... | Z | a | b | ... | z
  56.  
  57.      <idchar>       ::=  Any printing ASCII character except space,
  58.                          tab, carriage return, new line, and <special>.
  59.  
  60.  
  61.  
  62.  
  63. Purdue University         Last change:                          1
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70. RCSFILE(5L)       UNKNOWN SECTION OF THE MANUAL       RCSFILE(5L)
  71.  
  72.  
  73.  
  74.      <special>      ::=  ; | : | , | @
  75.  
  76.      <string>       ::=  @{any ASCII character, with `@' doubled}*@
  77.  
  78.  
  79.      Identifiers are case sensitive. Keywords are in  lower  case
  80.      only.  The sets of keywords and identifiers may overlap.
  81.  
  82.      The <delta> nodes form a tree. All nodes whose numbers  con-
  83.      sist of a single pair (e.g., 2.3, 2.1, 1.3, etc.) are on the
  84.      "trunk", and are linked through the next field in  order  of
  85.      decreasing  numbers.  The  head  field  in  the <admin> node
  86.      points to the head of  that  sequence  (i.e.,  contains  the
  87.      highest  pair).  The branch node in the admin node indicates
  88.      the default branch (or revision) for most RCS operations. If
  89.      empty,  the  default  branch  is  the  highest branch on the
  90.      trunk.
  91.  
  92.      All <delta> nodes whose numbers consist of 2n  fields  (n>_2)
  93.      (e.g.,  3.1.1.1,  2.1.2.2,  etc.) are linked as follows. All
  94.      nodes whose first (2n)-1 number  fields  are  identical  are
  95.      linked  through  the  next  field  in  order  of  increasing
  96.      numbers.  For each such sequence,  the  <delta>  node  whose
  97.      number is identical to the first 2(n-1) number fields of the
  98.      deltas on that sequence  is  called  the  branchpoint.   The
  99.      branches  field  of a node contains a list of the numbers of
  100.      the first nodes of all sequences for which  it  is  a  bran-
  101.      chpoint.  This list is ordered in increasing numbers.
  102.  
  103.  
  104.  
  105.  
  106.  
  107.  
  108.  
  109.  
  110.  
  111.  
  112.  
  113.  
  114.  
  115.  
  116.  
  117.  
  118.  
  119.  
  120.  
  121.  
  122.  
  123.  
  124.  
  125.  
  126.  
  127.  
  128.  
  129. Purdue University         Last change:                          2
  130.  
  131.  
  132.  
  133.  
  134.  
  135.  
  136. RCSFILE(5L)       UNKNOWN SECTION OF THE MANUAL       RCSFILE(5L)
  137.  
  138.  
  139.  
  140.      Example:
  141.                                 Head
  142.                                   |
  143.                                   |
  144.                                   v
  145.                               ---------
  146.         / \          / \      |       |      / \           / \
  147.        /   \        /   \     |  2.1  |     /   \         /   \
  148.       /     \      /     \    |       |    /     \      /       \
  149.      /1.2.1.3\    /1.3.1.1\   |       |   /1.2.2.2\   /1.2.2.1.1.1\
  150.      ---------    ---------   ---------   ---------   -------------
  151.          ^            ^           |           ^             ^
  152.          |            |           |           |             |
  153.          |            |           v           |             |
  154.         / \           |       ---------      / \            |
  155.        /   \          |       \  1.3  /     /   \           |
  156.       /     \         ---------\     /     /     \-----------
  157.      /1.2.1.1\                  \   /     /1.2.2.1\
  158.      ---------                   \ /      ---------
  159.          ^                        |           ^
  160.          |                        |           |
  161.          |                        v           |
  162.          |                    ---------       |
  163.          |                    \  1.2  /       |
  164.          ----------------------\     /---------
  165.                                 \   /
  166.                                  \ /
  167.                                   |
  168.                                   |
  169.                                   v
  170.                               ---------
  171.                               \  1.1  /
  172.                                \     /
  173.                                 \   /
  174.                                  \ /
  175.  
  176.  
  177.                        Fig. 1: A revision tree
  178.  
  179. IDENTIFICATION
  180.      Author: Walter F. Tichy, Purdue University, West  Lafayette,
  181.      IN, 47907.
  182.      Revision Number: 1.2 ; Release Date: 89/05/02 .
  183.      Copyright c 1982, 1988, 1989 by Walter F. Tichy.
  184.  
  185. SEE ALSO
  186.      ci(1L),    co(1L),    ident(1L),    rcs(1L),    rcsdiff(1L),
  187.      rcsmerge(1L), rlog(1L),
  188.      Walter F. Tichy, "Design, Implementation, and Evaluation  of
  189.      a Revision Control System," in _P_r_o_c_e_e_d_i_n_g_s _o_f _t_h_e _6_t_h _I_n_t_e_r_-
  190.      _n_a_t_i_o_n_a_l _C_o_n_f_e_r_e_n_c_e _o_n _S_o_f_t_w_a_r_e  _E_n_g_i_n_e_e_r_i_n_g,  IEEE,  Tokyo,
  191.      Sept. 1982.
  192.  
  193.  
  194.  
  195. Purdue University         Last change:                          3
  196.  
  197.  
  198.  
  199.