git.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Jeff King <peff@peff.net>
To: "Martin Ågren" <martin.agren@gmail.com>
Cc: git@vger.kernel.org, Eric Sunshine <sunshine@sunshineco.com>
Subject: Re: [PATCH v2] doc-diff: don't `cd_to_toplevel` before calling `usage`
Date: Mon, 4 Feb 2019 00:01:53 +0100	[thread overview]
Message-ID: <20190203230152.GA25608@sigill.intra.peff.net> (raw)
In-Reply-To: <20190203110817.17242-1-martin.agren@gmail.com>

On Sun, Feb 03, 2019 at 12:08:17PM +0100, Martin Ågren wrote:

> `usage` tries to call $0, which might very well be "./doc-diff", so if
> we `cd_to_toplevel` before calling `usage`, we'll end with an error to
> the effect of "./doc-diff: not found" rather than a friendly `doc-diff
> -h` output. Granted, all of these `usage` calls are in error paths, so
> we're about to exit anyway, but the user experience of something like
> `(cd Documentation && ./doc-diff)` could be a bit better than
> "./doc-diff: not found".
> 
> This regressed in ad51743007 ("doc-diff: add --clean mode to remove
> temporary working gunk", 2018-08-31) where we moved the call to
> `cd_to_toplevel` to much earlier. Move it back to where it was, and
> teach the "--clean" code to cd on its own. This way, we only cd once
> we've verified the arguments.
> 
> A more general fix would be to teach git-sh-setup to save away the
> absolute path for $0 and then use that, instead. I'm not aware of any
> portable way of doing that, see, e.g., d2addc3b96 ("t7800: readlink
> may not be available", 2016-05-31), so let's just fix this user
> instead.

This (and the patch) seems quite reasonable as a fix.

I actually think we could go further and drop the cd_to_toplevel
entirely. IIRC, the only thing it accomplishes[1] is that we can
consistently refer to the tmp directory as Documentation/tmp-doc-diff.

It would probably be fine to:

  - use "$(git rev-parse --show-toplevel)/Documentation/tmp-doc-diff".
    In earlier iterations of the script, I think using an absolute path
    bled through to the resulting diff, but we later cleaned that up
    anyway.

  - just use a relative "tmp-doc-diff". I doubt anybody actually wants
    to do anything other than "cd Documentation && ./doc-diff" anyway.
    This breaks "./Documentation/doc-diff", but it is not like you can
    run "t/t0000-basic.sh" either.

-Peff

[1] I think also in early iterations I had some notion of using the cwd
    to build things, but that quickly went out the window in favor of
    worktrees.

  reply	other threads:[~2019-02-03 23:01 UTC|newest]

Thread overview: 27+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2019-02-03  8:35 [PATCH] doc-diff: don't `cd_to_toplevel` before calling `usage` Martin Ågren
2019-02-03  9:08 ` Eric Sunshine
2019-02-03  9:11   ` Eric Sunshine
2019-02-03 10:35     ` Martin Ågren
2019-02-03 11:01       ` Eric Sunshine
2019-02-03 11:08         ` [PATCH v2] " Martin Ågren
2019-02-03 23:01           ` Jeff King [this message]
2019-02-04 20:50             ` [PATCH v3] doc-diff: don't `cd_to_toplevel` Martin Ågren
2019-02-04 23:34               ` Jeff King
2019-02-05 10:34                 ` Johannes Schindelin
2019-02-05 18:45                   ` Junio C Hamano
2019-02-06 12:20                     ` Johannes Schindelin
2019-02-06 17:24                       ` Junio C Hamano
2019-02-06 18:55                     ` Jeff King
2019-02-07 15:41                       ` Johannes Schindelin
2019-02-07 17:37                         ` Junio C Hamano
2019-02-07 21:34                           ` Johannes Schindelin
2019-02-07 20:49                         ` Jeff King
2019-02-07 21:42                           ` Johannes Schindelin
2019-02-06 18:49                   ` Jeff King
2019-02-07 14:26                     ` Johannes Schindelin
2019-02-07 20:45                       ` Jeff King
2019-02-07 21:57                         ` Johannes Schindelin
2019-02-08  2:53                           ` Jeff King
2019-02-08  4:34                             ` Jeff King
2019-02-08  0:58                         ` SZEDER Gábor
2019-02-08  2:51                           ` Jeff King

Reply instructions:

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:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20190203230152.GA25608@sigill.intra.peff.net \
    --to=peff@peff.net \
    --cc=git@vger.kernel.org \
    --cc=martin.agren@gmail.com \
    --cc=sunshine@sunshineco.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* 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.
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 NNTP newsgroup(s).