Repository navigation
use --directory option of make in describing how to build the docs #61018
Description
| BPO | 16814 |
|---|---|
| Nosy | @birkenfeld, @orsenthil, @ezio-melotti, @merwok, @bitdancer, @sandrotosi, @cjerdonek |
| Files |
Note: these values reflect the state of the issue at the time it was migrated and might not reflect the current state.
Show more details
GitHub fields:
assignee = None
closed_at = <Date 2012-12-29.17:50:50.869>
created_at = <Date 2012-12-29.14:11:51.837>
labels = ['docs']
title = 'use --directory option of make in describing how to build the docs'
updated_at = <Date 2013-01-11.16:21:01.766>
user = 'https://bugs.python.org/tshepang'bugs.python.org fields:
activity = <Date 2013-01-11.16:21:01.766>
actor = 'eric.araujo'
assignee = 'none'
closed = True
closed_date = <Date 2012-12-29.17:50:50.869>
closer = 'georg.brandl'
components = ['Devguide']
creation = <Date 2012-12-29.14:11:51.837>
creator = 'tshepang'
dependencies = []
files = ['28480', '28489', '28642']
hgrepos = []
issue_num = 16814
keywords = ['patch']
message_count = 18.0
messages = ['178495', '178496', '178497', '178505', '178517', '178550', '178552', '178556', '178563', '178565', '178582', '178753', '179346', '179407', '179414', '179644', '179645', '179695']
nosy_count = 9.0
nosy_names = ['georg.brandl', 'orsenthil', 'ezio.melotti', 'eric.araujo', 'r.david.murray', 'sandro.tosi', 'chris.jerdonek', 'tshepang', 'python-dev']
pr_nums = []
priority = 'normal'
resolution = 'fixed'
stage = 'resolved'
status = 'closed'
superseder = None
type = None
url = 'https://bugs.python.org/issue16814'
versions = []
Activity
tshepang commentedon Dec 29, 2012
This avoids having to run 2 separate commands.
sandrotosi commentedon Dec 29, 2012
i'd use
make -C Doc html
much more compact and what you would usually find on the internet for "cd into the dir and run the html target in it"
tshepang commentedon Dec 29, 2012
I like long-form options for documentation purposes since it's clearer
what the option is for.
bitdancer commentedon Dec 29, 2012
I think the fact that the cd paradigm is more commonly encountered is a fairly strong argument in favor of keeping it, but I'm only -0 on this change.
[-]use --directory option of make[/-][+]use --directory option of make in describing how to build the docs[/+]birkenfeld commentedon Dec 29, 2012
Agree with David.
cjerdonek commentedon Dec 30, 2012
Another option is to give the shorter option as an alternative. I for one didn't know about that option but would have liked to. Patch attached.
Also, this way we can give the shorter option and the reader can still see pretty easily what it is for.
cjerdonek commentedon Dec 30, 2012
s/shorter option/one-liner/
birkenfeld commentedon Dec 30, 2012
This is not a `make' tutorial...
tshepang commentedon Dec 30, 2012
I find the latest patch to be a great compromise though. Many people
would be grateful to learn about the -C option. I am one of them.
birkenfeld commentedon Dec 30, 2012
Well, I'm not -1 about the patch. But there is something to be said for conciseness, and sprinkling the docs with endless alternate routes will not make it easier to read quickly and get the information you need.
ezio-melotti commentedon Dec 30, 2012
FWIW even if I heard about the one-liner a few times already I can't really seem to remember it, and prefer to do "cd Doc" anyway. Using "cd Doc" also makes all the subsequent commands shorter (e.g. opening files, running other make targets).
The patch proposed by Chris looks OK to me though.
orsenthil commentedon Jan 1, 2013
I find, cd Doc easy to remember as well. If make tricks can be used then I
hope readers note it rather than be exposed via Documentation. Chris's
patch is helpful to me, but still I may not vote a +1 for it to be in
Documentation. thanks.
On Sun, Dec 30, 2012 at 7:14 AM, Ezio Melotti <[email protected]>wrote:
merwok commentedon Jan 8, 2013
FWIW I use make -C Doc all the time but agree with Georg’s point about conciseness. Ezio, I suggest you bookmark some make doc page if you can’t remember it :)
cjerdonek commentedon Jan 9, 2013
For the record, we do have tutorial-like documentation and document more than one way to do things in multiple places throughout the devguide. For example:
http://docs.python.org/devguide/faq.html#how-do-i-list-the-files-in-conflict-after-a-merge
Unlike the short options for long commands, though, it's not obvious to look for something like
make -C(because you don't already know it's there). That's why I think this option is more deserving.Personally, when working on doc patches, I frequently go back and forth between
make htmlandhg diff. Knowing about -C means one doesn't have to cd up and down the directory each time or double-check what directory one is in.I think it's okay and should even be a goal of the devguide to point out more efficient ways to contribute, which may sometimes involve saying more than the minimum (e.g. saying how something works, or stating a more "advanced" way to do something). I still think we should strive for conciseness within those constraints. Here is a new patch that makes the current language more concise in addition to some other minor changes.
ezio-melotti commentedon Jan 9, 2013
Mercurial commands work on the whole repo, regardless on the dir you are in (unlike SVN ones). That's why I usually just cd in Doc/ and do everything (opening files with editor/browser, make *, hg *) from there. Even when I prepare a patch I can do
hg di > ../patch.diffif I want it in the root.I don't think there's any harm in mentioning briefly
make -C Doc htmlthough.python-dev commentedon Jan 11, 2013
New changeset 5f24a77e7beb by Chris Jerdonek in branch 'default':
Issue bpo-16814: add "make -C Doc html" short-cut to documentation instructions.
http://hg.python.org/devguide/rev/5f24a77e7beb
cjerdonek commentedon Jan 11, 2013
I went ahead and committed this if that's okay. I wasn't sensing any strong objection but -0 from some and +1 or +0 from others. To compensate for the extra six words, I went ahead and first made the current language more concise here:
http://hg.python.org/devguide/rev/157066a204ab
If anyone feels strongly, I would be happy to revert the change though.
merwok commentedon Jan 11, 2013
LGTM.