[coreboot-gerrit] Change in ...coreboot[master]: Documentation/lessons/lesson2.md: clear up confusing language around ...

Michael Bacarella (Code Review) gerrit at coreboot.org
Wed Dec 5 21:41:49 CET 2018


Michael Bacarella has uploaded this change for review. ( https://review.coreboot.org/c/coreboot/+/30060


Change subject: Documentation/lessons/lesson2.md: clear up confusing language around running gitconfig
......................................................................

Documentation/lessons/lesson2.md: clear up confusing language around running 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
docuentation to make it clearer.  Also adds a blurb further down with a link to
find Gerrit workflow docs.

Change-Id: I49734c724c4d6da716a358cd849938ef14dab3b1
Signed-off-by: Michael Bacarella <michael.bacarella at gmail.com>
---
M Documentation/lessons/lesson2.md
1 file changed, 14 insertions(+), 4 deletions(-)



  git pull ssh://review.coreboot.org:29418/coreboot refs/changes/60/30060/1

diff --git a/Documentation/lessons/lesson2.md b/Documentation/lessons/lesson2.md
index a95dd80..5b774cd 100644
--- a/Documentation/lessons/lesson2.md
+++ b/Documentation/lessons/lesson2.md
@@ -71,14 +71,18 @@
 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
@@ -208,6 +212,12 @@
 Submitting as a draft means that 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, especially if you plan to work on multiple changes at the same
+time.  See
+https://gerrit-review.googlesource.com/Documentation/intro-user.html#code-review
+
 ## Part 5: Getting your commit reviewed
 
 Your commits can now be seen on review.coreboot.org if you select “Your”

-- 
To view, visit https://review.coreboot.org/c/coreboot/+/30060
To unsubscribe, or for help writing mail filters, visit https://review.coreboot.org/settings

Gerrit-Project: coreboot
Gerrit-Branch: master
Gerrit-Change-Id: I49734c724c4d6da716a358cd849938ef14dab3b1
Gerrit-Change-Number: 30060
Gerrit-PatchSet: 1
Gerrit-Owner: Michael Bacarella <michael.bacarella at gmail.com>
Gerrit-MessageType: newchange
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://mail.coreboot.org/pipermail/coreboot-gerrit/attachments/20181205/cc1c8d4b/attachment.html>


More information about the coreboot-gerrit mailing list