Skip to content
This repository has been archived by the owner on Apr 14, 2021. It is now read-only.

Prepend debug label to resolver's debug message #7590

Merged
1 commit merged into from
Feb 27, 2020

Conversation

kou
Copy link
Contributor

@kou kou commented Jan 19, 2020

What was the end-user problem that led to this PR?

The problem was not a end-user problem. This was a developer problem.

If we have many debug messages (for example, I added many pp [...] to debug #7522), it's difficult to find resolver's debug messages.

What was your diagnosis of the problem?

My diagnosis was no common keywords in resolver's debug message is a problem. If we have a common keyword, we can find resolver's debug messages from many debug messages easily.

What is your fix for the problem, implemented in this PR?

My fix prepends BUNDLER: to all resolver's debug messages. If we have the same label in all resolver's debug messages, we can find resolver's debug message easily. For example, we can use "/BUNDLER:" in less.

Why did you choose this fix out of the possible options?

I chose this fix because BUNDLER: will not conflict. Other candidate is DEBUG: but it may be used by other library. If the keyword conflicts, it's not easy to find resolver's debug messages. Bundler::Resolver: will be more safer but it may be long.

If we have the same label in all resolver's debug messages, we can find
resolver's debug message easily. For example, we can use "/BUNDLER:"
in less. It's useful when we have many debug messages.
Copy link
Member

@deivid-rodriguez deivid-rodriguez left a comment

Choose a reason for hiding this comment

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

👍

@deivid-rodriguez
Copy link
Member

@bundlerbot merge

ghost pushed a commit that referenced this pull request Jan 22, 2020
7590: Prepend debug label to resolver's debug message r=deivid-rodriguez a=kou

### What was the end-user problem that led to this PR?

The problem was not a end-user problem. This was a developer problem.

If we have many debug messages (for example, I added many `pp [...]` to debug #7522), it's difficult to find resolver's debug messages.

### What was your diagnosis of the problem?

My diagnosis was no common keywords in resolver's debug message is a problem. If we have a common keyword, we can find resolver's debug messages from many debug messages easily.

### What is your fix for the problem, implemented in this PR?

My fix prepends `BUNDLER: ` to all resolver's debug messages. If we have the same label in all resolver's debug messages, we can find resolver's debug message easily. For example, we can use "/BUNDLER:" in less.

### Why did you choose this fix out of the possible options?

I chose this fix because `BUNDLER: ` will not conflict. Other candidate is `DEBUG: ` but it may be used by other library. If the keyword conflicts, it's not easy to find resolver's debug messages. `Bundler::Resolver: ` will be more safer but it may be long.


Co-authored-by: Sutou Kouhei <kou@clear-code.com>
@ghost
Copy link

ghost commented Jan 22, 2020

Build failed

@deivid-rodriguez
Copy link
Member

Hopefully the CI is a little more stable now.

@bundlerbot merge

@ghost
Copy link

ghost commented Feb 27, 2020

Build succeeded

@ghost ghost merged commit 0659182 into rubygems:master Feb 27, 2020
@kou kou deleted the resolver-debug-prefix branch February 27, 2020 23:51
This pull request was closed.
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants