Gentoo Websites Logo
Go to: Gentoo Home Documentation Forums Lists Bugs Planet Store Wiki Get Gentoo!
Bug 184327 - Request for a description-variable for initscripts
Summary: Request for a description-variable for initscripts
Status: RESOLVED FIXED
Alias: None
Product: Gentoo Linux
Classification: Unclassified
Component: [OLD] baselayout (show other bugs)
Hardware: All All
: High enhancement (vote)
Assignee: Gentoo's Team for Core System packages
URL:
Whiteboard:
Keywords:
Depends on:
Blocks:
 
Reported: 2007-07-05 16:39 UTC by momesana
Modified: 2007-07-10 19:15 UTC (History)
0 users

See Also:
Package list:
Runtime testing required: ---


Attachments

Note You need to log in before you can comment on or make changes to this bug.
Description momesana 2007-07-05 16:39:50 UTC
I would like to have a variable within the respective initscript describing what it does and optionally and additional function like --description that prints out the content of this variable. I think, it is not overly clear to many users what certain initscripts does due to cryptic names or the lack of experience from the user. This is particularly true if the user is a newbie or not very familiar with system-administration. such a description would be very helpful to these users.

Reproducible: Always




http://forums.gentoo.org/viewtopic-p-4130478.html#4130478
Comment 1 Kurt Lieber (RETIRED) gentoo-dev 2007-07-05 17:59:02 UTC
please don't play with the default values when filing a bug unless you know what you're doing.
Comment 2 momesana 2007-07-05 18:38:13 UTC
(In reply to comment #1)
> please don't play with the default values when filing a bug unless you know
> what you're doing.
> 
Does this refer to the reproducible:always entry? Well, if so, I will leave the value unchanged next time.

Comment 3 Roy Marples (RETIRED) gentoo-dev 2007-07-10 19:15:28 UTC
I've committed a patch to our svn repo that allows for the following

# Extra option
opts="save"

description="Service foo does bar"
description_save="saves foo"

#/etc/init.d/foo describe
* Service foo does bar
* save: saves foo

Also, two new functions have been added to librc.so :
char **rc_service_options (const char *service);
char *rc_service_description (const char *service, const char *option);

The first one returns a string array of extra options the init script has. The result needs to be freed with rc_strlist_free.
The second one returns the description of the service (if option is NULL) or the option. This needs to be freed with free.