[pve-devel] [PATCH docs v2] installation: reword `nomodeset` section a bit, add link to it

[pve-devel] [PATCH docs v2] installation: reword `nomodeset` section a bit, add link to it

[Christoph Heiss]

The `nomodeset` section needs some massaging due to the text flow being
broken a bit. While at it, link to it above at the 'Terminal UI'
bootloader tip such that readers can find it more easily.

Suggested-by: Alexander Zeidler <a.zeidler@proxmox.com>
Signed-off-by: Christoph Heiss <c.heiss@proxmox.com>
---
Changes v1 -> v2:
  * dropped superflous `the`
  * use `xref` instead of `<< >>` for linking paragraph

 pve-installation.adoc | 11 ++++++-----
 1 file changed, 6 insertions(+), 5 deletions(-)

diff --git a/pve-installation.adoc b/pve-installation.adoc
index 6b44fc0..016aa91 100644
--- a/pve-installation.adoc
+++ b/pve-installation.adoc
@@ -88,7 +88,8 @@ Both modes use the same code base for the actual installation process to
 benefit from more than a decade of bug fixes and ensure feature parity.

 TIP: The 'Terminal UI' option can be used in case the graphical installer does
-not work correctly, due to e.g. driver issues.
+not work correctly, due to e.g. driver issues. See also
+xref:nomodeset_kernel_param[adding the `nomodeset` kernel parameter].

 Advanced Options: Install {pve} (Graphical, Debug Mode)::

@@ -300,14 +301,14 @@ following command:
 # zpool add <pool-name> log </dev/path_to_fast_ssd>
 ----

+[[nomodeset_kernel_param]]
 Adding the `nomodeset` Kernel Parameter
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

 Problems may arise on very old or very new hardware due to graphics drivers. If
-the installation hangs during the boot. In that case, you can try adding the
-`nomodeset` parameter. This prevents the Linux kernel from loading any
-graphics drivers and forces it to continue using the BIOS/UEFI-provided
-framebuffer.
+the installation hangs during boot, you can try adding the `nomodeset`
+parameter. This prevents the Linux kernel from loading any graphics drivers and
+forces it to continue using the BIOS/UEFI-provided framebuffer.

 On the {pve} bootloader menu, navigate to 'Install {pve} (Terminal UI)' and
 press `e` to edit the entry. Using the arrow keys, navigate to the line starting
--
2.43.0

Re: [pve-devel] [PATCH docs v2] installation: reword `nomodeset` section a bit, add link to it

[Thomas Lamprecht]

Am 26/02/2024 um 18:59 schrieb Christoph Heiss:
> The `nomodeset` section needs some massaging due to the text flow being
> broken a bit. While at it, link to it above at the 'Terminal UI'
> bootloader tip such that readers can find it more easily.
> 
> Suggested-by: Alexander Zeidler <a.zeidler@proxmox.com>
> Signed-off-by: Christoph Heiss <c.heiss@proxmox.com>
> ---
> Changes v1 -> v2:
>   * dropped superflous `the`
>   * use `xref` instead of `<< >>` for linking paragraph
> 
>  pve-installation.adoc | 11 ++++++-----
>  1 file changed, 6 insertions(+), 5 deletions(-)
> 
> diff --git a/pve-installation.adoc b/pve-installation.adoc
> index 6b44fc0..016aa91 100644
> --- a/pve-installation.adoc
> +++ b/pve-installation.adoc
> @@ -88,7 +88,8 @@ Both modes use the same code base for the actual installation process to
>  benefit from more than a decade of bug fixes and ensure feature parity.
> 
>  TIP: The 'Terminal UI' option can be used in case the graphical installer does
> -not work correctly, due to e.g. driver issues.
> +not work correctly, due to e.g. driver issues. See also
> +xref:nomodeset_kernel_param[adding the `nomodeset` kernel parameter].
> 
>  Advanced Options: Install {pve} (Graphical, Debug Mode)::
> 
> @@ -300,14 +301,14 @@ following command:
>  # zpool add <pool-name> log </dev/path_to_fast_ssd>
>  ----
> 
> +[[nomodeset_kernel_param]]
>  Adding the `nomodeset` Kernel Parameter
>  ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
> 
>  Problems may arise on very old or very new hardware due to graphics drivers. If
> -the installation hangs during the boot. In that case, you can try adding the
> -`nomodeset` parameter. This prevents the Linux kernel from loading any
> -graphics drivers and forces it to continue using the BIOS/UEFI-provided
> -framebuffer.
> +the installation hangs during boot, you can try adding the `nomodeset`
> +parameter. This prevents the Linux kernel from loading any graphics drivers and
> +forces it to continue using the BIOS/UEFI-provided framebuffer.
> 
>  On the {pve} bootloader menu, navigate to 'Install {pve} (Terminal UI)' and
>  press `e` to edit the entry. Using the arrow keys, navigate to the line starting
> --
> 2.43.0
> 
> 
> 
> _______________________________________________
> pve-devel mailing list
> pve-devel@lists.proxmox.com
> https://lists.proxmox.com/cgi-bin/mailman/listinfo/pve-devel
> 
> 

[pve-devel] applied: [PATCH docs v2] installation: reword `nomodeset` section a bit, add link to it

[Thomas Lamprecht]

Am 26/02/2024 um 18:59 schrieb Christoph Heiss:
> The `nomodeset` section needs some massaging due to the text flow being
> broken a bit. While at it, link to it above at the 'Terminal UI'
> bootloader tip such that readers can find it more easily.
> 
> Suggested-by: Alexander Zeidler <a.zeidler@proxmox.com>
> Signed-off-by: Christoph Heiss <c.heiss@proxmox.com>
> ---
> Changes v1 -> v2:
>   * dropped superflous `the`
>   * use `xref` instead of `<< >>` for linking paragraph
> 
>  pve-installation.adoc | 11 ++++++-----
>  1 file changed, 6 insertions(+), 5 deletions(-)
> 
>

applied, thanks!