RCS Keywords - Why not "Description" ?

Eric Marceau <[email protected]> Tue, 29 Sep 2020 16:45:12 -0400
Newsgroups gmane.comp.gnu.rcs
Message-ID <[email protected]>
This is a multi-part message in MIME format.
--------------9297084D6B246F8F613D2DD2
Content-Type: text/plain; charset=utf-8; format=flowed
Content-Transfer-Encoding: 8bit

Hello,

Is there any chance that someone could add

     "Description"

as a KEYWORD, which would then populate the program header if RCS 
detects the string '$Description: $, in the same fashion as the '$Log: 
$' string ?

I am an old-school engineering type, *now retired*, love RCS, but don't 
program in C, C++, Perl, Python or Java.

I use RCS mostly for all my OS Bourne/Bash scripts and config management 
files.

Having the "Description" string as a keyword for reporting that in the 
source file after check-in, and to be able to parse for that with awk 
during external function calls for refefence or lookup, would be very 
useful, as well as for the automatic generation of a web page providing 
a guide to programs available and their function (report the Description).

Anyone who could give that coding a review to see how easy it would be 
to implement that seemingly simple addition (by replication the 
behaviours for the other KEYWORDs, especially that of '$Log: $').

 From scanning the files looking for '$State:  $', I was able to 
initially identify the folowing 2 files that might be involved in 
implementing that feature:

    rcs-5.9.4/doc/rcs.texi

    rcs-5.9.4/src/rcskeep.c

Other files might be involved, but I don't know how to interpret or code 
these languages.

Again from scanning those files, and from the tools behaviour, it seems 
that the tool already has the logic to capture and store the Description 
text.  All that is now needed is for the tool to offer the KEYWORD 
option for populating the image extracted from RCS with the text 
associated with the Description function, in the same manner that it 
handles a embedded RCS log with '$Log: $'.

The above would help me to document, and keep conceptually 
well-organized, the coding/system that will emerge as I now embark on a 
a personal project to learn and apply Prolog to make sense of the many, 
varied and conflicting medical and scientific information related to 3 
conditions of interest:

     - reduced cardiac motility following Myocardial Infarction,

     - weight control due to compromised pancreas and intestines, and

     - metabolic interractions due to Full Thyroidectomy (hormone 
replacement/interraction/symptoms).

Whoever could make that new KEYWORD functionality for "Description" 
available would find me eternaly grateful!

Thank you,


Eric

P.S.  I am too used to RCS and have no desire to learn any of the 
alternates like git, cvs, sourceforge, etc.  Thank you.

*
*

*My current system:* (H/W is about 10 years old)

Memory:   4 GB

Disk:
     Drive 1:  2 TB WD      (Personal "Good" machine for all e-mail/web, 
etc; multi-partition)
     Drive 2:  500 GB WD  (Application testbed)
     Drive 3:  120 GB WD  (OS distro testbed)
     Drive 4:  2 TB WD      (for doing image backups of drive 1; 2 
partitions)

System:
     Kernel: 5.4.0-48-generic x86_64 bits: 64 gcc: 7.5.0
     Desktop: MATE 1.20.1 (Gtk 3.22.30-1ubuntu4) info: mate-panel dm: 
lightdm
     Distro: Ubuntu 18.04.5 LTS   (my Distro test drive has Ubuntu 
20.04.01 installed)

CPU:
     Quad core AMD Phenom II X4 810 (-MCP-)
     arch: K10 rev.2 cache: 2048 KB  bmips: 20869
     clock speeds: min/max: 800/2600 MHz    1: 1400 MHz 2: 1400 MHz 3: 
800 MHz 4: 800 MHz

Graphics:
     Card: Advanced Micro Devices [AMD/ATI] RS780D [Radeon HD 3300] 
bus-ID: 01:05.0 chip-ID: 1002:9614
     Display Server: X.Org 1.20.8 drivers: ati,radeon (unloaded: 
modesetting,fbdev,vesa)
     Resolution: [email protected]
     OpenGL: renderer: AMD RS780 (DRM 2.50.0 / 5.4.0-48-generic, LLVM 
10.0.0) version: 3.3
     Mesa 20.0.8 (compat-v: 3.0) Direct Render: Yes



--------------9297084D6B246F8F613D2DD2
Content-Type: text/html; charset=utf-8
Content-Transfer-Encoding: 8bit

