[gentoo-doc-cvs] cvs commit: nvidia-guide.xml

["Josh Saddler" <nightmorph@lark.gentoo.org>]

nightmorph    06/10/24 02:24:14

  Modified:             nvidia-guide.xml
  Log:
  Thorough overhaul of nVidia guide, as nvidia-kernel & glx have been removed from portage awhile ago; several functionality changes have taken place within the nvidia/legacy packages that prevent some errors from occuring, and we don't support the out-of-portage versions anyway.

Revision  Changes    Path
1.33                 xml/htdocs/doc/en/nvidia-guide.xml

file : http://sources.gentoo.org/viewcvs.py/gentoo/xml/htdocs/doc/en/nvidia-guide.xml?rev=1.33&view=markup
plain: http://sources.gentoo.org/viewcvs.py/gentoo/xml/htdocs/doc/en/nvidia-guide.xml?rev=1.33&content-type=text/plain
diff : http://sources.gentoo.org/viewcvs.py/gentoo/xml/htdocs/doc/en/nvidia-guide.xml?r1=1.32&r2=1.33

Index: nvidia-guide.xml
===================================================================
RCS file: /var/cvsroot/gentoo/xml/htdocs/doc/en/nvidia-guide.xml,v
retrieving revision 1.32
retrieving revision 1.33
diff -u -r1.32 -r1.33
--- nvidia-guide.xml	2 Sep 2006 10:19:23 -0000	1.32
+++ nvidia-guide.xml	24 Oct 2006 02:24:14 -0000	1.33
@@ -1,5 +1,5 @@
 <?xml version='1.0' encoding="UTF-8"?>
-<!-- $Header: /var/cvsroot/gentoo/xml/htdocs/doc/en/nvidia-guide.xml,v 1.32 2006/09/02 10:19:23 nightmorph Exp $ -->
+<!-- $Header: /var/cvsroot/gentoo/xml/htdocs/doc/en/nvidia-guide.xml,v 1.33 2006/10/24 02:24:14 nightmorph Exp $ -->
 <!DOCTYPE guide SYSTEM "/dtd/guide.dtd">
 
 <guide link="/doc/en/nvidia-guide.xml">
@@ -28,8 +28,8 @@
 <!-- See http://creativecommons.org/licenses/by-sa/2.5 -->
 <license/>
 
-<version>1.27</version>
-<date>2006-09-02</date>
+<version>1.28</version>
+<date>2006-10-23</date>
 
 <chapter>
 <title>Introduction</title>
@@ -38,37 +38,18 @@
 
 <p>
 nVidia release their own Linux drivers which provide good performance and full
-3D acceleration. There are two sets of drivers in portage. The first set is an
-older set and split into two parts: <c>nvidia-kernel</c> and <c>nvidia-glx</c>.
-The second set is newer, and is split into <c>nvidia-drivers</c> and
-<c>nvidia-legacy-drivers</c>. If you are installing for the first time, you
-should use the newer set.
-</p>
-
-<p>
-<c>nvidia-kernel</c> is a kernel driver which handles the low-level
-communication with your video hardware. This is simply a kernel module, named
-<c>nvidia</c>, which installs against your kernel sources and needs to be
-loaded whenever you want to use the nvidia drivers.
-</p>
-
-<p>
-As well as the kernel driver, you need to install the X11 GLX layer
-(<c>nvidia-glx</c>). This is used by X to render graphics, which internally
-uses the <c>nvidia-kernel</c> kernel driver to interface with the hardware.
-</p>
-
-<p>
-The newer drivers have the functionality of both <c>nvidia-kernel</c> and
-<c>nvidia-glx</c> in a single unified ebuild, much like how nVidia themselves
-ship the drivers.
+3D acceleration. There are two drivers in Portage. <c>nvidia-drivers</c> is for
+newer nVidia graphics cards, while <c>nvidia-legacy-drivers</c> supports older
+cards.
 </p>
 
 <note>
-Both <c>nvidia-kernel</c> and <c>nvidia-glx</c> are deprecated, and will be
-removed from the Portage tree in the future in favor of <c>nvidia-drivers</c>
-and <c>nvidia-legacy-drivers</c>.  If you use <c>nvidia-kernel</c> and
-<c>nvidia-glx</c>, then you should migrate to the newer packages.
+Previously, Gentoo provided separate ebuilds for the nVidia kernel module
+(<c>nvidia-kernel</c>) and the X11 GLX libraries (<c>nvidia-glx</c>). These
+ebuilds have since been removed from the Portage tree in favor of
+<c>nvidia-drivers</c> and <c>nvidia-legacy-drivers</c>. If you use
+<c>nvidia-kernel</c> and <c>nvidia-glx</c>, then you should migrate to the
+newer packages.
 </note>
 
 </body>
