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

Jump to bottom

x/review/git-codereview: package documentation for multi-commit branch workflow does not match behavior #37038

Open
zikaeroh opened this issue Feb 5, 2020 · 2 comments
Open

x/review/git-codereview: package documentation for multi-commit branch workflow does not match behavior #37038

zikaeroh opened this issue Feb 5, 2020 · 2 comments
Labels
Documentation help wanted NeedsFix The path to resolution is known, but the work has not been done.
Milestone
Unreleased

Comments

@zikaeroh
Copy link
Contributor

zikaeroh commented Feb 5, 2020

The package documentation for git-codereview says:

The 'git codereview change' command amends the top commit in the stack (HEAD).

However, CL 20049 appears to have removed this behavior, instead stating that some combination git commit --amend and git rebase should be used instead.

I'd appreciate it if these docs were updated to better explain the current behavior (potentially with an example).

I'm working on a multi-change contribution, and am finding this a little bit confusing to figure out.
@gopherbot gopherbot added this to the Unreleased milestone Feb 5, 2020
@ianlancetaylor
Copy link
Contributor

CC @adg (since he wrote the CL that changed the behavior)

@ianlancetaylor ianlancetaylor added help wanted NeedsFix The path to resolution is known, but the work has not been done. labels Feb 5, 2020
@gopherbot
Copy link

Change https://golang.org/cl/264379 mentions this issue: git-codereview: update documentation of multi-commit branches

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
Documentation help wanted NeedsFix The path to resolution is known, but the work has not been done.
Projects
None yet
Milestone
Unreleased
Development

No branches or pull requests
3 participants
@ianlancetaylor @gopherbot @zikaeroh