summaryrefslogtreecommitdiff
path: root/Documentation
diff options
context:
space:
mode:
authorMichael Bacarella <michael.bacarella@gmail.com>2018-12-05 12:37:30 -0800
committerPatrick Georgi <pgeorgi@google.com>2018-12-19 10:29:47 +0000
commitab5890d498c095da0d2047adfc68fc0f04ed4fbd (patch)
tree959c65301680a2026e18013556a73057b6f9655a /Documentation
parent54e80cec9f775073a83214ef9e0ac5976ead3be5 (diff)
downloadcoreboot-ab5890d498c095da0d2047adfc68fc0f04ed4fbd.tar.xz
Documentation/lessons/lesson2.md: clarify running make gitconfig
It's easy to misinterpret or miss altogether the instruction to run 'make gitconfig', which will cause strange problems a few commands later. Revise the documentation to make it clearer. Also adds a blurb further down with a link to find Gerrit workflow docs. detached from FETCH_HEAD Signed-off-by: Michael Bacarella <michael.bacarella@gmail.com> Change-Id: I49734c724c4d6da716a358cd849938ef14dab3b1 Reviewed-on: https://review.coreboot.org/c/30060 Tested-by: build bot (Jenkins) <no-reply@coreboot.org> Reviewed-by: Patrick Georgi <pgeorgi@google.com>
Diffstat (limited to 'Documentation')
-rw-r--r--Documentation/lessons/lesson2.md17
1 files changed, 13 insertions, 4 deletions
diff --git a/Documentation/lessons/lesson2.md b/Documentation/lessons/lesson2.md
index d3e0d8c08f..c9c9484478 100644
--- a/Documentation/lessons/lesson2.md
+++ b/Documentation/lessons/lesson2.md
@@ -71,14 +71,18 @@ This should prompt you for your id_rsa passphrase, if you previously set one.
If you are using HTTP, instead, select **http** from the tabs under "Project coreboot"
and run the command that appears
-After it finishes cloning, "cd coreboot" will take you into the local
-git repository. Run "make gitconfig" to set up the hooks and configurations.
-For example, you will be asked to run the following commands to set your
-username and email.
+Now is a good time to configure your global git identity, if you haven't
+already.
git config --global user.name "Your Name"
git config --global user.email "Your Email"
+Finally, enter the local git repository and set up repository specific hooks
+and other configurations.
+
+ cd coreboot
+ make gitconfig
+
## Part 4: Submit a commit
An easy first commit to make is fixing existing checkpatch errors and warnings
@@ -149,6 +153,11 @@ coreboot.org. **Note:** To submit as a draft, use
your commit will be on coreboot.org, but is only visible to those you add
as reviewers.
+This has been a quick primer on how to submit a change to Gerrit for review
+using git. You may wish to review the [Gerrit code review workflow
+documentation](https://gerrit-review.googlesource.com/Documentation/intro-user.html#code-review),
+especially if you plan to work on multiple changes at the same time.
+
## Part 4b: Using git cola to stage and submit a commit
If git cola is not installed on your machine, see