Skip to content

Commit

Permalink
rename bitcoin-qt.rb
Browse files Browse the repository at this point in the history 
to bitcoin.rb
per naming rules in CONTRIBUTING.md
  • Loading branch information
@rolandwalker
rolandwalker committed Feb 28, 2014
1 parent 19f8351 commit 0784f01
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion Casks/bitcoin-qt.rb → Casks/bitcoin.rb
View file
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
class BitcoinQt < Cask
class Bitcoin < Cask
url 'https://bitcoin.org/bin/0.8.6/bitcoin-0.8.6-macosx.dmg'
homepage 'https://bitcoin.org/'
version '0.8.6'
Expand Down

9 comments on commit 0784f01

@drew-gross
Copy link
Contributor

Choose a reason for hiding this comment

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

Are you sure this was a good idea? I was confused about whether bitcoin was bitcoind the Bitcoin Daemon, or Bitcoin-QT, the Bitcoin client. I think this app should be an exception to the rule about removing -qt from the end of names.

@alebcay
Copy link
Member

Choose a reason for hiding this comment

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

For one thing, I'm pretty sure bitcoind isn't distributed in a package or as an app.

@rolandwalker
Copy link
Contributor Author

Choose a reason for hiding this comment

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

@drew-gross I take your point. It is always potentially confusing when there is a client and a server.

In rationalizing the names, we were trying to balance a number of sometimes-opposing factors, such as reducing duplicate submissions, making brew cask search work optimally, and getting Cask names permanently "frozen" so that we can build toward brew cask upgrade functionality.

@drew-gross
Copy link
Contributor

Choose a reason for hiding this comment

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

@alebcay while that is true, I had to go on the internet to verify that and make sure I was downloading the thing I wanted, which was Bitcoin-Qt and not bitcoind. Furthermore, it seems at least moderately likely that more Bitcoin clients will be developed in the future, some of which might be named "Bitcoin dash something" which would then result in even more confusion. I'm not really a fan of removing -qt, -wx, and etc. from names in in general, but I get why it's done. However, there should definitely be an exception for when the -qt or -wx disambiguates between this package/app and an other package/app, even if the other one is only potentially confusing, or doesn't exist yet, but is likely to in the future.

@rolandwalker
Copy link
Contributor Author

Choose a reason for hiding this comment

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

@drew-gross I am right there with you except for the part about deciding what is the likely future.

If you had to go on the Internet to verify, then that is a user-interface failure, and we should try to solve it.

The failure is deeper than this single Cask, and can be simply summarized: although the front-end and the back-end have different needs, both are constrained to depend on the same string, the "Cask name". We have recently spent effort nailing down the Cask names because sanity and predictability seem like absolute requirements for further work on the back-end. Now (and instead of tweaking one Cask name), we should work on building out our user interface.

To help the user, we do have brew cask homepage bitcoin, which I assume you know about. Useful -- but it breaks the user out from the CLI. The brew cask info bitcoin output seems a little wimpy. What do you think about including the app name in there?

Also, could this be addressed with tags? Eg :client and :server could be set as tags within a Cask, and be used as a filter for, or displayed in the output of, brew cask search. What if that came in the form of an ls -l-style version of brew cask search that combines various data in columns?

$ brew cask search -l bitcoin
bitcoin     Bitcoin-QT.app             :client, :gpl    https://bitcoin.org/
bitcoind    /usr/local/bin/bitcoind    :server, :gpl    https://bitcoin.org/

@drew-gross
Copy link
Contributor

Choose a reason for hiding this comment

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

brew cask info bitcoin was the first thing I did, I think improving that would have been the thing that would have helped me the fastest. Also, I previously had bitcoin-qt installed before it got renamed, and in brew cask list it still showed up as bitcoin-qt so thats a big part of why I was confused. Maybe an indication of renames would be good.

@muescha
Copy link
Contributor

Choose a reason for hiding this comment

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

I think a one line description to a cask would help to distinct the different apps found with brew cask search

But my suggestion #1790 was refused :(

@drew-gross
Copy link
Contributor

Choose a reason for hiding this comment

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

I think including the exact app name (as appears in spotlight/applications/etc. would be a good balance between searchability and the suggestion in #1790 )

Maybe it could also be listed in the no-flags output of brew search if it differs from the Cask name by enough.

@alebcay
Copy link
Member

Choose a reason for hiding this comment

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

I agree with @drew-gross: it would be good if the search page included the path to the binary and the website of the Cask (but not the tags, for reasons mentioned in #1790).

Please sign in to comment.