Gentoo Websites Logo
Go to: Gentoo Home Documentation Forums Lists Bugs Planet Store Wiki Get Gentoo!
Bug 489344 - sys-apps/openrc RC_* vars undocumented in runscript (8)
Summary: sys-apps/openrc RC_* vars undocumented in runscript (8)
Status: RESOLVED FIXED
Alias: None
Product: Gentoo Hosted Projects
Classification: Unclassified
Component: OpenRC (show other bugs)
Hardware: All Linux
: Normal enhancement (vote)
Assignee: OpenRC Team
URL:
Whiteboard:
Keywords:
Depends on:
Blocks: 481182
  Show dependency tree
 
Reported: 2013-10-25 10:31 UTC by Duncan
Modified: 2014-01-08 19:35 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 Duncan 2013-10-25 10:31:25 UTC
So I was investigating an openrc bug and I came across RC_LIBEXECDIR.  Unfortunately, it doesn't appear to be documented along with the other RC_* vars listed in the runscript (8) manpage.  So I decided I'd grep for RC_* in /etc/init.d/* and compare what came up against the list in the manpage.  Here's the undocumented var results (against openrc-9999 updated about a day ago I believe):

RC_LIBEXECDIR
RC_TTY_NUMBER
RC_GOINGDOWN
RC_NO_UMOUNTS (comment in mount-ro but nothing in the manpage)
RC_SERVICE
RC_PARALLEL
RC_DOWN_INTERFACE
RC_DOWN_DARDDISK
RC_COLDPLUG
RC_SOFTLEVEL

(There's also RC_GOT_FUNCTIONS but it appears that's just a source-gating variable to functions.sh so it can probably remain undocumented.)

Please add these to the runscript (8) manpage.
Comment 1 William Hubbs gentoo-dev 2013-10-31 19:33:09 UTC
(In reply to Duncan from comment #0)
> RC_LIBEXECDIR
> RC_GOINGDOWN
> RC_SERVICE

I agree that these should be documented, and I will add them to the runscript man page.

> RC_NO_UMOUNTS (comment in mount-ro but nothing in the manpage)

I agree that this should be documented, but probably not on the runscript man page. This should be covered when we document OpenRC plugins, which haven't been documented yet.

> RC_PARALLEL
> RC_TTY_NUMBER

These are covered in /etc/rc.conf, and RC_TTY_NUMBER does not even appear on non-Linux systems.

> RC_DOWN_INTERFACE
> RC_DOWN_DARDDISK
> RC_COLDPLUG
> RC_SOFTLEVEL

These are not part of the OpenRC code base.
If they are not documented in the /etc/conf.d/* files associated with the scripts they were found in, this might be an issue.
Comment 2 William Hubbs gentoo-dev 2014-01-08 03:26:02 UTC
(In reply to William Hubbs from comment #1)
> (In reply to Duncan from comment #0)
> > RC_LIBEXECDIR
> > RC_GOINGDOWN
> > RC_SERVICE
> > RC_NO_UMOUNTS

I will document all of these in the manpage.
Comment 3 William Hubbs gentoo-dev 2014-01-08 19:34:50 UTC
This is added in commit e5a94dd and will be part of OpenRC-0.13.