Bug 521303
| Summary: | Fix instances of #!/usr/bin/env python in python-docs | ||
|---|---|---|---|
| Product: | Red Hat Enterprise Linux 5 | Reporter: | Chris Williams <cww> |
| Component: | python-docs | Assignee: | Roman Rakus <rrakus> |
| Status: | CLOSED WONTFIX | QA Contact: | BaseOS QE <qe-baseos-auto> |
| Severity: | medium | Docs Contact: | |
| Priority: | medium | ||
| Version: | 5.4 | CC: | cww, dmalcolm, psplicha, rbiba, rvokal, tao, tsmetana |
| Target Milestone: | rc | ||
| Target Release: | --- | ||
| Hardware: | All | ||
| OS: | Linux | ||
| Whiteboard: | |||
| Fixed In Version: | Doc Type: | Bug Fix | |
| Doc Text: | Story Points: | --- | |
| Clone Of: | Environment: | ||
| Last Closed: | 2013-03-12 14:32:54 UTC | Type: | --- |
| Regression: | --- | Mount Type: | --- |
| Documentation: | --- | CRM: | |
| Verified Versions: | Category: | --- | |
| oVirt Team: | --- | RHEL 7.3 requirements from Atomic Host: | |
| Cloudforms Team: | --- | Target Upstream Version: | |
| Embargoed: | |||
| Bug Depends On: | |||
| Bug Blocks: | 502912, 521940, 590060 | ||
|
Description
Chris Williams
2009-09-04 16:59:07 UTC
Not entirely true. python-docs is a documentation package full of HTML files. Although some documents do use #!/usr/bin/env python in examples of python code and there's also a few .txt files that contain python code, there's no python executable in this package that would call it. Should the documents & examples be fixed too? Event posted on 09-08-2009 09:02am EDT by kbaxley For the sake of consistency, please go ahead and fix them, but this is not a high priority item. There may be a case where a customer will use one of those examples as a template or something like that and it could end up generating an unwanted surprise. This event sent from IssueTracker by kbaxley issue 339216 Makes sense. Thanks for the clarification. This can be done fasttrack (In reply to comment #2) > Event posted on 09-08-2009 09:02am EDT by kbaxley > > For the sake of consistency, please go ahead and fix them, but this is not > a high priority item. > > There may be a case where a customer will use one of those examples as a > template or something like that and it could end up generating an unwanted > surprise. I was deliberately special-casing "system executables" when I wrote https://fedoraproject.org/wiki/Features/SystemPythonExecutablesUseSystemPython since they're intended to be run with the system version of python. Upstream's guidance on this is that python developers should use #!/usr/bin/env python as the shebang: http://docs.python.org/tutorial/interpreter.html#executable-python-scripts since this allows you to write scripts that work on a locally-built python environment by setting your PATH. So for the case of RPM packaging, it's the right thing to do, but for other cases it might not be, and changing the documentation in the manner of comment #2 could be misleading. Note that the /tutorial/interpreter.html page above is one of the files we ship within the python-docs package. So perhaps we could update that with downstream-specific guidance? RHEL-5.10 (the next RHEL-5 minor release) is going to be the first production phase 2 [1] release of RHEL-5. Since phase 2 we'll be addressing only security and critical issues. [1] https://access.redhat.com/support/policy/updates/errata/ |