Send patches - preferably formatted by git format-patch - to patches at archlinux32 dot org.
summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
Diffstat (limited to 'docs')
-rw-r--r--docs/cli_parameters/config/config_options.csv8
-rw-r--r--docs/cli_parameters/config/disk_config.rst4
-rw-r--r--docs/examples/python.rst4
-rw-r--r--docs/help/known_issues.rst6
-rw-r--r--docs/installing/guided.rst4
5 files changed, 13 insertions, 13 deletions
diff --git a/docs/cli_parameters/config/config_options.csv b/docs/cli_parameters/config/config_options.csv
index 1861b1e1..7cf10982 100644
--- a/docs/cli_parameters/config/config_options.csv
+++ b/docs/cli_parameters/config/config_options.csv
@@ -5,8 +5,8 @@ audio_config,`pipewire <https://wiki.archlinux.org/title/PipeWire>`_!, `pulseaud
bootloader,`Systemd-boot <https://wiki.archlinux.org/title/Systemd-boot>`_!, `grub <https://wiki.archlinux.org/title/GRUB>`_,Bootloader to be installed *(grub being mandatory on BIOS machines)*,Yes
debug,``true``!, ``false``,Enables debug output,No
disk_config,*Read more under* :ref:`disk config`,Contains the desired disk setup to be used during installation,No
-disk_encryption,*Read more about under* :ref:`disk encryption`,Parameters for disk encryption applied ontop of ``disk_config``,No
-hostname,``str``,A string definining your machines hostname on the network *(defaults to ``archinstall``)*,No
+disk_encryption,*Read more about under* :ref:`disk encryption`,Parameters for disk encryption applied on top of ``disk_config``,No
+hostname,``str``,A string defining your machines hostname on the network *(defaults to ``archinstall``)*,No
kernels,[ `linux <https://wiki.archlinux.org/title/Kernel#Officially_supported_kernels>`_!, `linux-hardened <https://wiki.archlinux.org/title/Kernel#Officially_supported_kernels>`_!, `linux-lts <https://wiki.archlinux.org/title/Kernel#Officially_supported_kernels>`_!, `linux-rt <https://wiki.archlinux.org/title/Kernel#Officially_supported_kernels>`_!, `linux-rt-lts <https://wiki.archlinux.org/title/Kernel#Officially_supported_kernels>`_!, `linux-zen <https://wiki.archlinux.org/title/Kernel#Officially_supported_kernels>`_ ],Defines which kernels should be installed and setup in the boot loader options,Yes
custom-commands,*Read more under* :ref:`custom commands`,Custom commands that will be run post-install chrooted inside the installed system,No
locale_config,{kb_layout: `lang <https://wiki.archlinux.org/title/Linux_console/Keyboard_configuration>`__!, sys_enc: `Character encoding <https://wiki.archlinux.org/title/Locale>`_!, sys_lang: `locale <https://wiki.archlinux.org/title/Locale>`_},Defines the keyboard key map!, system encoding and system locale,No
@@ -16,9 +16,9 @@ no_pkg_lookups,``true``!, ``false``,Disabled package checking against https://ar
ntp,``true``!, ``false``,enables or disables `NTP <https://wiki.archlinux.org/title/Network_Time_Protocol_daemon>`_ during installation,No
offline,``true``!, ``false``,enables or disables certain online checks such as mirror reachability etc,No
packages,[ <package1>!, <package2>!, ... ],A list of packages to install during installation,No
-parallel downloads,0-∞,sets a given number of paralell downloads to be used by `pacman <https://wiki.archlinux.org/title/Pacman#Enabling_parallel_downloads>`_,No
+parallel downloads,0-∞,sets a given number of parallel downloads to be used by `pacman <https://wiki.archlinux.org/title/Pacman#Enabling_parallel_downloads>`_,No
profile_config,*`read more under the profiles section`*,Installs a given profile if defined,No
script,`guided <https://github.com/archlinux/archinstall/blob/master/archinstall/scripts/guided.py>`__! *(default)*!, `minimal <https://github.com/archlinux/archinstall/blob/master/archinstall/scripts/minimal.py>`__!, `only_hdd <https://github.com/archlinux/archinstall/blob/master/archinstall/scripts/only_hdd.py>`_!, `swiss <https://github.com/archlinux/archinstall/blob/master/archinstall/scripts/swiss.py>`_!, `unattended <https://github.com/archlinux/archinstall/blob/master/archinstall/scripts/unattended.py>`_,When used to autorun an installation!, this sets which script to autorun with,No
silent,``true``!, ``false``,disables or enables user questions using the TUI,No
swap,``true``!, ``false``,enables or disables swap,No
-timezone,`timezone <https://wiki.archlinux.org/title/System_time#Time_zone>`_,sets a timezone for the installed system,No \ No newline at end of file
+timezone,`timezone <https://wiki.archlinux.org/title/System_time#Time_zone>`_,sets a timezone for the installed system,No
diff --git a/docs/cli_parameters/config/disk_config.rst b/docs/cli_parameters/config/disk_config.rst
index ed5f42c1..3dc01fb2 100644
--- a/docs/cli_parameters/config/disk_config.rst
+++ b/docs/cli_parameters/config/disk_config.rst
@@ -26,7 +26,7 @@ Given the following disk example:
├── boot (/dev/sda1)
└── home (/dev/sda3)
-Runing ``archinstall --conf your.json --silent`` where the above JSON is configured. The disk will be left alone — and a working system will be installed to the above folders and mountpoints will be translated into the installed system.
+Running ``archinstall --conf your.json --silent`` where the above JSON is configured. The disk will be left alone — and a working system will be installed to the above folders and mountpoints will be translated into the installed system.
.. note::
@@ -242,4 +242,4 @@ This example contains both subvolumes and compression.
},
"status": "create",
"type": "primary"
- } \ No newline at end of file
+ }
diff --git a/docs/examples/python.rst b/docs/examples/python.rst
index 7fb3f6c3..7226c825 100644
--- a/docs/examples/python.rst
+++ b/docs/examples/python.rst
@@ -38,7 +38,7 @@ To do this, we'll begin by importing :code:`archinstall` in our "`scripts`_:code
print(archinstall.disk.device_handler.devices)
Now, go ahead and reference the :ref:`installing.python.manual` installation method.
-After runnig ``python -m archinstall test_installer`` it should print something that looks like:
+After running ``python -m archinstall test_installer`` it should print something that looks like:
.. code-block:: text
@@ -93,4 +93,4 @@ That means your script is in the right place, and ``archinstall`` is working as
Most calls, including the one above requires `root <https://en.wikipedia.org/wiki/Superuser>`_ privileges.
-.. _scripts: https://github.com/archlinux/archinstall/tree/master/archinstall/scripts \ No newline at end of file
+.. _scripts: https://github.com/archlinux/archinstall/tree/master/archinstall/scripts
diff --git a/docs/help/known_issues.rst b/docs/help/known_issues.rst
index 425829e5..622356c1 100644
--- a/docs/help/known_issues.rst
+++ b/docs/help/known_issues.rst
@@ -22,7 +22,7 @@ Waiting for time sync `#2144`_
Missing Nvidia Proprietary Driver `#2002`_
------------------------------------------
-| In some instances, the nvidia driver might not have all the nessecary packages installed.
+| In some instances, the nvidia driver might not have all the necessary packages installed.
| This is due to the kernel selection and/or hardware setups requiring additional packages to work properly.
A common workaround is to install the package `linux-headers`_ and `nvidia-dkms`_
@@ -49,7 +49,7 @@ Keyring is out of date `#2213`_
| Subsequently the ``archinstall`` run might operate on a old keyring despite there being an update service for this.
| There is really no way to reliably over time work around this issue in ``archinstall``.
-| Instead, efforts to the upstream service should be considered the way forward. And/or keys not expiring betwene a sane ammount of ISO's.
+| Instead, efforts to the upstream service should be considered the way forward. And/or keys not expiring between a sane amount of ISO's.
.. note::
@@ -99,4 +99,4 @@ AUR packages
.. _archlinux-keyring-wkd-sync.service: https://gitlab.archlinux.org/archlinux/archlinux-keyring/-/blob/7e672dad10652a80d1cc575d75cdb46442cd7f96/wkd_sync/archlinux-keyring-wkd-sync.service.in
.. _ZFS: https://aur.archlinux.org/packages/zfs-linux
.. _archinstall: https://github.com/archlinux/archinstall/
-.. _timedatectl show: https://github.com/archlinux/archinstall/blob/e6344f93f7e476d05bbcd642f2ed91fdde545870/archinstall/lib/installer.py#L136 \ No newline at end of file
+.. _timedatectl show: https://github.com/archlinux/archinstall/blob/e6344f93f7e476d05bbcd642f2ed91fdde545870/archinstall/lib/installer.py#L136
diff --git a/docs/installing/guided.rst b/docs/installing/guided.rst
index dcedfc10..90abedb4 100644
--- a/docs/installing/guided.rst
+++ b/docs/installing/guided.rst
@@ -26,7 +26,7 @@ To start the installer, run the following in the latest Arch Linux ISO:
archinstall
-Since the `Guided Installer`_ is the default script, this is the equvilant of running :code:`archinstall guided`
+Since the `Guided Installer`_ is the default script, this is the equivalent of running :code:`archinstall guided`
The guided installation also supports installing with pre-configured answers to all the guided steps. This can be a quick and convenient way to re-run one or several installations.
@@ -284,4 +284,4 @@ Options for ``--creds``
The key's start with ``!`` because internal log functions will mask any keys starting with explamation from logs and unrestricted configurations.
.. _scripts: https://github.com/archlinux/archinstall/tree/master/archinstall/scripts
-.. _Guided Installer: https://github.com/archlinux/archinstall/blob/master/archinstall/scripts/guided.py \ No newline at end of file
+.. _Guided Installer: https://github.com/archlinux/archinstall/blob/master/archinstall/scripts/guided.py