Skip to content

Conversation

gromgit
Copy link
Contributor

@gromgit gromgit commented Jan 19, 2025

Usually, the subdirectory name is sufficient info, and the full file list is just noise.

This reduces brew doctor output clutter, making it easier for user to paste, and maintainers to parse.

Before:

$ brew doctor
[...]
Unexpected header files:
  /usr/local/include/node/cppgc/allocation.h
  /usr/local/include/node/cppgc/common.h
  /usr/local/include/node/cppgc/custom-space.h
  /usr/local/include/node/cppgc/garbage-collected.h
  /usr/local/include/node/cppgc/heap.h
  /usr/local/include/node/cppgc/internal/accessors.h
  /usr/local/include/node/cppgc/internal/api-constants.h
  /usr/local/include/node/cppgc/internal/compiler-specific.h
  /usr/local/include/node/cppgc/internal/finalizer-trait.h
  /usr/local/include/node/cppgc/internal/gc-info.h
  /usr/local/include/node/cppgc/internal/logging.h
  /usr/local/include/node/cppgc/internal/persistent-node.h
  /usr/local/include/node/cppgc/internal/pointer-policies.h
  /usr/local/include/node/cppgc/internal/prefinalizer-handler.h
[about 500 more files]

After:

$ brew doctor
Unexpected header files:
  /usr/local/include/node/*

The full list of stray files can still be viewed with brew doctor -v.

  • 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 style with your changes locally?
  • Have you successfully run brew typecheck with your changes locally?
  • Have you successfully run brew tests with your changes locally?

@gromgit gromgit force-pushed the diagnostic/less-verbose-fnames branch from a3ef241 to d8da011 Compare January 19, 2025 04:53
Copy link
Member

@MikeMcQuaid MikeMcQuaid left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks, looks good! Feel free to merge as-is without a rereview if you accept the suggestion as-is.

@gromgit gromgit force-pushed the diagnostic/less-verbose-fnames branch 2 times, most recently from 2bdcc96 to a2d7073 Compare January 19, 2025 15:18
gromgit and others added 2 commits January 19, 2025 23:19
Usually, the subdirectory name is sufficient info, and the full file list is just noise.

This reduces `brew doctor` output clutter, making it easier for user to paste, and maintainers to parse.

Before:
```
$ brew doctor
[...]
Unexpected header files:
  /usr/local/include/node/cppgc/allocation.h
  /usr/local/include/node/cppgc/common.h
  /usr/local/include/node/cppgc/custom-space.h
  /usr/local/include/node/cppgc/garbage-collected.h
  /usr/local/include/node/cppgc/heap.h
  /usr/local/include/node/cppgc/internal/accessors.h
  /usr/local/include/node/cppgc/internal/api-constants.h
  /usr/local/include/node/cppgc/internal/compiler-specific.h
  /usr/local/include/node/cppgc/internal/finalizer-trait.h
  /usr/local/include/node/cppgc/internal/gc-info.h
  /usr/local/include/node/cppgc/internal/logging.h
  /usr/local/include/node/cppgc/internal/persistent-node.h
  /usr/local/include/node/cppgc/internal/pointer-policies.h
  /usr/local/include/node/cppgc/internal/prefinalizer-handler.h
[about 500 more files]
```
After:
```
$ brew doctor
Unexpected header files:
  /usr/local/include/node/...
```
The full list of stray files can still be viewed with `brew doctor -v`.
@gromgit gromgit force-pushed the diagnostic/less-verbose-fnames branch from a2d7073 to 872bb92 Compare January 19, 2025 15:19
@MikeMcQuaid
Copy link
Member

Thanks again @gromgit!

@MikeMcQuaid MikeMcQuaid added this pull request to the merge queue Jan 19, 2025
Merged via the queue into Homebrew:master with commit fd0c851 Jan 19, 2025
35 checks passed
@gromgit gromgit deleted the diagnostic/less-verbose-fnames branch January 20, 2025 04:15
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants