2.3 Git Basics should mention pressing "q" to quit `git log --patch`

Open Beginner friendly
#1,980 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
1/5
Estimated time
Under an hour
Newbie friendliness
62/100
Issue type
Documentation
Clarity
Clearly specified
Activity status
Stale
Tech stack
git
Domain
documentation

Research direction

Start in section 2.3, “Git Basics,” and review the explanation of git log --patch and its -p/--patch options. Update the text to mention pressing "q" to exit the change view, then verify that the section clearly explains how to return from the displayed patches.

Written by the indexing model from the issue text.

Description

enhancement
General overview of your idea.

One of the more helpful options is -p or --patch, which shows the difference (the patch output) introduced in each commit. You can also limit the number of log entries displayed, such as using -2 to show only the last two entries.

There's not mention of pressing "q" to exit the view of the changes. I had to look this up separately.

What problem will this solve?

This will prevent mild inconvenience.

Have you thought about other solutions?

Google

Do you want to help with this enhancement idea?

No

Dominant language
CSS
Stars
6.6k
Forks
2.1k
No merged PRs in 30d

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from progit/progit2

All issues in progit/progit2

Similar issues

More Documentation issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.