update.sh: improve verbose output and readability.

[MikeMcQuaid]

• Have you followed the guidelines in our Contributing document?
• Have you checked to ensure there aren't other open Pull Requests for the same change?
• Have you added an explanation of what your changes do and why you'd like us to include them?
• Have you written new tests for your changes? Here's an example.
• Have you successfully run brew tests with your changes locally?

---

Would have made it easier to debug Homebrew/homebrew-core#2804 where wasn't clear which directory was causing the issue.

[UniqMartin]

The tiniest nit, but there's a missing space between $DIR and ... which sticks out because it is present in the other message you added.

[MikeMcQuaid]

I'd probably rather remove the space in the other location if that's 🆒?

[UniqMartin]

I'm fine with either solution as long as it's consistent and I'm not 100% sure about typographical conventions about this in the English language. Still I'm a tiny bit bothered that the ... could be misinterpreted to be a part of the directory (as silly as that might sound).

[retokromer]

Typographically … (not ...) without space before. Yet…

[UniqMartin]

Sure, in normal text I always use “…” (it's even directly accessible from my keyboard layout). It looks kinda weird in output on the command line though (squeezed into a single column) and can be problematic in source code, where we tend to stick to ASCII-only.

[retokromer]

Personally, in "ASCII art" I would not use "LaTeX quality" and add a space before ... in this case, in order to avoid the misinterpretation you pointed out.

[UniqMartin]

While I'm generally in favor of this PR, I think in its current state it might contribute to the confusion when output related to <repo2> will appear under a heading that suggests it's still operating on <repo1>. It would be really nice if all verbose Git output related to a given directory/repository was grouped under a common heading that indicates this directory/repository.

To address this, I'd suggest to either move the added verbose output to the very top of the pull function or to add additional verbose output there. (Something like Updating $DIR ... will probably do.)

(I once proposed something similar in Homebrew/legacy-homebrew#49905 but I guess it had a bad start as it was originally disabling parallelization—for the sake of clearer debug output—and then was blocked by discussion about the structure of the output and implementation details of ohai et al. in Bash, that I also made part of the PR. Just wanted to mention this for some context and prior discussion.)

[MikeMcQuaid]

@UniqMartin Take a look now; have changed the approach somewhat.

[UniqMartin]

I think you can omit this here and instead move the echo to the top of the pull function, before Updating $DIR... is output, which simplifies things a tiny bit and will also create a visual separation between the fetch phase and the rebase/merge phase.

But you could still add this line after the loop over all repositories in homebrew-update to create some visual separation between the rebase/merge phase and the output of update-report.

[MikeMcQuaid]

Fetch doesn't echo every time; put it at the beginning of this line and you will sometimes see the first line of output as an empty line.

[UniqMartin]

True. I didn't think about this case, probably because I'm running brew update at most every few hours, so there's essentially always something that needs to be fetched. Feel free to leave things as-is or eliminate this line of code completely, whichever you prefer.

The important change is that the output now contains some extra lines that announce what repository brew update is currently operating on and that's valuable information. A few missing or superfluous empty lines for readability won't detract from that.

[UniqMartin]

Thanks for making this change; I'm a lot happier with the output! In fact I'm 👍 on the change as-is. (There's one suggestion in a code comment you might want to integrate beforehand.)