#13279 closed (fixed)
Documentation that needs a small expansion
Reported by: | KathyManwaring | Owned by: | nobody |
---|---|---|---|
Component: | Documentation | Version: | 1.1 |
Severity: | Keywords: | ||
Cc: | ben@… | Triage Stage: | Ready for checkin |
Has patch: | yes | Needs documentation: | no |
Needs tests: | no | Patch needs improvement: | no |
Easy pickings: | no | UI/UX: | no |
Description
This issue relates to this page: http://docs.djangoproject.com/en/dev/topics/install/#installing-development-version
This has two references in file paths to 'pwd'. Unfortunately, being a newbie to Linux, I typed this exactly, including the quotes, as there was no note to change this to my actual environment. This meant that I had to delete the links and recreate them once I worked out what was actually meant.
It would be nice if a note was included to replace that with your working directory, like the note to change SITE-PACKAGES-DIR.
Attachments (1)
Change History (12)
comment:1 by , 15 years ago
Triage Stage: | Unreviewed → Accepted |
---|
comment:2 by , 15 years ago
by , 15 years ago
Attachment: | explicit-ln-path.diff added |
---|
comment:3 by , 15 years ago
Component: | Uncategorized → Documentation |
---|---|
Has patch: | set |
comment:4 by , 15 years ago
pwd with the backticks should be interpreted by the command line and use the working directory (the directory you're in now). You must have manually copied the backquotes into tick marks - simply copying and pasting the command would have worked fine.
Or am I missing something?
comment:5 by , 14 years ago
Adamnelson, you're correct, pasting should have worked fine. I think the patch is a useful change though, as people installing Django may not understand the significance of backticks or the shell command "pwd". Making this one-liner more explicit should hopefully reduce the chance of problems or at least give the person a better chance of figuring it out themselves.
comment:6 by , 14 years ago
Cc: | added |
---|
comment:7 by , 14 years ago
In that case, can the patch keep the backticks but add a note explaining that backticks are interpreted by the shell and maybe link here:
comment:8 by , 14 years ago
I think using pwd
is an unnecessary complication here. Better to just be explicit.
comment:9 by , 14 years ago
Triage Stage: | Accepted → Ready for checkin |
---|
comment:10 by , 14 years ago
Resolution: | → fixed |
---|---|
Status: | new → closed |
The commands with
pwd
are intended to be run unmodified (pwd
is a sub-command that prints the name of the directory you're in - a shortcut to save typing in this case).This command relies on being run in the same directory that the "svn co" command was run in. My first instinct after checking out some files is to "cd" into the new directory and have a poke around. In this case the
pwd
shortcut wouldn't work for me. This is a neat shortcut, but perhaps it would be less troublesome to just spell out that the full path to the new "django-trunk/django" directory must be used.