From b87ae174147ef57f3bb0d64df234ed1e86680d1b Mon Sep 17 00:00:00 2001 From: Robert Eckelmann <longnoserob@postmarketos.org> Date: Tue, 17 Dec 2024 20:59:35 +0900 Subject: [PATCH] docs: fix typos (MR 2510) this fixes the typos found in #2524 Signed-off-by: Robert Eckelmann <longnoserob@postmarketos.org> --- README.md | 2 +- docs/api/modules.rst | 4 ++-- docs/conf.py | 2 +- docs/index.rst | 2 +- docs/usage.rst | 2 +- pmb/helpers/exceptions.py | 2 +- 6 files changed, 7 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index ca93b6537..66ca69f76 100644 --- a/README.md +++ b/README.md @@ -48,7 +48,7 @@ can run `$ pmbootstrap pull`. The latest pmbootstrap version works with currently [active postmarketOS releases](https://wiki.postmarketos.org/wiki/Releases). -Attempting to use pmboostrap with old postmarketOS versions (old pmaports +Attempting to use pmbootstrap with old postmarketOS versions (old pmaports branches) may result in failures and is not supported. See `pmbootstrap_min_version` in [pmaports.cfg](https://wiki.postmarketos.org/wiki/Pmaports.cfg_reference) for diff --git a/docs/api/modules.rst b/docs/api/modules.rst index 01e66a783..c86cbfddb 100644 --- a/docs/api/modules.rst +++ b/docs/api/modules.rst @@ -1,5 +1,5 @@ -pmboostrap code documentation -============================= +pmbootstrap code documentation +============================== .. note:: This is the internal API, not a public one. diff --git a/docs/conf.py b/docs/conf.py index e9931c46d..c4c306074 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -55,7 +55,7 @@ html_theme_options: dict[str, Any] = { } # Output file base name for HTML help builder. -htmlhelp_basename = "pmboostrapdoc" +htmlhelp_basename = "pmbootstrapdoc" html_theme_options = { "display_version": True, diff --git a/docs/index.rst b/docs/index.rst index a9cede2a6..80a6f2126 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -1,7 +1,7 @@ Welcome to pmbootstrap's documentation! ======================================= -pmboostrap is the central command-line application for postmarketOS development. Among other things, +pmbootstrap is the central command-line application for postmarketOS development. Among other things, it allows building packages, creating installation images and flashing themx to your device. If you just want to install postmarketOS, read the `Installation`_ wiki article first since you might not need pmbootstrap depeing on the method. diff --git a/docs/usage.rst b/docs/usage.rst index caa44fba8..7ac7d218d 100644 --- a/docs/usage.rst +++ b/docs/usage.rst @@ -10,7 +10,7 @@ Before pmbootstrap can be used, a number of configuration questions need to be a .. code-block:: shell - $ pmboostrap init + $ pmbootstrap init If you already ran this before, run the following to update your local clone of pmaports.git instead, before moving straight onto the installation step: diff --git a/pmb/helpers/exceptions.py b/pmb/helpers/exceptions.py index 35980494a..7ad543116 100644 --- a/pmb/helpers/exceptions.py +++ b/pmb/helpers/exceptions.py @@ -12,7 +12,7 @@ class BuildFailedError(Exception): class NonBugError(Exception): """Exception which originates from a problem not caused by pmbootstrap's code. This - could for example be raised if there is an error in a package pmboostrap is + could for example be raised if there is an error in a package pmbootstrap is interacting with in some way.""" pass -- GitLab