<html>
  <head>

    <meta http-equiv="content-type" content="text/html; charset=UTF-8">
  </head>
  <body>
    <p>Hello,</p>
    <p>Is there any chance that someone could add</p>
    <p>    "Description"</p>
    <p>as a KEYWORD, which would then populate the program header if RCS
      detects the string '$Description: $, in the same fashion as the
      '$Log: $' string ?</p>
    <p>I am an old-school engineering type, <b>now retired</b>, love
      RCS, but don't program in C, C++, Perl, Python or Java.<br>
    </p>
    <p>I use RCS mostly for all my OS Bourne/Bash scripts and config
      management files.</p>
    <p>Having the "Description" string as a keyword for reporting that
      in the source file after check-in, and to be able to parse for
      that with awk during external function calls for refefence or
      lookup, would be very useful, as well as for the automatic
      generation of a web page providing a guide to programs available
      and their function (report the Description).</p>
    <p>Anyone who could give that coding a review to see how easy it
      would be to implement that seemingly simple addition (by
      replication the behaviours for the other KEYWORDs, especially that
      of '$Log: $').  <br>
    </p>
    <p>From scanning the files looking for '$State:  $', I was able to
      initially identify the folowing 2 files that might be involved in
      implementing that feature:</p>
    <blockquote>
      <p>rcs-5.9.4/doc/rcs.texi</p>
      <p>rcs-5.9.4/src/rcskeep.c</p>
    </blockquote>
    <p>Other files might be involved, but I don't know how to interpret
      or code these languages.</p>
    <p>Again from scanning those files, and from the tools behaviour, it
      seems that the tool already has the logic to capture and store the
      Description text.  All that is now needed is for the tool to offer
      the KEYWORD option for populating the image extracted from RCS
      with the text associated with the Description function, in the
      same manner that it handles a embedded RCS log with '$Log: $'.</p>
    <p>The above would help me to document, and keep conceptually
      well-organized, the coding/system that will emerge as I now embark
      on a a personal project to learn and apply Prolog to make sense of
      the many, varied and conflicting medical and scientific
      information related to 3 conditions of interest:</p>
    <p>    - reduced cardiac motility following Myocardial Infarction,</p>
    <p>    - weight control due to compromised pancreas and intestines,
      and</p>
    <p>    - metabolic interractions due to Full Thyroidectomy (hormone
      replacement/interraction/symptoms).</p>
    Whoever could make that new KEYWORD functionality for "Description"
    available would find me eternaly grateful!
    <p>Thank you,</p>
    <p><br>
    </p>
    <p>Eric</p>
    <p>P.S.  I am too used to RCS and have no desire to learn any of the
      alternates like git, cvs, sourceforge, etc.  Thank you.</p>
    <p><b><br>
      </b></p>
    <p><b>My current system:</b> (H/W is about 10 years old)</p>
    <p>Memory:   4 GB</p>
    <p>Disk:<br>
          Drive 1:  2 TB WD      (Personal "Good" machine for all
      e-mail/web, etc; multi-partition)<br>
          Drive 2:  500 GB WD  (Application testbed)<br>
          Drive 3:  120 GB WD  (OS distro testbed)<br>
          Drive 4:  2 TB WD      (for doing image backups of drive 1; 2
      partitions)</p>
    <p>System:<br>
          Kernel: 5.4.0-48-generic x86_64 bits: 64 gcc: 7.5.0 <br>
          Desktop: MATE 1.20.1 (Gtk 3.22.30-1ubuntu4) info: mate-panel
      dm: lightdm <br>
          Distro: Ubuntu 18.04.5 LTS   (my Distro test drive has Ubuntu
      20.04.01 installed)<br>
    </p>
    <p>CPU:<br>
          Quad core AMD Phenom II X4 810 (-MCP-) <br>
          arch: K10 rev.2 cache: 2048 KB  bmips: 20869<br>
          clock speeds: min/max: 800/2600 MHz    1: 1400 MHz 2: 1400 MHz
      3: 800 MHz 4: 800 MHz</p>
    <p>Graphics:<br>
          Card: Advanced Micro Devices [AMD/ATI] RS780D [Radeon HD 3300]
      bus-ID: 01:05.0 chip-ID: 1002:9614<br>
          Display Server: X.Org 1.20.8 drivers: ati,radeon (unloaded:
      modesetting,fbdev,vesa) <br>
          Resolution: <a class="moz-txt-link-abbreviated" href="mailto:[email protected]">[email protected]</a><br>
          OpenGL: renderer: AMD RS780 (DRM 2.50.0 / 5.4.0-48-generic,
      LLVM 10.0.0) version: 3.3 <br>
          Mesa 20.0.8 (compat-v: 3.0) Direct Render: Yes<br>
    </p>
    <br>
  </body>
</html>

--------------9297084D6B246F8F613D2DD2--