@@ -103,14 +84,13 @@
   [*] MTRR (Memory Type Range Register) support
 </pre>
 
-<p>
-Also, you can optionally enable <c>agpgart</c> support to your kernel, either
-compiled in or as a module. If you do not use the in-kernel agpgart, then the
-drivers will use their own <c>agpgart</c> implementation, called <c>NvAGP</c>.
-On certain systems, this performs better than the in-kernel agpgart, and on
-others, it performs worse. You will need to evaluate this on your own system to
-get the best performance. If you are unsure what to do, use the in-kernel
-agpgart:
+<p> Also, if you have an AGP graphics card, you can optionally enable
+<c>agpgart</c> support to your kernel, either compiled in or as a module. If
+you do not use the in-kernel agpgart, then the drivers will use their own
+<c>agpgart</c> implementation, called <c>NvAGP</c>.  On certain systems, this
+performs better than the in-kernel agpgart, and on others, it performs worse.
+You will need to evaluate this on your own system to get the best performance.
+If you are unsure what to do, use the in-kernel agpgart:
 </p>
 
 <pre caption="Enabling agpgart">
@@ -173,11 +153,11 @@
 <body>
 
 <p>
-The <c>nvidia-kernel</c>, <c>nvidia-drivers</c>, and
-<c>nvidia-legacy-drivers</c> ebuilds automatically discover your kernel version
-based on the <path>/usr/src/linux</path> symlink. Please ensure that you have
-this symlink pointing to the correct sources and that your kernel is correctly
-configured.  Please refer to the Configuring the Kernel section of the <uri
+The <c>nvidia-drivers</c> and <c>nvidia-legacy-drivers</c> ebuilds
+automatically discover your kernel version based on the
+<path>/usr/src/linux</path> symlink. Please ensure that you have this symlink
+pointing to the correct sources and that your kernel is correctly configured.
+Please refer to the Configuring the Kernel section of the <uri
 link="/doc/en/handbook/">Installation Handbook</uri> for details on configuring
 your kernel.
 </p>
@@ -221,9 +201,9 @@
 
 <note>
 Unfortunately, certain legacy video cards are not supported by the newer
-versions of <c>nvidia-drivers</c>, <c>nvidia-glx</c> and <c>nvidia-kernel</c>.
-nVidia provides a <uri link="http://www.nvidia.com/object/IO_18897.html">list
-of supported cards</uri>. Please check the list before installing the drivers.
+versions of <c>nvidia-drivers</c>.  nVidia provides a <uri
+link="http://www.nvidia.com/object/IO_18897.html">list of supported
+cards</uri>. Please check the list before installing the drivers.
 </note>
 
 <p>
@@ -262,10 +242,7 @@
 <body>
 
 <p>
-Now it's time to install the drivers. The newer drivers are unified, so you
-will only need to install a single package. The older drivers are split, so it
-will require two packages to be installed. Since <c>nvidia-glx</c> depends on
-<c>nvidia-kernel</c>, installing <c>nvidia-glx</c> is sufficient.
+Now it's time to install the drivers.
 </p>
 
 <pre caption="Installing the nVidia drivers">
@@ -275,18 +252,11 @@
 # <i>emerge nvidia-legacy-drivers</i>
 </pre>
 
-<pre caption="Installing the nVidia drivers (deprecated method)">
-# <i>emerge nvidia-glx</i>
-</pre>
-
 <impo>
 Every time you <uri link="/doc/en/kernel-upgrade.xml">compile a new
-kernel</uri> or recompile the current one, you have to run <c>emerge
-nvidia-kernel</c> to reinstall the nVidia modules. <c>nvidia-glx</c> is
-unaffected by a kernel change and doesn't even need to be rebuilt when you
-recompile/upgrade X. If you are using the newer drivers, then you will need to
-run <c>emerge nvidia-drivers</c> or <c>emerge nvidia-legacy-drivers</c> to
-reinstall the nVidia modules.
+kernel</uri> or recompile the current one, you will need to run <c>emerge
+nvidia-drivers</c> or <c>emerge nvidia-legacy-drivers</c> to reinstall the
+nVidia modules.
 </impo>
 
 <p>
