Bug 269626 - FreeBSD Handbook: NVIDIA: corrections
Summary: FreeBSD Handbook: NVIDIA: corrections
Status: Closed FIXED
Alias: None
Product: Documentation
Classification: Unclassified
Component: Books & Articles (show other bugs)
Version: Latest
Hardware: Any Any
: --- Affects Some People
Assignee: Graham Perrin
URL: https://cgit.freebsd.org/doc/commit/d...
Keywords:
Depends on:
Blocks:
 
Reported: 2023-02-17 14:57 UTC by Graham Perrin
Modified: 2023-03-04 13:16 UTC (History)
6 users (show)

See Also:
grahamperrin: maintainer-feedback? (danfe)


Attachments

Note You need to log in before you can comment on or make changes to this bug.
Description Graham Perrin freebsd_committer freebsd_triage 2023-02-17 14:57:50 UTC
1) 

The table under <https://docs.freebsd.org/en/books/handbook/x11/#x-configuration-nvidia> lists a non-existent port: 

    x11/nvidia-driver-510

Should be: 

    x11/nvidia-driver

2)

The second warning discourages use of nvidia-modeset (to be used only in exceptional circumstances). Whilst this might be consistent with the package message, I'm not sure that it's true.
Comment 1 Graham Perrin freebsd_committer freebsd_triage 2023-02-17 15:01:24 UTC
danfe@ or x11@ please, can someone clarify re: the situations in which 
nvidia-modeset is _preferred_?
Comment 2 commit-hook freebsd_committer freebsd_triage 2023-02-17 15:17:55 UTC
A commit in branch main references this bug:

URL: https://cgit.FreeBSD.org/doc/commit/?id=bef2d6fc48e91189f6c378046cc3a889bcc7d879

commit bef2d6fc48e91189f6c378046cc3a889bcc7d879
Author:     Sergio Carlavilla Delgado <carlavilla@FreeBSD.org>
AuthorDate: 2023-02-17 15:16:52 +0000
Commit:     Sergio Carlavilla Delgado <carlavilla@FreeBSD.org>
CommitDate: 2023-02-17 15:16:52 +0000

    Fix nvidia driver in X11 chapter

    PR:             269626
    Submitted by:   grahamperrin@

 documentation/content/en/books/handbook/x11/_index.adoc | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)
Comment 3 Sergio Carlavilla Delgado freebsd_committer freebsd_triage 2023-02-17 15:20:43 UTC
Fix the reference to nvidia-driver-510, since the package and the manual say the same thing about the nvidia-modeset there are no more bugs to fix, if at any time the message provided by the package is changed, we will add it to the manual as well
Comment 4 Graham Perrin freebsd_committer freebsd_triage 2023-02-20 08:12:16 UTC
(In reply to Graham Perrin from comment #0)

> The second warning discourages use of nvidia-modeset (to be used 
> only in exceptional circumstances). Whilst this might be consistent 
> with the package message, I'm not sure that it's true.

freebsd-doc PR 114 aims to correct the FreeBSD Handbook, but (a different repo) not the package message.
Comment 5 Alex S 2023-02-21 23:13:30 UTC
(In reply to Sergio Carlavilla Delgado from comment #3)

> since the package and the manual say the same thing about the nvidia-modeset

Definitely not.
Comment 6 Alexey Dokuchaev freebsd_committer freebsd_triage 2023-03-01 05:52:06 UTC
(In reply to Graham Perrin from comment #1)
> can someone clarify re: the situations in which nvidia-modeset is
> _preferred_?
If it's shipped with your version of the driver, you should use it.  It specifies the MODULE_DEPENDS on nvidia.ko so the latter would be loaded automatically.

The `nvidia-modeset.ko' was introduced in driver version 358.09 to program the display engine of the GPU (changing resolutions, transformation settings, display device hot-plugging, etc.) and works in conjunction with the `nvidia.ko' kernel module. At the time of the writing, only the latest version of the driver shipped this module, most users would still go the good old kld_list="nvidia" way. We simply forgot to flip the switch as the time had passed. I'll update the port's pkg-message to make it less confusing (technically it correctly explains the situation, but suggests kld_list="nvidia" as the default, while it should be kld_list="nvidia-modeset" these days).
Comment 7 commit-hook freebsd_committer freebsd_triage 2023-03-01 10:21:13 UTC
A commit in branch main references this bug:

URL: https://cgit.FreeBSD.org/ports/commit/?id=a09185f8b66c462d3bc1d1d7526d667770319aaf

commit a09185f8b66c462d3bc1d1d7526d667770319aaf
Author:     Alexey Dokuchaev <danfe@FreeBSD.org>
AuthorDate: 2023-03-01 10:19:30 +0000
Commit:     Alexey Dokuchaev <danfe@FreeBSD.org>
CommitDate: 2023-03-01 10:19:30 +0000

    x11/nvidia-driver: reword the pkg-message to reflect modern reality

    Try to reduce readers' confusion by specifying exactly which nVidia
    kernel module users should be loading these days.

    PR:     269626

 x11/nvidia-driver/Makefile             | 11 ++++++++---
 x11/nvidia-driver/files/pkg-message.in | 20 ++++----------------
 2 files changed, 12 insertions(+), 19 deletions(-)
Comment 8 commit-hook freebsd_committer freebsd_triage 2023-03-04 13:15:41 UTC
A commit in branch main references this bug:

URL: https://cgit.FreeBSD.org/doc/commit/?id=9af61238fc24d4772b3c9e5fbd63fcaee2526699

commit 9af61238fc24d4772b3c9e5fbd63fcaee2526699
Author:     Sergio Carlavilla Delgado <carlavilla@FreeBSD.org>
AuthorDate: 2023-03-04 13:13:54 +0000
Commit:     Sergio Carlavilla Delgado <carlavilla@FreeBSD.org>
CommitDate: 2023-03-04 13:13:54 +0000

    Fix NVIDIA install and configure intructions in X11 chapter

    Upgrade NVIDIA instructions based on commit[1]

    PR:             269626

    [1] https://cgit.freebsd.org/ports/commit/?id=a09185f8

 documentation/content/en/books/handbook/x11/_index.adoc | 9 ++++-----
 1 file changed, 4 insertions(+), 5 deletions(-)
Comment 9 Sergio Carlavilla Delgado freebsd_committer freebsd_triage 2023-03-04 13:16:42 UTC
Fixed. Thanks danfe@