Re: [ptxdist] [PATCH 3/3] doc: Fix typos found by codespell

[Roland Hieber <rhi@pengutronix.de>]

On Tue, Mar 10, 2020 at 02:23:59PM +0100, Alexander Dahl wrote:
> Signed-off-by: Alexander Dahl <ada@thorsis.com>
> ---
>  doc/daily_work.inc          | 8 ++++----
>  doc/dev_manual.rst          | 4 ++--
>  doc/environment.rst         | 4 ++--
>  doc/including_bsp_doc.inc   | 4 ++--
>  doc/nfsroot.inc             | 2 +-
>  doc/ref_make_macros.inc     | 6 +++---
>  doc/ref_make_variables.inc  | 2 +-
>  doc/user_adapting.inc       | 2 +-
>  doc/user_manual.inc         | 2 +-
>  doc/user_manual_section.rst | 2 +-
>  10 files changed, 18 insertions(+), 18 deletions(-)

Oh well, all of those files need varying degrees of copy editing, but
for now this patch is an improvement.

Reviewed-by: Roland Hieber <rhi@pengutronix.de>

> diff --git a/doc/daily_work.inc b/doc/daily_work.inc
> index 14c4aabef..bb9f8af65 100644
> --- a/doc/daily_work.inc
> +++ b/doc/daily_work.inc
> @@ -391,7 +391,7 @@ command line parameters.
>      limit the system load to the given value.
>  
>  .. Important:: using ``-ji`` and ``-je`` can overload the system
> -  immediatley. These settings are very hard.
> +  immediately. These settings are very hard.
>  
>  A much softer setup is to just use the ``-j<number>`` parameter. This will run
>  up to ``<number>`` tasks at the same time which will be spread over everything
> @@ -982,7 +982,7 @@ to define what is to build, to install and to distribute.
>      in a sane way. Never add libraries to the \*_LDFLAGS variable. Always add
>      them to the \*_LIBADD variable (for a library) or \*_LDADD (for an executable)
>      instead. This is important because the autotools forward all these variable
> -    based parameters in a specifc order to the tools (compiler and linker).
> +    based parameters in a specific order to the tools (compiler and linker).
>  
>  **EXTRA_DIST**
>      Include here all files which must be part of the distribution and are not
> @@ -1300,7 +1300,7 @@ non-interactive user, e.g. a different application.
>  
>  .. _external_dependencies_variants:
>  
> -Controling Package Dependencies in more Detail
> +Controlling Package Dependencies in more Detail
>  ----------------------------------------------
>  
>  In section :ref:`external_dependencies` a simple method is shown how to define
> @@ -1370,7 +1370,7 @@ macro (refer :ref:`install_tree,reference`) uses the file permissions it finds
>  in the build machine's filesystem also for the target filesystem image. With
>  a different ``umask`` than ``0022`` at build-time this may fail badly at
>  run-time with strange erroneous behaviour (for example some daemons with
> -regular user permissions cannot acces their own configuration files).
> +regular user permissions cannot access their own configuration files).
>  
>  Read Only Filesystem
>  --------------------
> diff --git a/doc/dev_manual.rst b/doc/dev_manual.rst
> index 84dc486c7..50827b6a9 100644
> --- a/doc/dev_manual.rst
> +++ b/doc/dev_manual.rst
> @@ -1069,7 +1069,7 @@ enabled. To add these dependencies on demand, the menu file looks like:
>  
>      endif
>  
> -.. important:: Do not add these ``select`` statements to the correspondig menu entry.
> +.. important:: Do not add these ``select`` statements to the corresponding menu entry.
>    They must belong to the main menu entry of the package to ensure that
>    the calculation of the dependencies between the packages is done in a
>    correct manner.
> @@ -1255,7 +1255,7 @@ There can be various reasons why a package must be patched:
>  
>  -  or anything else (this case is the most common one)
>  
> -Ideally, those problems should be adressed in the original project,
> +Ideally, those problems should be addressed in the original project,
>  so any patches you add to your BSP or to PTXdist should also be submitted upstream.
>  The upstream project can often provide better feedback, they can integrate your
>  patch into a new release, and also maintain your changes as part of the project.
> diff --git a/doc/environment.rst b/doc/environment.rst
> index f4994f644..18aecec4e 100644
> --- a/doc/environment.rst
> +++ b/doc/environment.rst
> @@ -177,7 +177,7 @@ One of the most important tasks for the ``configure`` script is to find
>  out whether all the programs PTXdist depends on are already present on the
>  development host. The script will stop with an error message in case
>  something is missing. If this happens, the missing tools have to be
> -installed from the distribution befor re-running the ``configure``
> +installed from the distribution before re-running the ``configure``
>  script.
>  
>  When the ``configure`` script is finished successfully, we can now run
> @@ -562,7 +562,7 @@ This step is only relevant for older toolchain version including
>  OSELAS.Toolchain-2018.12.0. For later versions, see the next section.
>  
>  All toolchain components are built with regular user permissions. In
> -order to avoid accidential changes in the toolchain, the files should be
> +order to avoid accidental changes in the toolchain, the files should be
>  set to read-only permissions after the installation has finished
>  successfully. It is also possible to set the file ownership to root.
>  This is an important step for reliability, so it is highly recommended.
> diff --git a/doc/including_bsp_doc.inc b/doc/including_bsp_doc.inc
> index cfccc45b4..775ad3397 100644
> --- a/doc/including_bsp_doc.inc
> +++ b/doc/including_bsp_doc.inc
> @@ -9,7 +9,7 @@ Requirements to build the Documentation
>  ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
>  
>  PTXdist can build its own user manual and supports HTML or PDF as the
> -output formats. PTXdist uses the *Sphinx* documentaion maker to build both
> +output formats. PTXdist uses the *Sphinx* documentation maker to build both
>  output formats. The host system itself must provide some tools and data:
>  
>  Fonts:
> @@ -98,7 +98,7 @@ content. These variables are filled with values extracted from the current PTXdi
>  project prior building the final documentation. Since PTXdist projects are bound
>  to a defined PTXdist version and toolchain version, this kind of information is
>  extracted from the current settings and substituted in the documentation. This
> -behaviour ensures the documentaiton includes the project's exact definition to
> +behaviour ensures the documentation includes the project's exact definition to
>  external dependencies.
>  
>  Refer the PTXdist file ``doc/conf.py`` for more information on variable
> diff --git a/doc/nfsroot.inc b/doc/nfsroot.inc
> index ee652edbf..71f652aff 100644
> --- a/doc/nfsroot.inc
> +++ b/doc/nfsroot.inc
> @@ -28,7 +28,7 @@ PTXdist feature, run inside the BSP at your development host:
>      [...]
>      Mount rootfs with nfsroot=/root,v3,tcp,port=2049,mountport=2049
>  
> -At the target side a slighly different configuration must be used to work with
> +At the target side a slightly different configuration must be used to work with
>  the userspace NFS server PTXdist provides instead of a regular kernel space
>  NFS server the Linux kernel provides. When starting PTXdist's ``nfsroot`` feature
>  it outputs the special command line we need to instruct the Linux kernel to
> diff --git a/doc/ref_make_macros.inc b/doc/ref_make_macros.inc
> index fb98d42db..b4e181a76 100644
> --- a/doc/ref_make_macros.inc
> +++ b/doc/ref_make_macros.inc
> @@ -110,7 +110,7 @@ and the directory to unpack to is taken from the ``<PKG>_DIR`` variable.
>  This macro doesn't do anything if ``<PKG>_URL`` points to a local directory
>  instead of an archive or online URL.
>  
> -The target directory is not removed, so ``extract`` can be used multipe
> +The target directory is not removed, so ``extract`` can be used multiple
>  times in a row to extract several archives. Usually :ref:`clean` is
>  called before the first ``extract``.
>  
> @@ -139,11 +139,11 @@ Usage:
>   $(call world/execute, <PKG>, <command with arguments>)
>  
>  These macros make it possible to execute arbitrary commands during the
> -build stages. This is usefull because the environment is identical to the
> +build stages. This is useful because the environment is identical to the
>  default build commands ``world/*``.
>  
>  ``world/execute`` also handles the generic setup handled in the current
> -build stage. For ``prepare`` this means that, for out ot tree builds, the
> +build stage. For ``prepare`` this means that, for out of tree builds, the
>  build directory is deleted prior to executing the specified command.
>  For ``install`` the package directory is deleted.
>  
> diff --git a/doc/ref_make_variables.inc b/doc/ref_make_variables.inc
> index fcfac83d3..b770b1b49 100644
> --- a/doc/ref_make_variables.inc
> +++ b/doc/ref_make_variables.inc
> @@ -118,7 +118,7 @@ Other useful variables:
>    In analogy to ``PACKAGES``, target packages that are added to these lists will
>    be built normally during the build run.
>    In contrast however, they are not installed into a root filesystem by default
> -  when building images, and image rules must request them explicitely.
> +  when building images, and image rules must request them explicitly.
>    This is useful for specialized packages that are only needed for specific
>    images, see :ref:`multi_image_individual_root_filesystems`.
>  
> diff --git a/doc/user_adapting.inc b/doc/user_adapting.inc
> index a0dbb3b49..fe99c4ae3 100644
> --- a/doc/user_adapting.inc
> +++ b/doc/user_adapting.inc
> @@ -49,7 +49,7 @@ highlight it and horizontally to select the *Help* entry. Then we can
>  press *Enter* to see the help.
>  
>  To search for specific keywords, we press the */* key and enter a word.
> -Kconfig then lists all occurences of this word in all menus.
> +Kconfig then lists all occurrences of this word in all menus.
>  
>  Meaning of visual feedbacks in Kconfig
>  ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
> diff --git a/doc/user_manual.inc b/doc/user_manual.inc
> index 0a4e4b34c..2adcd964c 100644
> --- a/doc/user_manual.inc
> +++ b/doc/user_manual.inc
> @@ -391,7 +391,7 @@ project.
>  
>  ``|ptxdistPlatformDir|/build-host``
>      Contains all packages sources compiled to run on the host and handle
> -    architecture independend things.
> +    architecture independent things.
>  
>  ``|ptxdistPlatformDir|/build-target``
>      Contains all package sources compiled for the target architecture.
> diff --git a/doc/user_manual_section.rst b/doc/user_manual_section.rst
> index ab93dd068..722b65f82 100644
> --- a/doc/user_manual_section.rst
> +++ b/doc/user_manual_section.rst
> @@ -3,7 +3,7 @@ PTXdist User’s Manual
>  
>  This chapter should give any newbie the information he/she needs to be
>  able to handle any embedded Linux projects based on PTXdist. Also the
> -advanced user may find new valueable information.
> +advanced user may find new valuable information.
>  
>  .. include:: user_manual.inc
>  .. include:: user_images.inc
> -- 
> 2.20.1
> 
> 
> _______________________________________________
> ptxdist mailing list
> ptxdist@pengutronix.de

-- 
Roland Hieber, Pengutronix e.K.          | r.hieber@pengutronix.de     |
Steuerwalder Str. 21                     | https://www.pengutronix.de/ |
31137 Hildesheim, Germany                | Phone: +49-5121-206917-0    |
Amtsgericht Hildesheim, HRA 2686         | Fax:   +49-5121-206917-5555 |

_______________________________________________
ptxdist mailing list
ptxdist@pengutronix.de