@@ -330,9 +300,8 @@
 </p>
 
 <p>
-Open <path>/etc/X11/xorg.conf</path> (or <path>/etc/X11/XF86Config</path> if you
-still use the older configuration file location) with your favorite editor
-(such as <c>nano</c> or <c>vim</c>) and go to the <c>Device</c> section. In that
+Open <path>/etc/X11/xorg.conf</path> with your favorite editor (such as
+<c>nano</c> or <c>vim</c>) and go to the <c>Device</c> section. In that
 section, change the <c>Driver</c> line:
 </p>
 
@@ -361,7 +330,7 @@
 <p>
 Next, in section <c>Screen</c>, make sure that either the <c>DefaultDepth</c>
 directive is set to 16 or 24, or that you only have <c>Display</c> subsections
-with <c>Depth</c> settings of 16 or 24. Without it, the nvidia-glx extensions
+with <c>Depth</c> settings of 16 or 24. Without it, the nVidia GLX extensions
 will not start.
 </p>
 
@@ -399,7 +368,7 @@
 
 <p>
 This might not be totally necessary if you aren't using <c>udev</c> but it
-doesn't hurt either and makes your system future-proof :)
+doesn't hurt either and makes your system future-proof.
 </p>
 
 </body>
@@ -489,20 +458,6 @@
 </body>
 </section>
 <section>
-<title>I receive warnings about unsupported 4K stack sizes</title>
-<body>
-
-<p>
-<c>nvidia-kernel</c> packages older than 1.0.6106 only support kernels using an
-8K stack size. More recent kernels (2.6.6 and higher) have support for 4K stack
-size's as well. Do not select 4K stack size in your kernel configuration if
-you are using such an <c>nvidia-kernel</c> package. You can find this option in
-the section <c>Kernel Hacking</c>.
-</p>
-
-</body>
-</section>
-<section>
 <title>
   When I attempt to load the kernel module I receive a "no such device"
 </title>
@@ -521,50 +476,6 @@
 
 </body>
 </section>
-<section>
-<title>
-  I get "no screens found" and the logs state "Failed to initialize the NVIDIA 
-  kernel module!"
-</title>
-<body>
-
-<p>
-You're most likely missing the <path>/dev/nvidia*</path> device files. Create
-them using <c>NVmakedevices.sh</c>:
-</p>
-
-<pre caption="Creating the nvidia device nodes">
-# <i>/sbin/NVmakedevices.sh</i>
-</pre>
-
-<p>
-If your <path>/dev/nvidia*</path> devices are still missing every time you
-reboot, then it is most likely because udev is not automatically creating the
-proper device nodes. You can fix this by re-running <c>NVmakedevices.sh</c>,
-and then editing <path>/etc/conf.d/rc</path> as shown:
-</p>
-
-<pre caption="Editing /etc/conf.d/rc">
-RC_DEVICE_TARBALL="yes"
-</pre>
-
-<p>
-This will preserve your <path>/dev/nvidia*</path> nodes even if you reboot.
-</p>
-
-<note>
-Alternatively, you might try emerging the latest <c>nvidia-kernel</c> and
-<c>nvidia-glx</c> from the 8xxx series. At the time of this writing, both are
-still marked ~arch. These drivers no longer rely on hotplug or udev to create
-the proper device nodes, so you won't need to run <c>NVmakedevices.sh</c>.
-Instead, the X driver itself will create your <path>/dev/nvidia*</path> files
-when you start X. However, this will require you to use a recent kernel (2.6.14
-and greater). This is also true for all versions of <c>nvidia-drivers</c> and
-<c>nvidia-legacy-drivers</c>.
-</note>
-
-</body>
-</section>
 </chapter>
 
 <chapter>
@@ -584,8 +495,6 @@
 $ <i>less /usr/share/doc/nvidia-drivers-*/README.gz</i>
 <comment>(for nvidia-legacy-drivers)</comment>
 $ <i>less /usr/share/doc/nvidia-legacy-drivers-*/README.gz</i>
-<comment>(for nvidia-glx)</comment>
-$ <i>less /usr/share/doc/nvidia-glx-*/README.txt.gz</i>
 </pre>
 
 </body>



-- 
gentoo-doc-cvs@gentoo.org mailing list