README: fix few minor things Signed-off-by: Dmitry Vyukov <dvyukov@google.com> Change-Id: I783e0dbc91830ed26de8e72ca80f5f6b6b687bdb
diff --git a/README.md b/README.md index 78ce917..fcd6eda 100644 --- a/README.md +++ b/README.md
@@ -1,16 +1,17 @@ -# Gerrit code reviews for Linux kernel +# Gerrit code reviews for the Linux kernel `Gerrit` is a modern code review system that supports: * patch series * versioned changes (no need to explain what changed) * change tracking (what's your open changes/changes to review) -* side-by-side diffs (shows added/removed parts within a line) -* full file context and base repository/revision -* web-based rebase and editing files/commit message -* preserving comments across versions +* side-by-side diffs (shows added/removed parts within a line too) +* full file context (you don't miss bugs on error paths) +* base repository/revision (you can apply patches locally) +* web-based rebase and editing files/commit message (for minor edits) +* preserving comments across versions and comment threads -and more. Refer to +and more. Refer to the [User Guide](https://gerrit-review.googlesource.com/Documentation/intro-user.html) and [Gerrit Docs](https://gerrit-review.googlesource.com/Documentation/index.html) for more info, but the information below should be enough to get you started. @@ -50,12 +51,12 @@ ``` * Sign in into the gerrit instance using [Sign in](https://linux.googlesource.com) -link in the top-right corver. +link in the top-right corner. * Click [Generate Password](https://accounts.google.com/o/oauth2/auth?response_type=code&access_type=offline&approval_prompt=force&client_id=413937457453.apps.googleusercontent.com&scope=https://www.googleapis.com/auth/gerritcodereview&redirect_uri=https://www.googlesource.com/new-password&state=linux) link in the top menu. Copy-paste and execute the script which adds an auth -cookie for pushing changes for review. +cookie required for pushing changes for review. * Add gerrit commit hook to the git repo with: @@ -85,9 +86,10 @@ ``` Pushing to the special path `refs/for/target-branch` creates a change based -on the `target-branch`. The command output will contain URL of the change, e.g.: +on the `target-branch`. The command output will contain the URL of the change, +e.g.: -[https://linux-review.googlesource.com/c/linux/kernel/git/davem/net/+/1109](https://linux-review.googlesource.com/c/linux/kernel/git/davem/net/+/1109) +https://linux-review.googlesource.com/c/linux/kernel/git/davem/net/+/1109 you should also see it on the [dashboard](https://linux-review.googlesource.com/dashboard/self). @@ -108,3 +110,5 @@ as well as the diff between versions: https://linux-review.googlesource.com/c/linux/kernel/git/davem/net/+/1109/1..2 + +To create patch series simply push a branch with multiple commits.