Code

Opened 4 years ago

Closed 4 years ago

Last modified 4 years ago

#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: UI/UX:

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)

explicit-ln-path.diff (1.3 KB) - added by stumbles 4 years ago.

Download all attachments as: .zip

Change History (12)

comment:1 Changed 4 years ago by russellm

  • Needs documentation unset
  • Needs tests unset
  • Patch needs improvement unset
  • Triage Stage changed from Unreviewed to Accepted

comment:2 Changed 4 years ago by stumbles

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.

Changed 4 years ago by stumbles

comment:3 Changed 4 years ago by stumbles

  • Component changed from Uncategorized to Documentation
  • Has patch set

comment:4 Changed 4 years ago by adamnelson

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 Changed 4 years ago by stumbles

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 Changed 4 years ago by stumbles

  • Cc ben@… added

comment:7 Changed 4 years ago by adamnelson

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:

http://tldp.org/LDP/abs/html/commandsub.html

comment:8 Changed 4 years ago by stumbles

I think using pwd is an unnecessary complication here. Better to just be explicit.

comment:9 Changed 4 years ago by timo

  • Triage Stage changed from Accepted to Ready for checkin

comment:10 Changed 4 years ago by gabrielhurley

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

(In [14062]) Fixed #13279 -- Made the paths in the Unix install docs more explicit. Thanks to KathyManwaring for the report and stumbles for the patch.

comment:11 Changed 4 years ago by gabrielhurley

(In [14063]) [1.2.X] Fixed #13279 -- Made the paths in the Unix install docs more explicit. Thanks to KathyManwaring for the report and stumbles for the patch.

Backport of [14062] from trunk.

Add Comment

Modify Ticket

Change Properties
<Author field>
Action
as closed
as The resolution will be set. Next status will be 'closed'
The resolution will be deleted. Next status will be 'new'
Author


E-mail address and user name can be saved in the Preferences.

 
Note: See TracTickets for help on using tickets.