Message ID | 20181214123936.11940-1-christian.storm@siemens.com |
---|---|
State | Accepted |
Headers | show |
Series | doc: fix some spelling errors | expand |
On 14/12/18 13:39, Christian Storm wrote: > Fix some random spelling errors throughout > the documentation. > > Signed-off-by: Christian Storm <christian.storm@siemens.com> > --- > doc/source/building-with-yocto.rst | 4 ++-- > doc/source/contributing.rst | 2 +- > doc/source/mongoose.rst | 2 +- > doc/source/roadmap.rst | 6 +++--- > doc/source/signed_images.rst | 6 +++--- > doc/source/suricatta.rst | 2 +- > doc/source/sw-description.rst | 6 +++--- > doc/source/swupdate.rst | 2 +- > 8 files changed, 15 insertions(+), 15 deletions(-) > > diff --git a/doc/source/building-with-yocto.rst b/doc/source/building-with-yocto.rst > index 2064047..b20698b 100644 > --- a/doc/source/building-with-yocto.rst > +++ b/doc/source/building-with-yocto.rst > @@ -39,7 +39,7 @@ generating the SWU. The class defines new variables, all of them have the prefix > - **SWUPDATE_IMAGES_FSTYPES** : extension of the artifact. Each artifact can > have multiple extension according to the IMAGE_FSTYPES variable. > For example, an image can be generated as tarball and as UBIFS for target. > - Setting the variable for each artifact telles the class which file must > + Setting the variable for each artifact tells the class which file must > be packed into the SWU image. > > > @@ -50,7 +50,7 @@ generating the SWU. The class defines new variables, all of them have the prefix > - **SWUPDATE_IMAGES_NOAPPEND_MACHINE** : flag to use drop the machine name from the > artifact file. Most images in *deploy* have the name of the Yocto's machine in the > filename. The class adds automatically the name of the MACHINE to the file, but some > - artifacts can be deploes without it. > + artifacts can be deployed without it. > > :: > > diff --git a/doc/source/contributing.rst b/doc/source/contributing.rst > index 9c64f3c..7ab5574 100644 > --- a/doc/source/contributing.rst > +++ b/doc/source/contributing.rst > @@ -6,7 +6,7 @@ Contributions are welcome ! Please follow the following guideline for contributi > Contribution Checklist > ---------------------- > > -These are mostly general recommendations and are common practise in a lot of > +These are mostly general recommendations and are common practice in a lot of > FOSS projects. > > - use git to manage your changes [*recomended*] > diff --git a/doc/source/mongoose.rst b/doc/source/mongoose.rst > index 324264a..c9ed47e 100644 > --- a/doc/source/mongoose.rst > +++ b/doc/source/mongoose.rst > @@ -74,7 +74,7 @@ style sheet changes need a rebuild of the web application source code. > Develop > ------- > > -The development requires Node.js version 6 or greater and a prebuild > +The development requires Node.js version 6 or greater and a prebuilt > SWUpdate project with enabled mongoose web server and web application > interface version 2 support. > > diff --git a/doc/source/roadmap.rst b/doc/source/roadmap.rst > index 023e229..ae9228a 100644 > --- a/doc/source/roadmap.rst > +++ b/doc/source/roadmap.rst > @@ -56,7 +56,7 @@ each of them solves a specific use case for a delta update. > Integration in Linux distro > =========================== > > -To allow an easer leraning with SWUpdate and also for test purposes with the > +To allow an easier learning with SWUpdate and also for test purposes with the > SWU forwarder handler, it makes sense to package SWUpdate for PC Linux distro. > SWUpdate already supports debian package. Some help from community is asked to > let the package merged into Debian distro. > @@ -70,7 +70,7 @@ New Handlers > Users develop own custom handlers - I just enforce and encourage everyone > to send them and discuss how to integrate custom handler in mainline. > > -A handler to update a microntroller connected via UART is introduced. > +A handler to update a microcontroller connected via UART is introduced. > It could be enhanced to support other interfaces (SPI for example). > > Some ideas for new handlers: > @@ -137,7 +137,7 @@ Backend: support for Mender > --------------------------- > > There was several discussion how to make a stronger collaboration between > -different update solution and a proposal discussed prevviously is to use SWUpdate as client > +different update solution and a proposal discussed previously is to use SWUpdate as client > to upgrade from a Mender server, see `BOF at ELCE 2017 <https://elinux.org/images/0/0c/BoF_secure_ota_linux.pdf>`_ > > Support for multiple Servers simultaneously > diff --git a/doc/source/signed_images.rst b/doc/source/signed_images.rst > index a4c0b8e..5b0b01d 100644 > --- a/doc/source/signed_images.rst > +++ b/doc/source/signed_images.rst > @@ -47,7 +47,7 @@ Choice of algorithm > The algorithm chosen to sign and verify the sw-descrription file can be > selected via menuconfig. Currently, the following mechanisms are implemented: > > -- RSA Public / private key. The private key belongs to thebuildsystem, > +- RSA Public / private key. The private key belongs to the build system, > while the public key must be installed on the target. > - CMS using certificates > > @@ -74,7 +74,7 @@ First, the private key must be created: > openssl genrsa -aes256 -out priv.pem > > This asks for a passphrase. It is possible to retrieve > -the passhphrase from a file - of course, this must be > +the passphrase from a file - of course, this must be > protected against intrusion. > > :: > @@ -132,7 +132,7 @@ requires the following attributes to be set on the signing certificate: > keyUsage=digitalSignature > extendedKeyUsage=emailProtection > > -It is also possible to completelly disable signing certificate key usage > +It is also possible to completely disable signing certificate key usage > checking if this requirement cannot be satisfied. This is controlled by > `CONFIG_CMS_IGNORE_CERTIFICATE_PURPOSE` configuration option. > > diff --git a/doc/source/suricatta.rst b/doc/source/suricatta.rst > index fc4d1de..fb7df23 100644 > --- a/doc/source/suricatta.rst > +++ b/doc/source/suricatta.rst > @@ -164,7 +164,7 @@ The query string has the format: > http(s)://<base URL>?param1=val1¶m2=value2... > > As examples for parameters, the device can send its serial number, MAC address and the running version of the software. > -It is duty of the backend to interprete this - SWUpdate just takes them from the "identity" section of > +It is duty of the backend to interpret this - SWUpdate just takes them from the "identity" section of > the configuration file and encodes the URL. > > The server answers with the following return codes: > diff --git a/doc/source/sw-description.rst b/doc/source/sw-description.rst > index 0db4bea..c847d14 100644 > --- a/doc/source/sw-description.rst > +++ b/doc/source/sw-description.rst > @@ -254,7 +254,7 @@ is responsible for calling `SWUpdate` passing proper settings. > Priority finding the elements in the file > ----------------------------------------- > > -SWUpdate search for entries in the sdw-description file according to the following priority: > +SWUpdate search for entries in the sw-description file according to the following priority: > > 1. Try <boardname>.<selection>.<mode>.<entry> > 2. Try <selection>.<mode>.<entry> > @@ -311,8 +311,8 @@ Take an example. The following sw-description describes the release for a set of > } > > On *myboard*, SWUpdate searches and find myboard.stable.copy1(2). When running on different > -boards, SWUpdate does not find an enty corresponding to the boardname and it fallbacks to the > -version without boardname. This lets relalize the same release for different boards having > +boards, SWUpdate does not find an entry corresponding to the boardname and it fallbacks to the > +version without boardname. This lets realize the same release for different boards having > a complete different hardware. `myboard` could have a eMMC and an ext4 filesystem, > while another device can have raw flash and install an UBI filesystem. Nevertheless, they are > both just a different format of the same release and they could be described together in sw-description. > diff --git a/doc/source/swupdate.rst b/doc/source/swupdate.rst > index 7bbfd28..9e36924 100644 > --- a/doc/source/swupdate.rst > +++ b/doc/source/swupdate.rst > @@ -505,7 +505,7 @@ Command line parameters > | | | software. This will be checked with the | > | | | version of new software and forbids | > | | | downgrading. | > -| | | Version mconsists of 4 number: | > +| | | Version consists of 4 number: | > | | | major.minor.rev.build | > | | | each field is in the range 0..65535 | > +-------------+----------+--------------------------------------------+ > Applied to -master, thanks ! Best regards, Stefano Babic
Hi Stefano, > On 14/12/18 13:39, Christian Storm wrote: > > Fix some random spelling errors throughout > > the documentation. > > > > Signed-off-by: Christian Storm <christian.storm@siemens.com> > > --- > > doc/source/building-with-yocto.rst | 4 ++-- > > doc/source/contributing.rst | 2 +- > > doc/source/mongoose.rst | 2 +- > > doc/source/roadmap.rst | 6 +++--- > > doc/source/signed_images.rst | 6 +++--- > > doc/source/suricatta.rst | 2 +- > > doc/source/sw-description.rst | 6 +++--- > > doc/source/swupdate.rst | 2 +- > > 8 files changed, 15 insertions(+), 15 deletions(-) > > > > [...] > > Applied to -master, thanks ! This patch doesn't seem to have made it through? At least I can't see it in my latest git fetch... Kind regards, Christian
Hi Christian, On 28/01/19 08:55, Christian Storm wrote: > Hi Stefano, > >> On 14/12/18 13:39, Christian Storm wrote: >>> Fix some random spelling errors throughout >>> the documentation. >>> >>> Signed-off-by: Christian Storm <christian.storm@siemens.com> >>> --- >>> doc/source/building-with-yocto.rst | 4 ++-- >>> doc/source/contributing.rst | 2 +- >>> doc/source/mongoose.rst | 2 +- >>> doc/source/roadmap.rst | 6 +++--- >>> doc/source/signed_images.rst | 6 +++--- >>> doc/source/suricatta.rst | 2 +- >>> doc/source/sw-description.rst | 6 +++--- >>> doc/source/swupdate.rst | 2 +- >>> 8 files changed, 15 insertions(+), 15 deletions(-) >>> >>> [...] >> >> Applied to -master, thanks ! > > This patch doesn't seem to have made it through? At least I can't see > it in my latest git fetch... > Weird, I had set the status on patchwork to "Accepted" - I check the issue and I merge it if not in tree, thanks for checking this. Best regards, Stefano
diff --git a/doc/source/building-with-yocto.rst b/doc/source/building-with-yocto.rst index 2064047..b20698b 100644 --- a/doc/source/building-with-yocto.rst +++ b/doc/source/building-with-yocto.rst @@ -39,7 +39,7 @@ generating the SWU. The class defines new variables, all of them have the prefix - **SWUPDATE_IMAGES_FSTYPES** : extension of the artifact. Each artifact can have multiple extension according to the IMAGE_FSTYPES variable. For example, an image can be generated as tarball and as UBIFS for target. - Setting the variable for each artifact telles the class which file must + Setting the variable for each artifact tells the class which file must be packed into the SWU image. @@ -50,7 +50,7 @@ generating the SWU. The class defines new variables, all of them have the prefix - **SWUPDATE_IMAGES_NOAPPEND_MACHINE** : flag to use drop the machine name from the artifact file. Most images in *deploy* have the name of the Yocto's machine in the filename. The class adds automatically the name of the MACHINE to the file, but some - artifacts can be deploes without it. + artifacts can be deployed without it. :: diff --git a/doc/source/contributing.rst b/doc/source/contributing.rst index 9c64f3c..7ab5574 100644 --- a/doc/source/contributing.rst +++ b/doc/source/contributing.rst @@ -6,7 +6,7 @@ Contributions are welcome ! Please follow the following guideline for contributi Contribution Checklist ---------------------- -These are mostly general recommendations and are common practise in a lot of +These are mostly general recommendations and are common practice in a lot of FOSS projects. - use git to manage your changes [*recomended*] diff --git a/doc/source/mongoose.rst b/doc/source/mongoose.rst index 324264a..c9ed47e 100644 --- a/doc/source/mongoose.rst +++ b/doc/source/mongoose.rst @@ -74,7 +74,7 @@ style sheet changes need a rebuild of the web application source code. Develop ------- -The development requires Node.js version 6 or greater and a prebuild +The development requires Node.js version 6 or greater and a prebuilt SWUpdate project with enabled mongoose web server and web application interface version 2 support. diff --git a/doc/source/roadmap.rst b/doc/source/roadmap.rst index 023e229..ae9228a 100644 --- a/doc/source/roadmap.rst +++ b/doc/source/roadmap.rst @@ -56,7 +56,7 @@ each of them solves a specific use case for a delta update. Integration in Linux distro =========================== -To allow an easer leraning with SWUpdate and also for test purposes with the +To allow an easier learning with SWUpdate and also for test purposes with the SWU forwarder handler, it makes sense to package SWUpdate for PC Linux distro. SWUpdate already supports debian package. Some help from community is asked to let the package merged into Debian distro. @@ -70,7 +70,7 @@ New Handlers Users develop own custom handlers - I just enforce and encourage everyone to send them and discuss how to integrate custom handler in mainline. -A handler to update a microntroller connected via UART is introduced. +A handler to update a microcontroller connected via UART is introduced. It could be enhanced to support other interfaces (SPI for example). Some ideas for new handlers: @@ -137,7 +137,7 @@ Backend: support for Mender --------------------------- There was several discussion how to make a stronger collaboration between -different update solution and a proposal discussed prevviously is to use SWUpdate as client +different update solution and a proposal discussed previously is to use SWUpdate as client to upgrade from a Mender server, see `BOF at ELCE 2017 <https://elinux.org/images/0/0c/BoF_secure_ota_linux.pdf>`_ Support for multiple Servers simultaneously diff --git a/doc/source/signed_images.rst b/doc/source/signed_images.rst index a4c0b8e..5b0b01d 100644 --- a/doc/source/signed_images.rst +++ b/doc/source/signed_images.rst @@ -47,7 +47,7 @@ Choice of algorithm The algorithm chosen to sign and verify the sw-descrription file can be selected via menuconfig. Currently, the following mechanisms are implemented: -- RSA Public / private key. The private key belongs to thebuildsystem, +- RSA Public / private key. The private key belongs to the build system, while the public key must be installed on the target. - CMS using certificates @@ -74,7 +74,7 @@ First, the private key must be created: openssl genrsa -aes256 -out priv.pem This asks for a passphrase. It is possible to retrieve -the passhphrase from a file - of course, this must be +the passphrase from a file - of course, this must be protected against intrusion. :: @@ -132,7 +132,7 @@ requires the following attributes to be set on the signing certificate: keyUsage=digitalSignature extendedKeyUsage=emailProtection -It is also possible to completelly disable signing certificate key usage +It is also possible to completely disable signing certificate key usage checking if this requirement cannot be satisfied. This is controlled by `CONFIG_CMS_IGNORE_CERTIFICATE_PURPOSE` configuration option. diff --git a/doc/source/suricatta.rst b/doc/source/suricatta.rst index fc4d1de..fb7df23 100644 --- a/doc/source/suricatta.rst +++ b/doc/source/suricatta.rst @@ -164,7 +164,7 @@ The query string has the format: http(s)://<base URL>?param1=val1¶m2=value2... As examples for parameters, the device can send its serial number, MAC address and the running version of the software. -It is duty of the backend to interprete this - SWUpdate just takes them from the "identity" section of +It is duty of the backend to interpret this - SWUpdate just takes them from the "identity" section of the configuration file and encodes the URL. The server answers with the following return codes: diff --git a/doc/source/sw-description.rst b/doc/source/sw-description.rst index 0db4bea..c847d14 100644 --- a/doc/source/sw-description.rst +++ b/doc/source/sw-description.rst @@ -254,7 +254,7 @@ is responsible for calling `SWUpdate` passing proper settings. Priority finding the elements in the file ----------------------------------------- -SWUpdate search for entries in the sdw-description file according to the following priority: +SWUpdate search for entries in the sw-description file according to the following priority: 1. Try <boardname>.<selection>.<mode>.<entry> 2. Try <selection>.<mode>.<entry> @@ -311,8 +311,8 @@ Take an example. The following sw-description describes the release for a set of } On *myboard*, SWUpdate searches and find myboard.stable.copy1(2). When running on different -boards, SWUpdate does not find an enty corresponding to the boardname and it fallbacks to the -version without boardname. This lets relalize the same release for different boards having +boards, SWUpdate does not find an entry corresponding to the boardname and it fallbacks to the +version without boardname. This lets realize the same release for different boards having a complete different hardware. `myboard` could have a eMMC and an ext4 filesystem, while another device can have raw flash and install an UBI filesystem. Nevertheless, they are both just a different format of the same release and they could be described together in sw-description. diff --git a/doc/source/swupdate.rst b/doc/source/swupdate.rst index 7bbfd28..9e36924 100644 --- a/doc/source/swupdate.rst +++ b/doc/source/swupdate.rst @@ -505,7 +505,7 @@ Command line parameters | | | software. This will be checked with the | | | | version of new software and forbids | | | | downgrading. | -| | | Version mconsists of 4 number: | +| | | Version consists of 4 number: | | | | major.minor.rev.build | | | | each field is in the range 0..65535 | +-------------+----------+--------------------------------------------+
Fix some random spelling errors throughout the documentation. Signed-off-by: Christian Storm <christian.storm@siemens.com> --- doc/source/building-with-yocto.rst | 4 ++-- doc/source/contributing.rst | 2 +- doc/source/mongoose.rst | 2 +- doc/source/roadmap.rst | 6 +++--- doc/source/signed_images.rst | 6 +++--- doc/source/suricatta.rst | 2 +- doc/source/sw-description.rst | 6 +++--- doc/source/swupdate.rst | 2 +- 8 files changed, 15 insertions(+), 15 deletions(-)