Details
- Reviewers
olasd - Group Reviewers
Reviewers - Commits
- rDDOC3df1bd4419f9: dev doc: source virtualenvwrapper.sh, as mkvirtualenv is gone from PATH
Diff Detail
- Repository
- rDDOC Development documentation
- Branch
- bug/mkvirtualenvwrapper-gone
- Lint
No Linters Available - Unit
No Unit Test Coverage - Build Status
Buildable 7440 Build 10603: arc lint + arc unit
Event Timeline
virtualenvwrapper has always been implemented as a set of shell functions to be sourced in your $shell_profile file, so I don't think the commit message is quite correct (as there's never been a mkvirtualenv command in anyone's PATH).
It's clear that the current instructions won't work when running all commands in succession (because virtualenvwrapper's config won't have been sourced unless the session has been restarted), so I guess this change is better than nothing.
All in all I think it would be better if the virtualenvwrapper setup was moved to a new paragraph, because the intent of this paragraph is to tell people to create a swh virtualenv and to enter it, not really to tell them how to set up virtualenvwrapper (which isn't mandatory as noted in the next paragraph).
I hear you, and agree. I've proposed this change to have something that would work out of the box even for someone who has never used virtualenvwrapper (although, admittedly, only the first time; starting from the 2nd time they'll need to know how to properly set it up to get a working workon anyway…). I think it's better than nothing too, so I won't revert it. A dedicated paragraph about virtualenv only, pointing to appropriate general doc (any suggestion?) would indeed be better.