[src/trunk]: src/usr.bin/cksum Add comments about intentionally not documenti...

[elad <elad%NetBSD.org@localhost>]

details:   https://anonhg.NetBSD.org/src/rev/f6935fc0efe5
branches:  trunk
changeset: 583757:f6935fc0efe5
user:      elad <elad%NetBSD.org@localhost>
date:      Sun Aug 21 19:33:10 2005 +0000

description:
Add comments about intentionally not documenting the deprecated -1, -2, -4,
-5, -6, and -m flags so they are not mistakenly get documented again in the
future.

diffstat:

 usr.bin/cksum/cksum.1 |  7 ++++++-
 usr.bin/cksum/cksum.c |  9 +++++++--
 2 files changed, 13 insertions(+), 3 deletions(-)

diffs (51 lines):

diff -r 4dc5ea53a067 -r f6935fc0efe5 usr.bin/cksum/cksum.1
--- a/usr.bin/cksum/cksum.1     Sun Aug 21 18:51:44 2005 +0000
+++ b/usr.bin/cksum/cksum.1     Sun Aug 21 19:33:10 2005 +0000
@@ -1,4 +1,4 @@
-.\"    $NetBSD: cksum.1,v 1.26 2005/08/21 18:51:44 elad Exp $
+.\"    $NetBSD: cksum.1,v 1.27 2005/08/21 19:33:10 elad Exp $
 .\"
 .\" Copyright (c) 1991, 1993
 .\"    The Regents of the University of California.  All rights reserved.
@@ -154,6 +154,11 @@
 .Pp
 The options are as follows:
 .Bl -tag -width indent
+.\"
+.\" Note that the -a <algorithm> flag replaces the deprecated -1, -2, -4,
+.\" -5, -6, and -m flags. Their usage should be discouraged, so they are
+.\" intentionally left out of documentation.
+.\"
 .It Fl a Ar algorithm
 When invoked as
 .Nm cksum ,
diff -r 4dc5ea53a067 -r f6935fc0efe5 usr.bin/cksum/cksum.c
--- a/usr.bin/cksum/cksum.c     Sun Aug 21 18:51:44 2005 +0000
+++ b/usr.bin/cksum/cksum.c     Sun Aug 21 19:33:10 2005 +0000
@@ -1,4 +1,4 @@
-/*     $NetBSD: cksum.c,v 1.25 2005/08/21 18:51:44 elad Exp $  */
+/*     $NetBSD: cksum.c,v 1.26 2005/08/21 19:33:10 elad Exp $  */
 
 /*-
  * Copyright (c) 1991, 1993
@@ -81,7 +81,7 @@
 #if 0
 static char sccsid[] = "@(#)cksum.c    8.2 (Berkeley) 4/28/95";
 #endif
-__RCSID("$NetBSD: cksum.c,v 1.25 2005/08/21 18:51:44 elad Exp $");
+__RCSID("$NetBSD: cksum.c,v 1.26 2005/08/21 19:33:10 elad Exp $");
 #endif /* not lint */
 
 #include <sys/cdefs.h>
@@ -181,6 +181,11 @@
                }
        }
 
+       /*
+        * The -1, -2, -4, -5, -6, and -m flags should be deprecated, but
+        * are still supported in code to not break anything that might
+        * be using them.
+        */
        while ((ch = getopt(argc, argv, "a:mno:ps:tx12456")) != -1)
                switch(ch) {
                case 'a':