Opened 6 years ago

Closed 6 years ago

Last modified 4 years ago

#12102 closed (fixed)

Relative PYTHONPATH in the docs

Reported by: alexkon Owned by:
Component: Documentation Version: 1.1
Severity: Keywords:
Cc: Triage Stage: Accepted
Has patch: yes Needs documentation: no
Needs tests: no Patch needs improvement: no
Easy pickings: UI/UX:

Description

In at least one place in the documentation you explicitly recommend setting the PYTHONPATH environment variable to a relative path:

PYTHONPATH=..
./runtests.py --settings=settings generic_relations i18n

There is an obvious security risk associated with relative paths.

Suggestions:

  1. Change the above line to something like PYTHONPATH=`pwd`/..
  1. Add a warning everywhere in the docs where you mention setting the PYTHONPATH variable that for security reasons it must contain absolute paths only.

Attachments (1)

PYTHONPATH_documentation_patch.diff (517 bytes) - added by arnav 6 years ago.
git-diff for the patch

Download all attachments as: .zip

Change History (7)

comment:1 Changed 6 years ago by jacob

  • Needs documentation unset
  • Needs tests unset
  • Owner jacob deleted
  • Patch needs improvement unset

comment:2 Changed 6 years ago by jcd

  • Triage Stage changed from Unreviewed to Accepted

Changed 6 years ago by arnav

git-diff for the patch

comment:3 Changed 6 years ago by arnav

  • Has patch set

Patch added.

comment:4 Changed 6 years ago by russellm

  • Resolution set to fixed
  • Status changed from new to closed

(In [12570]) Fixed #12102 -- Corrected an example in the docs that suggested that you use a relative path in your PYTHONPATH. Thanks to alexkon for the report.

comment:5 Changed 6 years ago by russellm

(In [12572]) [1.1.X] Fixed #12102 -- Corrected an example in the docs that suggested that you use a relative path in your PYTHONPATH. Thanks to alexkon for the report.

Backport of r12570 from trunk.

comment:6 Changed 4 years ago by jacob

  • milestone 1.2 deleted

Milestone 1.2 deleted

Note: See TracTickets for help on using tickets.
Back to Top