Bug 1031011 - change documentation of actions other than enable
change documentation of actions other than enable
Product: Red Hat Enterprise Linux 6
Classification: Red Hat
Component: scl-utils (Show other bugs)
Unspecified Unspecified
medium Severity medium
: rc
: ---
Assigned To: Jan Zeleny
BaseOS QE - Apps
Depends On: 1031009
Blocks: 1056252 1029795 1052414
  Show dependency treegraph
Reported: 2013-11-15 08:25 EST by Honza Horak
Modified: 2014-06-05 13:13 EDT (History)
3 users (show)

See Also:
Fixed In Version:
Doc Type: Bug Fix
Doc Text:
Story Points: ---
Clone Of: 1031009
Last Closed: 2014-06-05 13:13:23 EDT
Type: Bug
Regression: ---
Mount Type: ---
Documentation: ---
Verified Versions:
Category: ---
oVirt Team: ---
RHEL 7.3 requirements from Atomic Host:
Cloudforms Team: ---

Attachments (Terms of Use)

  None (edit)
Description Honza Horak 2013-11-15 08:25:34 EST
+++ This bug was initially created as a clone of Bug #1031009 +++

This bug is a bit related to bug #1029795, so see there for backgroud.

It seems like the only documentation about using generic actions other than "enable" right now is probably the only thing what scl(1) says:
"<action> is a script name to execute in a bash environment before the application itself takes in executed. Currently only enable scriptlet is mandatory which is needed to update search paths, etc."

This is really not what scl command does right now. Bug #1029795 tried to fix the behaviour in order to correspond with such documentation, but it is actually a change of behaviour. Until it is fixed (if at all), we should change the documentation to correspond with the current status, how the things actually work.

Particularly, according to the scl(1) man page, other actions shouldn't enable SCL environment, but in reality X_SCLS is adjusted for every action now. So I guess something like the following can be in the documentation when describing what "scl <action> <collection1> [<collection2> ...] <command>" actually does:
 * marks specified collection(s) as enabled
 * executes the script, which is expected to set proper environment
 * executes the command in the end
Comment 1 Honza Horak 2013-11-15 08:28:31 EST
Please, also ensure that help will be aligned with the current behaviour. It's mostly the same issue there.

Note You need to log in before you can comment on or make changes to this bug.