Correction recording-changes.asc

progit / progit2

Pro Git 2nd Edition

Other

5.69k stars 1.88k forks source link

Correction recording-changes.asc #1844

Closed tejasps2001 closed 1 year ago

tejasps2001 commented 1 year ago

[ ] I provide my work under the project license.
[ ] I grant such license of my work as is required for the purposes of future print editions to Ben Straub and Scott Chacon.

Modified the statement regarding the 'git diff' command to clarify that it compares the changes between the files in your working directory and the files in your Git repository, and it shows the differences between the two sources. By default, it displays the changes that are not yet staged for commit. However, if you use the '--staged' or '--cached' option, 'git diff' will compare the changes between the files in your staging area and the latest commit in your Git repository.

ben commented 1 year ago

Going to disagree with your change here. Here's a paraphrased version of what happens in that section:

Edit the README and the CONTRIBUTING.md files
git add README
git diff
See that only the changes to CONTRIBUTING.md are shown
git diff --staged
See that only the changes to README are shown

So we do cover the --staged flag just after the section you're changing. What's more, while your change sounds friendlier, it's inventing this new concept of things being "in the repo." Is the working directory not in the repo? I'd argue that it is.

tejasps2001 commented 1 year ago

Thank you for your response and for taking the time to consider my suggestion.