[Date Prev][Date Next] [Thread Prev][Thread Next] [Date Index] [Thread Index]

Bug#446275: xfs: add descriptive comment to top of init script



Package: xfs
Version: 1:1.0.1-5
Severity: wishlist

On Thu, Oct 11, 2007 at 12:34:40PM -0400, Piotr F Mitros wrote:
> Hello,
> 
> I noticed you were listed as the maintainer at the top of
> /etc/init.d/xfs. I had a minor suggestion. Add a comment to
> the top of the file explaining what it is and what it does,
> and possibly, where to find more documentation.
> 
> The file currently begins with:
> 
> #!/bin/sh
> 
> # $Id: xfs.init 2186 2005-02-11 07:11:05Z branden $
> 
> # Copyright 1998-2004 Branden Robinson <branden@debian.org>.
> ...
> 
> 
> I would suggest beginning it with something to the effect of:
> 
> #!/bin/sh
> # Initialization script for the X Font Server.
> # For more information, see /usr/share/doc/xfs/README.Debian
> # or run: man xfs
> 
> # $Id: xfs.init 2186 2005-02-11 07:11:05Z branden $
> 
> # Copyright 1998-2004 Branden Robinson <branden@debian.org>.
> 
> Little touches like this can make the system significantly
> more newbie-friendly.

For configuration files in general, I agree.  For init scripts in
particular, I am less certain, as the function of each file in /etc/init.d
is mandated by the Linux Standard Base.

I am not the package maintainer of xfs anymore, though, so I am opening a
Debian bug report to accommodate your request.

(Note to self/package maintainers: please change the submitter of this bug
to Mr. Mitros once the BTS has allocated a bug number.)

-- 
G. Branden Robinson                |      Experience is simply the name we
Debian GNU/Linux                   |      give our mistakes.
branden@debian.org                 |      -- Oscar Wilde
http://people.debian.org/~branden/ |

Attachment: signature.asc
Description: Digital signature


Reply to: