openwrt/flashrom
1
0
Fork 0
mirror of https://review.coreboot.org/flashrom.git synced 2025-04-27 15:12:36 +02:00
Code Issues Releases Wiki Activity

doc/dev_guide: Add section about Jenkins build, and scan-build

Browse Source 
Change-Id: I416b632c55d1ceb925456ac8c8947dfbcef2e888
Signed-off-by: Anastasia Klimchuk <aklm@flashrom.org>
Reviewed-on: https://review.coreboot.org/c/flashrom/+/81261
Reviewed-by: Stefan Reinauer <stefan.reinauer@coreboot.org>
Tested-by: build bot (Jenkins) <no-reply@coreboot.org>
Reviewed-by: Peter Marheine <pmarheine@chromium.org>
This commit is contained in:
Anastasia Klimchuk 2024-03-15 23:36:25 +11:00 committed by Anastasia Klimchuk
parent b65f347377
commit 435309ea28
1 changed files with 17 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
doc/dev_guide/development_guide.rst
View File

@ -191,6 +191,8 @@ Creating an account
Pushing a patch Pushing a patch
--------------- ---------------
Before pushing a patch, make sure it builds on your environment and all unit tests pass (see :doc:`building_from_source`).
To push patch to Gerrit, use the follow command: :code:`git push upstream HEAD:refs/for/main`. To push patch to Gerrit, use the follow command: :code:`git push upstream HEAD:refs/for/main`.
* If using HTTPS you will be prompted for the username and password you * If using HTTPS you will be prompted for the username and password you
@ -209,6 +211,21 @@ To add a topic, push with the command: :code:`git push upstream HEAD:refs/for/ma
Alternatively, you can add a topic from a Gerrit UI after the patch in pushed Alternatively, you can add a topic from a Gerrit UI after the patch in pushed
(on the top-left section) of patch UI. (on the top-left section) of patch UI.
Checking the CI
---------------
Every patch needs to get a ``Verified +1`` label, typically from Jenkins. Once the patch is pushed
to Gerrit, Jenkins is added automatically and runs its build script. The script builds the patch with
various config options, and runs unit tests (for more details see source code of ``test_build.sh``).
Then, Jenkins gives the patch ``+1`` or ``-1`` vote, indicating success or fail.
In case of failure, follow Jenkins link (which it adds as a comment to the patch), open Console output,
find the error and try to fix it.
In addition to building and running unit tests, Jenkins also runs a scan-build over the patch. Ideally
you should check that your patch does not introduce new warnings. To see scan-build report, follow
Jenkins link -> Build artifacts -> scan build link for the given run.
Adding reviewers to the patch Adding reviewers to the patch
----------------------------- -----------------------------