diff options
| -rw-r--r-- | README.md | 14 | ||||
| -rw-r--r-- | SUBMITTING_PATCHES.md (renamed from SUBMITTING_PATCHES) | 28 |
2 files changed, 28 insertions, 14 deletions
diff --git a/README.md b/README.md new file mode 100644 index 00000000..e35f8e99 --- /dev/null +++ b/README.md | |||
| @@ -0,0 +1,14 @@ | |||
| 1 | # repo | ||
| 2 | |||
| 3 | Repo is a tool built on top of Git. Repo helps manage many Git repositories, | ||
| 4 | does the uploads to revision control systems, and automates parts of the | ||
| 5 | development workflow. Repo is not meant to replace Git, only to make it | ||
| 6 | easier to work with Git. The repo command is an executable Python script | ||
| 7 | that you can put anywhere in your path. | ||
| 8 | |||
| 9 | * Homepage: https://code.google.com/p/git-repo/ | ||
| 10 | * Bug reports: https://code.google.com/p/git-repo/issues/ | ||
| 11 | * Source: https://code.google.com/p/git-repo/ | ||
| 12 | * Overview: https://source.android.com/source/developing.html | ||
| 13 | * Docs: https://source.android.com/source/using-repo.html | ||
| 14 | * [Submitting patches](./SUBMITTING_PATCHES.md) | ||
diff --git a/SUBMITTING_PATCHES b/SUBMITTING_PATCHES.md index 8656ee7d..085ae06a 100644 --- a/SUBMITTING_PATCHES +++ b/SUBMITTING_PATCHES.md | |||
| @@ -1,4 +1,4 @@ | |||
| 1 | Short Version: | 1 | # Short Version |
| 2 | 2 | ||
| 3 | - Make small logical changes. | 3 | - Make small logical changes. |
| 4 | - Provide a meaningful commit message. | 4 | - Provide a meaningful commit message. |
| @@ -8,10 +8,10 @@ Short Version: | |||
| 8 | - Make corrections if requested. | 8 | - Make corrections if requested. |
| 9 | - Verify your changes on gerrit so they can be submitted. | 9 | - Verify your changes on gerrit so they can be submitted. |
| 10 | 10 | ||
| 11 | git push https://gerrit-review.googlesource.com/git-repo HEAD:refs/for/master | 11 | `git push https://gerrit-review.googlesource.com/git-repo HEAD:refs/for/master` |
| 12 | 12 | ||
| 13 | 13 | ||
| 14 | Long Version: | 14 | # Long Version |
| 15 | 15 | ||
| 16 | I wanted a file describing how to submit patches for repo, | 16 | I wanted a file describing how to submit patches for repo, |
| 17 | so I started with the one found in the core Git distribution | 17 | so I started with the one found in the core Git distribution |
| @@ -19,10 +19,10 @@ so I started with the one found in the core Git distribution | |||
| 19 | patch submission guidelines for the Linux kernel. | 19 | patch submission guidelines for the Linux kernel. |
| 20 | 20 | ||
| 21 | However there are some differences, so please review and familiarize | 21 | However there are some differences, so please review and familiarize |
| 22 | yourself with the following relevant bits: | 22 | yourself with the following relevant bits. |
| 23 | 23 | ||
| 24 | 24 | ||
| 25 | (1) Make separate commits for logically separate changes. | 25 | ## Make separate commits for logically separate changes. |
| 26 | 26 | ||
| 27 | Unless your patch is really trivial, you should not be sending | 27 | Unless your patch is really trivial, you should not be sending |
| 28 | out a patch that was generated between your working tree and your | 28 | out a patch that was generated between your working tree and your |
| @@ -36,14 +36,14 @@ If your description starts to get too long, that's a sign that you | |||
| 36 | probably need to split up your commit to finer grained pieces. | 36 | probably need to split up your commit to finer grained pieces. |
| 37 | 37 | ||
| 38 | 38 | ||
| 39 | (2) Check for coding errors with pylint | 39 | ## Check for coding errors with pylint |
| 40 | 40 | ||
| 41 | Run pylint on changed modules using the provided configuration: | 41 | Run pylint on changed modules using the provided configuration: |
| 42 | 42 | ||
| 43 | pylint --rcfile=.pylintrc file.py | 43 | pylint --rcfile=.pylintrc file.py |
| 44 | 44 | ||
| 45 | 45 | ||
| 46 | (3) Check the license | 46 | ## Check the license |
| 47 | 47 | ||
| 48 | repo is licensed under the Apache License, 2.0. | 48 | repo is licensed under the Apache License, 2.0. |
| 49 | 49 | ||
| @@ -59,7 +59,7 @@ your patch. It is virtually impossible to remove a patch once it | |||
| 59 | has been applied and pushed out. | 59 | has been applied and pushed out. |
| 60 | 60 | ||
| 61 | 61 | ||
| 62 | (4) Sending your patches. | 62 | ## Sending your patches. |
| 63 | 63 | ||
| 64 | Do not email your patches to anyone. | 64 | Do not email your patches to anyone. |
| 65 | 65 | ||
| @@ -91,23 +91,23 @@ to get the ChangeId added. | |||
| 91 | Push your patches over HTTPS to the review server, possibly through | 91 | Push your patches over HTTPS to the review server, possibly through |
| 92 | a remembered remote to make this easier in the future: | 92 | a remembered remote to make this easier in the future: |
| 93 | 93 | ||
| 94 | git config remote.review.url https://gerrit-review.googlesource.com/git-repo | 94 | git config remote.review.url https://gerrit-review.googlesource.com/git-repo |
| 95 | git config remote.review.push HEAD:refs/for/master | 95 | git config remote.review.push HEAD:refs/for/master |
| 96 | 96 | ||
| 97 | git push review | 97 | git push review |
| 98 | 98 | ||
| 99 | You will be automatically emailed a copy of your commits, and any | 99 | You will be automatically emailed a copy of your commits, and any |
| 100 | comments made by the project maintainers. | 100 | comments made by the project maintainers. |
| 101 | 101 | ||
| 102 | 102 | ||
| 103 | (5) Make changes if requested | 103 | ## Make changes if requested |
| 104 | 104 | ||
| 105 | The project maintainer who reviews your changes might request changes to your | 105 | The project maintainer who reviews your changes might request changes to your |
| 106 | commit. If you make the requested changes you will need to amend your commit | 106 | commit. If you make the requested changes you will need to amend your commit |
| 107 | and push it to the review server again. | 107 | and push it to the review server again. |
| 108 | 108 | ||
| 109 | 109 | ||
| 110 | (6) Verify your changes on gerrit | 110 | ## Verify your changes on gerrit |
| 111 | 111 | ||
| 112 | After you receive a Code-Review+2 from the maintainer, select the Verified | 112 | After you receive a Code-Review+2 from the maintainer, select the Verified |
| 113 | button on the gerrit page for the change. This verifies that you have tested | 113 | button on the gerrit page for the change. This verifies that you have tested |
