diff options
| author | Konstantin Ryabitsev <konstantin@linuxfoundation.org> | 2022-09-15 15:54:29 -0400 |
|---|---|---|
| committer | Konstantin Ryabitsev <konstantin@linuxfoundation.org> | 2022-09-15 15:54:29 -0400 |
| commit | e1619ff516ac0a873ad41ee32d125566041fd8ee (patch) | |
| tree | 8acc6a92cadf8a96f92d907a739cc9ee06ff7dfa | |
| parent | 5d3d1b88466c7ed1f581f4c5384692a27e7524ba (diff) | |
| download | b4-e1619ff516ac0a873ad41ee32d125566041fd8ee.tar.gz | |
README: link to online documentation
Remove outdated sections and link to online documentation at
b4.docs.kernel.org.
Signed-off-by: Konstantin Ryabitsev <konstantin@linuxfoundation.org>
| -rw-r--r-- | README.rst | 41 |
1 files changed, 1 insertions, 40 deletions
@@ -8,7 +8,7 @@ the Linux kernel development. The name "b4" was chosen for ease of typing and because B-4 was the precursor to Lore and Data in the Star Trek universe. -See man/b4.5.rst for more information. +See https://b4.docs.kernel.org/ for online documentation. Installing ---------- @@ -36,45 +36,6 @@ dependencies that are tracked via submodules:: git submodule update --init -Patch attestation ------------------ -B4 implements two attestation verification mechanisms: - -- DKIM attestation using the dkimpy library -- X-Developer-Signature attestation using the patatt library - -If you installed from pip, you should have pulled both of these -dependencies in automatically. Alternatively, you can install dkimpy -from your OS packaging and then run "git submodule update --init" to -clone patatt as a submodule of b4. - -For attesting your outgoing patches, see patatt documentation. -https://git.kernel.org/pub/scm/utils/patatt/patatt.git/about/ - -Display attestation results on received patches -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -There are four attestation verification modes in b4: - -- off -- check -- softfail (default) -- hardfail - -The "check" policy is look for any available attestation and try to -verify it. If verification fails, b4 will not output any errors, but -will not show verification checkmarks either. - -In the "softfail" mode, any verification errors will be prominently -displayed, but b4 will still produce the resulting file with patches. - -The "hardfail" mode will show verification errors and exit without -generating the .mbx file with patches. - -You can set the preferred policy via the git configuration file:: - - [b4] - attestation-policy = hardfail - Support ------- For support or with any other questions, please email |