Date: Thu, 10 Feb 2005 15:20:05 +0200 From: Ruslan Ermilov <ru@FreeBSD.org> To: Bruce Evans <bde@zeta.org.au> Cc: cvs-all@FreeBSD.org Subject: Re: cvs commit: src/share/examples/ses/getencstat getencstat.0 src/share/examples/ses/sesd sesd.0 src/share/examples/ses/setencstat setencstat.0 src/share/examples/ses/setobjstat setobjstat.0 src/shar Message-ID: <20050210132005.GA51180@ip.net.ua> In-Reply-To: <20050210202900.B21458@epsplex.bde.org> References: <200502091807.j19I7HrO003008@repoman.freebsd.org> <20050209214537.GY18759@submonkey.net> <20050210142452.R28116@delplex.bde.org> <20050210083319.GB43466@ip.net.ua> <20050210202900.B21458@epsplex.bde.org>
next in thread | previous in thread | raw e-mail | index | archive | help
--gBBFr7Ir9EOA20Yy Content-Type: text/plain; charset=us-ascii Content-Disposition: inline Content-Transfer-Encoding: quoted-printable On Thu, Feb 10, 2005 at 09:06:51PM +1100, Bruce Evans wrote: > On Thu, 10 Feb 2005, Ruslan Ermilov wrote: >=20 > > On Thu, Feb 10, 2005 at 03:02:49PM +1100, Bruce Evans wrote: > > > On Wed, 9 Feb 2005, Ceri Davies wrote: > > > > style(9) doesn't say anything about this - could you add something > > > > please? > > > > > It actually does. Manpages are similar to C header files in this > > respect, i.e., the following apply, among other: > > > > - after a copyright header, there's a blank line, and then $FreeBSD$; >=20 > It literally says "rcsid" instead of "$FreeBSD$" here, and only mentions > $FreeBSD$ by example. I avoid using "rcsid" since ids may or may not be > rcsids. >=20 I take it differently. I'm pretty sure that by "rcsid" only $FreeBSD$ is meant, while "sccsid" falls under "obtained from elsewhere", and as such "should not be edited". At the time of rev. 1.48 of style.9 where "rcsid" was added, the example following it looked like this: static const char rcsid[] =3D "$FreeBSD$"; So it's a clear leftover from when we later switched from "rcsid" to __FBSDID(). I suggest that we say "$FreeBSD$" not __FBSDID in a manpage, so it's applicable both to C source files and other source files, including manpages: %%% Index: style.9 =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D RCS file: /home/ncvs/src/share/man/man9/style.9,v retrieving revision 1.117 diff -u -r1.117 style.9 --- style.9 9 Feb 2005 18:07:17 -0000 1.117 +++ style.9 10 Feb 2005 13:05:28 -0000 @@ -23,9 +23,10 @@ .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF .\" SUCH DAMAGE. .\" +.\" From: @(#)style 1.14 (Berkeley) 4/28/95 .\" $FreeBSD: src/share/man/man9/style.9,v 1.117 2005/02/09 18:07:17 ru Ex= p $ .\" -.Dd December 7, 2001 +.Dd February 10, 2005 .Dt STYLE 9 .Os .Sh NAME @@ -82,7 +83,7 @@ considered license statements. .Pp After any copyright header, there is a blank line, and the -.Va rcsid +.Li $\&FreeBSD$ for source files. Version control system ID tags should only exist once in a file (unlike in this one). %%% > > - $FreeBSD$ should exist only once, except in the style.9 manpage; >=20 > It actually says "Version control system ID tags" instead of "$FreeBSD$" > here. This covers $FreeBSD$ with more than an example, but without the > example it only requires at most 1 $FreeBSD$ and not exactly 1. >=20 It's fine -- our CVS won't let it in if it doesn't have any. ;) > > - keep and do not edit foreign IDs. > > > > > style.9 says a lot about this for C programs, and used to say somethi= ng > > > about this for man pages by example: $FreeBSD$ goes immediately after > > > the vendor id. > > > > > Except it actually says to put $FreeBSD$ after a copyright block, and >=20 > Except is actually says that there is an rcsid after the copyright block, > and then gives an example with an sccsid instead of an rcsid. Only the > example shows that other ids follow the "rcsid". >=20 See above about rcsid vs. __FBSDID(). Cheers, --=20 Ruslan Ermilov ru@FreeBSD.org FreeBSD committer --gBBFr7Ir9EOA20Yy Content-Type: application/pgp-signature Content-Disposition: inline -----BEGIN PGP SIGNATURE----- Version: GnuPG v1.2.6 (FreeBSD) iD8DBQFCC1+FqRfpzJluFF4RAnS8AJ91Z3R3g8ipDfmQ20Ujs0ECTwO+hwCfUMXm 0OOg5pE1XWQo5RF9lE/HtCE= =EaS+ -----END PGP SIGNATURE----- --gBBFr7Ir9EOA20Yy--
Want to link to this message? Use this URL: <https://mail-archive.FreeBSD.org/cgi/mid.cgi?20050210132005.GA51180>