From owner-freebsd-doc@FreeBSD.ORG Sun Aug 17 07:40:15 2003 Return-Path: Delivered-To: freebsd-doc@hub.freebsd.org Received: from mx1.FreeBSD.org (mx1.freebsd.org [216.136.204.125]) by hub.freebsd.org (Postfix) with ESMTP id 7539A37B401 for ; Sun, 17 Aug 2003 07:40:15 -0700 (PDT) Received: from freefall.freebsd.org (freefall.freebsd.org [216.136.204.21]) by mx1.FreeBSD.org (Postfix) with ESMTP id 145DE43F93 for ; Sun, 17 Aug 2003 07:40:15 -0700 (PDT) (envelope-from gnats@FreeBSD.org) Received: from freefall.freebsd.org (gnats@localhost [127.0.0.1]) by freefall.freebsd.org (8.12.9/8.12.9) with ESMTP id h7HEeEUp073890 for ; Sun, 17 Aug 2003 07:40:14 -0700 (PDT) (envelope-from gnats@freefall.freebsd.org) Received: (from gnats@localhost) by freefall.freebsd.org (8.12.9/8.12.9/Submit) id h7HEeEHj073889; Sun, 17 Aug 2003 07:40:14 -0700 (PDT) Date: Sun, 17 Aug 2003 07:40:14 -0700 (PDT) Message-Id: <200308171440.h7HEeEHj073889@freefall.freebsd.org> To: freebsd-doc@FreeBSD.org From: underway@comcast.net (Gary W. Swearingen) Subject: Re: docs/55653: chflags.1 - note that not all tools chflags aware. X-BeenThere: freebsd-doc@freebsd.org X-Mailman-Version: 2.1.1 Precedence: list Reply-To: "Gary W. Swearingen" List-Id: Documentation project List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Sun, 17 Aug 2003 14:40:15 -0000 The following reply was made to PR docs/55653; it has been noted by GNATS. From: underway@comcast.net (Gary W. Swearingen) To: Tony Maher Cc: FreeBSD-gnats-submit@FreeBSD.org Subject: Re: docs/55653: chflags.1 - note that not all tools chflags aware. Date: Sun, 17 Aug 2003 07:36:37 -0700 Tony Maher writes: > Attached is patch which just notes this in the chflags.1 man page. Good idea. > +.Sh BUGS The warning note would be better placed in a custom WARNING (or NOTES) section, or in a standard COMPATIBILITY section or even in the DESCRIPTION. It's not about a chflags(1) bug. The fact that other manpages abuse their BUGS section is no reason for this one to do it. > +Only a limited number of tools know about about chflags. -- Only a limited number of tools know about chflags. -- Only a limited number of tools know about file flags. -- Only a limited number of programs know about file flags. -- A limited number of programs know about file flags. -- Some programs do not know about file flags. -- Some programs do not handle file flags. -- Some programs which should handle file flags do not. > +Some of the tools which are It's debatable whether any of these tools/utilities/programs should be listed in the manpage, mainly because it adds a continual source of manpage bugs as file flags and their support changes from time to time. Also, the info would, to be consistent, need to be added to chflags(2) and other manpages that deal with file flags. I tend to like helpful manpages, but in this case I think it's better to limit that help to the generic warning note and put these lists of programs in a Handbook "File Flags" section, if anywhere. Also: The tar(1) and pax(1) manpages should say in their BUGS sections that they don't support file flags, if that's the case.