Relay-Version: version B 2.10 5/3/83; site utzoo.UUCP
Posting-Version: notesfiles
Path: utzoo!watmath!clyde!burl!mgnetp!ihnp4!houxm!vax135!cornell!uw-beaver!tektronix!hplabs!hp-pcd!hpfcla!ajs
From: ajs@hpfcla.UUCP (ajs)
Newsgroups: net.unix
Subject: Re: putting comments in nroff/troff--var
Message-ID: <43800018@hpfcla.UUCP>
Date: Sun, 16-Sep-84 20:50:00 EDT
Article-I.D.: hpfcla.43800018
Posted: Sun Sep 16 20:50:00 1984
Date-Received: Wed, 12-Sep-84 02:51:15 EDT
References: <536@ucbtopaz.UUCP>
Organization: Hewlett-Packard - Fort Collins, CO
Lines: 22
Nf-ID: #R:ucbtopaz:-53600:hpfcla:43800018:000:1129
Nf-From: hpfcla!ajs    Sep  4 16:50:00 1984

>> Subject: putting comments in nroff/troff--various ways

All this talk of how to put comments in documents  leads me to espousing
what I think is a good general principle, too often overlooked:

"When  designing a program  that reads input  data,  design a way to put
comments into the input data."

There are about ten  well-known  UN*X  configuration  files.  Some, like
/etc/termcap,  were  designed  "right".  Some, like  /etc/rc, are really
shell  scripts,  so you are  home  free.  Some,  like  /etc/inittab  and
/usr/lib/crontab,  allow comments by accident -- unrecognized  lines are
ignored (in AT&T versions  anyway), so you can insert comments and blank
lines;  commands are passed through  /bin/sh, so you can comment them on
the right  side with "#".  Most,  however,  just  don't let you get away
with it, and it's a shame.

In particular, it would be *really nice* to be able to put comments in
/etc/passwd, and in L.sys, and in sed(1) scripts (any sed scripts).

Alan Silverstein, Hewlett-Packard Fort Collins Systems Division, Colorado
{ihnp4 | hplabs}!hpfcla!ajs, 303-226-3800 x3053, N 40 31'31" W 105 00'43"