Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update upgrade/outdated documentation #650

Merged
merged 1 commit into from Aug 6, 2016

Conversation

vladshablinsky
Copy link
Contributor

  • 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?

Document new --fetch-HEAD flag for outdated and upgrade commands.

@xu-cheng xu-cheng merged commit b8ce1fe into Homebrew:master Aug 6, 2016
@UniqMartin UniqMartin added the gsoc-outreachy Google Summer of Code or Outreachy label Aug 7, 2016
#:
#: If `--fetch-HEAD` is passed, fetch upstream repository to detect that HEAD
#: formula is outdated. Otherwise HEAD-installation is considered outdated if
#: new stable or devel version is bumped after that installation.
Copy link
Member

Choose a reason for hiding this comment

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

@vladshablinsky Current text reads a bit weird. How about (assuming it's accurate):

If `--fetch-HEAD` is passed, fetch the upstream repository to detect if the HEAD
installation of the formula is outdated. Otherwise, the repository's HEAD will be
checked for updates when a new stable or devel version has been released.

Copy link
Member

Choose a reason for hiding this comment

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

Also, how long does this operation take on e.g. a standard GitHub repo?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

How about (assuming it's accurate)

Looks good.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

how long does this operation take on e.g. a standard GitHub repo?

@MikeMcQuaid, I will test, but shouldn't be too time-consuming for GitHubGitDownloadStrategy. However, for GitDownloadStrategy we need to fetch the repo, so it takes some time. How do I understand whether results are OK or not OK when I do some benchmarks?

Copy link
Member

Choose a reason for hiding this comment

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

Just post them here 😀. I think we could do it automatically for GitHub, then?

Copy link
Member

Choose a reason for hiding this comment

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

I think we could do it automatically for GitHub, then?

I would avoid it otherwise we may get formula tagged as outdated for a popular repo too often whenever we run brew upgrade/outdated. We need a flag to control the behaviors, whether you want prompt update or not.

Besides the time is still relative consuming:

$ time brew outdated
brew outdated  0.59s user 0.14s system 79% cpu 0.921 total
$ time brew outdated --fetch-HEAD
neovim/neovim/neovim (HEAD-4dc4efc) < HEAD-abb0928dfbf71d5358b56e888db9ed8ff66d8933
brew outdated --fetch-HEAD  0.54s user 0.10s system 13% cpu 4.918 total

@vladshablinsky vladshablinsky deleted the fetch-head-man branch August 11, 2016 07:30
@Homebrew Homebrew locked and limited conversation to collaborators May 3, 2018
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
gsoc-outreachy Google Summer of Code or Outreachy
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants