Paths

Table of Contentst

Differential D30422

porters-handbook: Fix the Git process in Chapter 11.1
ClosedPublic
Actions

Authored by ygy on May 24 2021, 6:16 PM.

Details

Reviewers

bcr

Group Reviewers

docs

Commits

R9:cb632051dc2b: porters-handbook: Fix the Git process in Chapter 11.1

Summary

In Chapter 11.1 Using Git to Make Patches, there are multiple issues with the process:

git pull --rebase will refuse to work if there are any staged or unstaged changes, so the users are unable to update the repo to the latest.
git diff does not work for staged changes, need to add --staged.

This commit attempts to address the above.

PR: 256122
Reported by: Neal Nelson <ports@nicandneal.net>

Diff Detail

Lint

Lint Skipped

Unit

Tests Skipped

Event Timeline

ygy requested review of this revision.May 24 2021, 6:16 PM

ygy created this revision.

A textual suggestion, the rest looks fine.

documentation/content/en/books/porters-handbook/upgrading/_index.adoc
112	How about splitting the "Watch and follow the output carefully" part into a separate sentence to give it more emphasis and reducing the length of the following sentence a bit?

pauamma_gundo.com added a subscriber: pauamma_gundo.com.May 24 2021, 8:22 PM

pauamma_gundo.com added inline comments.

documentation/content/en/books/porters-handbook/upgrading/_index.adoc
112	Second that. It also gets rid of a comma splice.</pedant>

Address @bcr's comment

ygy marked 2 inline comments as done.May 25 2021, 12:28 AM

pauamma_gundo.com added inline comments.May 25 2021, 1:30 AM

documentation/content/en/books/porters-handbook/upgrading/_index.adoc
39	s/you/your/ (or use "the" instead, since IIRC the doc style guide discourages 2nd-person pronouns).

Address pauamma's comment

ygy added a reviewer: bcr.May 25 2021, 8:05 PM

This revision was not accepted when it landed; it landed in state Needs Review.May 26 2021, 4:12 AM

Closed by commit R9:cb632051dc2b: porters-handbook: Fix the Git process in Chapter 11.1 (authored by ygy). · Explain Why

This revision was automatically updated to reflect the committed changes.

ygy added a commit: R9:cb632051dc2b: porters-handbook: Fix the Git process in Chapter 11.1.

Personally, I've used this workflow in the past, and it's dangerous.
I think we should instead be strongly encouraging people to commit the changes before updating.
git rebase -i will let them curate them to committable form
If anything at all goes wrong in the above, there's no 'reset and do it again' like there is with a git rebase -i gone wrong: you can simply start over with git rebase --abort. With the above, if you screw anything up in the rebase, you can lose cahnges.

Revision Contents
Changeset List

Path

Size

documentation/

content/

en/

books/

porters-handbook/

upgrading/

_index.adoc

20 lines

Diff 89800

View Options

documentation/content/en/books/porters-handbook/upgrading/_index.adoc

porters-handbook: Fix the Git process in Chapter 11.1ClosedPublicActions