From ab5890d498c095da0d2047adfc68fc0f04ed4fbd Mon Sep 17 00:00:00 2001 From: Michael Bacarella Date: Wed, 5 Dec 2018 12:37:30 -0800 Subject: 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 Change-Id: I49734c724c4d6da716a358cd849938ef14dab3b1 Reviewed-on: https://review.coreboot.org/c/30060 Tested-by: build bot (Jenkins) Reviewed-by: Patrick Georgi --- Documentation/lessons/lesson2.md | 17 +++++++++++++---- 1 file changed, 13 insertions(+), 4 deletions(-) (limited to 'Documentation/lessons') 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 -- cgit v1.2.3