diff options
Diffstat (limited to 'Documentation/tutorial/part2.md')
| -rw-r--r-- | Documentation/tutorial/part2.md | 26 |
1 files changed, 13 insertions, 13 deletions
diff --git a/Documentation/tutorial/part2.md b/Documentation/tutorial/part2.md index 43e9253fde..5ab210a591 100644 --- a/Documentation/tutorial/part2.md +++ b/Documentation/tutorial/part2.md @@ -1,8 +1,8 @@ # Tutorial, part 2: Submitting a patch to coreboot.org -## Part 1: Setting up an account at coreboot.org +## Step 1: Set up an account at coreboot.org -If you already have an account, skip to Part 2. +If you already have an account, skip to Step 2. Otherwise, go to <https://review.coreboot.org> in your preferred web browser. Select **Sign in** in the upper right corner. @@ -12,13 +12,13 @@ select **Google OAuth2** (gerrit-oauth-provider plugin). **Note:** Your username for the account will be the username of the account you used to sign-in with. (ex. your Google username). -## Part 2a: Set up RSA Private/Public Key +## Step 2a: Set up RSA Private/Public Key -If you prefer to use an HTTP password instead, skip to Part 2b. +If you prefer to use an HTTP password instead, skip to Step 2b. For the most up-to-date instructions on how to set up SSH keys with Gerrit go to <https://gerrit-documentation.storage.googleapis.com/Documentation/2.14.2/user-upload.html#configure_ssh> -and follow the instructions there. Then, skip to Part 3. +and follow the instructions there. Then, skip to Step 3. Additionally, that section of the Web site provides explanation on starting an ssh-agent, which may be particularly helpful for those who anticipate @@ -44,7 +44,7 @@ forego the password altogether as you will be using it very often. Open `id_rsa.pub`, copy all contents and paste into the textbox under "Add SSH Public Key" in the https://review.coreboot.org webpage. -## Part 2b: Setting up an HTTP Password +## Step 2b: Set up an HTTP Password Alternatively, instead of using SSH keys, you can use an HTTP password. To do so, after you select your name and click on **Settings** on the left-hand side, rather @@ -72,7 +72,7 @@ If that still doesn't allow you to pull or push changes to the server, the proxy is likely tampering with the data stream, in which case there's nothing we can do. -## Part 3: Clone coreboot and configure it for submitting patches +## Step 3: Clone coreboot and configure it for submitting patches On Gerrit, click on the **Browse** tab in the upper left corner and select **Repositories**. From the listing, select the "coreboot" repo. You may have @@ -101,7 +101,7 @@ and other configurations. cd coreboot make gitconfig -## Part 4: Submit a commit +## Step 4: Submit a commit An easy first commit to make is fixing existing checkpatch errors and warnings in the source files. To see errors that are already present, build the files in @@ -119,9 +119,9 @@ and can be submitted for review. Once you finish making your desired changes, use the command line to stage and submit your changes. An alternative and potentially easier way to stage and submit commits is to use git cola, a graphical user interface for git. For -instructions on how to do so, skip to Part 4b. +instructions on how to do so, skip to Step 4b. -## Part 4a: Using the command line to stage and submit a commit +## Step 4a: Use the command line to stage and submit a commit To use the command line to stage a commit, run @@ -181,7 +181,7 @@ 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 +## Step 4b: Use git cola to stage and submit a commit If git cola is not installed on your machine, see <https://git-cola.github.io/downloads.html> for download instructions. @@ -242,7 +242,7 @@ explained in the extended description. When ready, select 'Commit' again. Once all errors have been satisfied and the commit succeeds, move to the command line and run `git push`. -## Part 5: Getting your commit reviewed +## Step 5: Let others review your commit Your commits can now be seen on review.coreboot.org if you select "Your" and click on "Changes" and can be reviewed by others. Your code will @@ -252,7 +252,7 @@ users may also give your commit +1. For a commit to be merged, it needs to receive a +2. **Note:** A +1 and a +1 does not make a +2. Only certain users can give a +2. -## Part 6 (optional): bash-git-prompt +## Step 6 (optional): bash-git-prompt To help make it easier to understand the state of the git repository without running `git status` or `git log`, there is a way to make the |