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

Add brew cask upgrade to man page #41372

Closed
commitay opened this issue Nov 27, 2017 · 6 comments
Closed

Add brew cask upgrade to man page #41372

commitay opened this issue Nov 27, 2017 · 6 comments

Comments

@commitay
Copy link
Contributor

commitay commented Nov 27, 2017

Refs: Homebrew/brew#3396

https://github.com/Homebrew/brew/blob/master/Library/Homebrew/manpages/brew-cask.1.md

@commitay commitay added core Issue with Homebrew itself rather than with a specific cask. documentation Issue regarding documentation. ready to implement labels Nov 27, 2017
@commitay commitay changed the title Add brew cask upgrade to man pages Add brew cask upgrade to man page Nov 27, 2017
@amyspark amyspark added the good first issue Issue which is easy to tackle for first-time contributors. label Dec 5, 2017
@seanprashad
Copy link

Hi @commitay! I'd love to work on this but I'm not sure which documentation file I'm updating since the URL you linked is in an entirely different repo - could you point me in the right direction please?

@commitay
Copy link
Contributor Author

Hi @seanprashad!

The URL is correct, our core code was merged with Homebrew.

brew-cask.1.md can be updated, then run brew man to regenerate the man page and commit the changed files.

An example of a similar manpage update and the regenerated files is Homebrew/brew#3221

@seanprashad
Copy link

@commitay I've done initial changes but when I run the brew man command, it doesn't change anything:
screen shot 2017-12-29 at 6 48 53 pm

I've also committed the modified source files before and after I ran that command - is there something I missed?

@commitay
Copy link
Contributor Author

commitay commented Dec 30, 2017

Looks like you're working in a different repo to your Homebrew installation, the changes need to be made in the same repo that brew man will run in.

$ echo test > $(brew --repo)/Library/Homebrew/manpages/brew-cask.1.md

$ brew man
Writing markdown to /usr/local/Homebrew/docs/Manpage.md
Writing man page to /usr/local/Homebrew/manpages/brew.1
Writing man page to /usr/local/Homebrew/manpages/brew-cask.1

$ git -C $(brew --repo) status
On branch master
Your branch is up to date with 'origin/master'.

Changes not staged for commit:
  (use "git add <file>..." to update what will be committed)
  (use "git checkout -- <file>..." to discard changes in working directory)

	modified:   Library/Homebrew/manpages/brew-cask.1.md
	modified:   manpages/brew-cask.1

no changes added to commit (use "git add" and/or "git commit -a")

@seanprashad
Copy link

Hi @commitay - my changes were reviewed and merged in Homebrew/brew#3609 - is it safe to close this issue now?

@commitay
Copy link
Contributor Author

Thanks @seanprashad!

@commitay commitay removed core Issue with Homebrew itself rather than with a specific cask. documentation Issue regarding documentation. good first issue Issue which is easy to tackle for first-time contributors. ready to implement labels Dec 30, 2017
@lock lock bot locked as resolved and limited conversation to collaborators May 6, 2018
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants