GNUBoot
/
coreboot-kgpe-d16
2
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

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>
This commit is contained in:
Michael Bacarella 2018-12-05 12:37:30 -08:00 committed by Patrick Georgi
parent 54e80cec9f
commit ab5890d498
1 changed files with 13 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
Documentation/lessons/lesson2.md
View File

@ -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" If you are using HTTP, instead, select **http** from the tabs under "Project coreboot"
and run the command that appears and run the command that appears
After it finishes cloning, "cd coreboot" will take you into the local Now is a good time to configure your global git identity, if you haven't
git repository. Run "make gitconfig" to set up the hooks and configurations. already.
For example, you will be asked to run the following commands to set your
username and email.
git config --global user.name "Your Name" git config --global user.name "Your Name"
git config --global user.email "Your Email" 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 ## Part 4: Submit a commit
An easy first commit to make is fixing existing checkpatch errors and warnings 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 your commit will be on coreboot.org, but is only visible to those you add
as reviewers. 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 ## Part 4b: Using git cola to stage and submit a commit
If git cola is not installed on your machine, see If git cola is not installed on your machine, see