| Message ID | 20240731195713.773489-1-jan.vermaete@gmail.com |
|---|---|
| State | Accepted |
| Headers | show |
| Series | doc: code formatting was not rendered correct | expand |
On 31.07.24 21:57, Jan Vermaete wrote: > Signed-off-by: Jan Vermaete <jan.vermaete@gmail.com> > --- > doc/source/signed_images.rst | 8 ++++++++ > 1 file changed, 8 insertions(+) > > diff --git a/doc/source/signed_images.rst b/doc/source/signed_images.rst > index 3010776a..88cb97de 100644 > --- a/doc/source/signed_images.rst > +++ b/doc/source/signed_images.rst > @@ -172,11 +172,13 @@ Generating a new keypair > First, a primary keypair needs to be generated > > :: > + > gpg --gen-key > > The generated keys can be listed as follows > > :: > + > gpg -k > > Check the documentation for more information about parameters. > @@ -187,6 +189,7 @@ How to sign with gpg > Signing the image is very simple: > > :: > + > gpg --batch --output sw-description.sig > --detach-sig sw-description > > @@ -195,6 +198,7 @@ the following can be used to specify. In this example, the GnuPG home directory > is in GPG_HOMEDIR, while the signing key is found in GPG_KEY. > > :: > + > gpg --batch --homedir "${GPG_HOMEDIR}" --default-key "${GPG_KEY}" --output sw-description.sig > --detach-sig sw-description > > @@ -286,20 +290,24 @@ need to be imported to the device's GnuPG home directory. To do this, the > key will need to be exported: > > :: > + > gpg --export <keyid> --output <public key> > > You can then copy it onto the device and import it into your public keyring: > > :: > + > gpg --import <public key> > > To verify that the key has been imported successfully: > > :: > + > gpg --list-keys > > SWUpdate will need need to be configured with the following parameters: > > :: > + > GnuPG Home directory: gpg-home-dir in swupdate.cfg > GPGME Protocol: gpgme-protocol in swupdate.cfg: openpgp or cms Thanks for fixing it. Reviewed-by: Stefano Babic <stefano.babic@swupdate.org>
diff --git a/doc/source/signed_images.rst b/doc/source/signed_images.rst index 3010776a..88cb97de 100644 --- a/doc/source/signed_images.rst +++ b/doc/source/signed_images.rst @@ -172,11 +172,13 @@ Generating a new keypair First, a primary keypair needs to be generated :: + gpg --gen-key The generated keys can be listed as follows :: + gpg -k Check the documentation for more information about parameters. @@ -187,6 +189,7 @@ How to sign with gpg Signing the image is very simple: :: + gpg --batch --output sw-description.sig --detach-sig sw-description @@ -195,6 +198,7 @@ the following can be used to specify. In this example, the GnuPG home directory is in GPG_HOMEDIR, while the signing key is found in GPG_KEY. :: + gpg --batch --homedir "${GPG_HOMEDIR}" --default-key "${GPG_KEY}" --output sw-description.sig --detach-sig sw-description @@ -286,20 +290,24 @@ need to be imported to the device's GnuPG home directory. To do this, the key will need to be exported: :: + gpg --export <keyid> --output <public key> You can then copy it onto the device and import it into your public keyring: :: + gpg --import <public key> To verify that the key has been imported successfully: :: + gpg --list-keys SWUpdate will need need to be configured with the following parameters: :: + GnuPG Home directory: gpg-home-dir in swupdate.cfg GPGME Protocol: gpgme-protocol in swupdate.cfg: openpgp or cms
Signed-off-by: Jan Vermaete <jan.vermaete@gmail.com> --- doc/source/signed_images.rst | 8 ++++++++ 1 file changed, 8 insertions(+)