From: Emily Shaffer <firstname.lastname@example.org>
To: Elijah Newren <email@example.com>
Cc: Git Mailing List <firstname.lastname@example.org>
Subject: Re: [PATCH] doc: hint about GIT_DEBUGGER
Date: Mon, 20 May 2019 13:38:43 -0700 [thread overview]
Message-ID: <20190520203843.GA64994@google.com> (raw)
> > + - You can launch gdb around your program using the shorthand GIT_DEBUGGER.
> > + Run `GIT_DEBUGGER=1 ./bin-wrappers/git foo` to simply use gdb as is, or
> > + run `GIT_DEBUGGER=debugger-binary some-args ./bin-wrappers/git foo` to
> Missing some quotes around debugger-binary and some-args:
> + run `GIT_DEBUGGER="debugger-binary some-args" ./bin-wrappers/git foo` to
> Also, one thing I always wonder about with command documentation like
> this is whether people will understand that "debugger-binary",
> "some-args", and "foo" are just placeholders rather than literal text
> -- and that everything else is literal text and not meant to be
> placeholders. Does it make since to include a couple examples, or
> perhaps modify the text somehow to avoid confusion between
> placeholders and literals, or maybe just tell me I overthinking this?
> (I've been bit by similar problems in other contexts, so I'm just
> flagging it for you to consider).
It's a good point. I like to use placeholders that don't sound like a
real command (and failed a little here), for example,
`GIT_DEBUGGER=my-cool-debugger some-various-args`. It can be a challenge
to choose a placeholder that sounds fake but also doesn't sound too
informal (the above feels informal to me). I think the best way is to
show an example, that's a good idea. I'll come up with one and send
another round this week.
Thanks a bunch for having a look.
next prev parent reply other threads:[~2019-05-20 20:38 UTC|newest]
Thread overview: 10+ messages / expand[flat|nested] mbox.gz Atom feed top
2019-05-17 20:48 [PATCH] doc: hint about GIT_DEBUGGER Emily Shaffer
2019-05-18 5:40 ` Elijah Newren
2019-05-20 20:38 ` Emily Shaffer [this message]
2019-05-21 1:00 ` [PATCH v2] " Emily Shaffer
2019-05-21 16:06 ` Elijah Newren
2019-05-21 18:19 ` Emily Shaffer
2019-05-23 0:55 ` [PATCH v3] doc: hint about GIT_DEBUGGER in CodingGuidelines Emily Shaffer
2019-05-23 10:09 ` Eric Sunshine
2019-05-28 19:05 ` Emily Shaffer
2019-05-28 19:07 ` [PATCH v4] " Emily Shaffer
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
List information: http://vger.kernel.org/majordomo-info.html
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
Code repositories for project(s) associated with this public inbox
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).