Bug#902555: radeon.4: Some fixes in the manual
Bjarni Ingi Gislason
bjarniig at rhi.hi.is
Wed Jun 27 19:07:28 UTC 2018
Package: xserver-xorg-video-radeon
Version: 1:18.0.1-1
Severity: minor
Tags: patch
Dear Maintainer,
Summary of changes:
Remove superfluous quotation marks (") from the argument of a
single-font macro.
Use a better presentation for an ellipsis (with narrow space between
the periods).
Split long lines (> 80).
Begin a sentence on a new line if there is only one space separating
sentences.
Don't begin a sentence with a digit.
Add a comma after "e.g.".
Separate numbers from the units (with an unpaddable space).
Change - to \- if it shall be printed as a minus.
Change a two-fonts macro to an one-font macro for a
single argument.
Protect . if not an end of sentence.
Don't repeat a "long" word, but rephrase the text.
Use "tbl" to create a table, otherwise the text looks ugly with a
proportional font.
Protect . if not an end of sentence.
####
The patch is in the attachment.
-- System Information:
Debian Release: buster/sid
APT prefers stable-updates
APT policy: (500, 'stable-updates'), (500, 'proposed-updates'), (500, 'testing'), (500, 'stable')
Architecture: amd64 (x86_64)
Kernel: Linux 4.9.110-1 (SMP w/2 CPU cores)
Locale: LANG=is_IS.iso88591, LC_CTYPE=is_IS.iso88591 (charmap=ISO-8859-1), LANGUAGE=is_IS.iso88591 (charmap=ISO-8859-1)
Shell: /bin/sh linked to /bin/dash
Init: sysvinit (via /sbin/init)
Versions of packages xserver-xorg-video-radeon depends on:
ii libc6 2.27-3
ii libdrm-radeon1 2.4.92-1
ii libudev1 238-5
ii xserver-xorg-core [xorg-video-abi-23] 2:1.19.6-1
xserver-xorg-video-radeon recommends no packages.
Versions of packages xserver-xorg-video-radeon suggests:
ii firmware-amd-graphics 20170823-1
-- no debconf information
--
Bjarni I. Gislason
-------------- next part --------------
--- radeon.4 2018-03-20 12:17:16.000000000 +0000
+++ radeon.4.new 2018-06-27 01:55:21.000000000 +0000
@@ -1,13 +1,14 @@
+'\" t
.ds q \N'34'
.TH RADEON 4 "xf86-video-ati 18.0.1" "X Version 11"
.SH NAME
radeon \- ATI/AMD RADEON video driver
.SH SYNOPSIS
.nf
-.B "Section \*qDevice\*q"
+.B Section \*qDevice\*q
.BI " Identifier \*q" devname \*q
.B " Driver \*qradeon\*q"
-\ \ ...
+\ \ \&.\|.\|.\&
.B EndSection
.fi
.SH DESCRIPTION
@@ -18,7 +19,8 @@ following features:
.PD 0
.TP 2
\(bu
-Full support for 8-, 15-, 16- and 24-bit pixel depths, and for 30-bit depth on Linux 3.16
+Full support for 8-, 15-, 16- and 24-bit pixel depths, and for 30-bit
+depth on Linux 3.16
and later;
.TP
\(bu
@@ -37,7 +39,8 @@ only available on R/RV3xx, R/RV/RS4xx, R
.SH SUPPORTED HARDWARE
The
.B radeon
-driver supports PCI, AGP, and PCIe video cards based on the following ATI/AMD chips
+driver supports PCI, AGP, and PCIe video cards based on the following
+ATI/AMD chips
(note: list is non-exhaustive):
.PP
.PD 0
@@ -243,33 +246,43 @@ Option \*qZaphodHeads\*q \*qLVDS,VGA-0\*
will assign xrandr outputs LVDS and VGA-0 to this instance of the driver.
.TP
.BI "Option \*qColorTiling\*q \*q" "boolean" \*q
-The framebuffer can be addressed either in linear or tiled mode. Tiled mode can provide
-significant performance benefits with 3D applications. Tiling will be disabled if the drm
-module is too old or if the current display configuration does not support it. On R600+
-this enables 1D tiling mode.
+The framebuffer can be addressed either in linear or tiled mode.
+Tiled mode can provide
+significant performance benefits with 3D applications.
+Tiling will be disabled if the drm
+module is too old or if the current display configuration does not support
+it.
+On R600+ this enables 1D tiling mode.
.br
The default value is
.B on
-for R/RV3XX, R/RV4XX, R/RV5XX, RS6XX, RS740, R/RV6XX, R/RV7XX, RS780, RS880,
-EVERGREEN, CAYMAN, ARUBA, Southern Islands, and Sea Islands and
+for R/RV3XX, R/RV4XX, R/RV5XX, RS6XX, RS740, R/RV6XX, R/RV7XX, RS780,
+RS880, EVERGREEN, CAYMAN, ARUBA, Southern Islands, and Sea Islands and
.B off
-for R/RV/RS1XX, R/RV/RS2XX, RS3XX, and RS690/RS780/RS880 when fast fb feature is enabled.
+for R/RV/RS1XX, R/RV/RS2XX, RS3XX, and RS690/RS780/RS880 when fast fb
+feature is enabled.
.TP
.BI "Option \*qColorTiling2D\*q \*q" "boolean" \*q
-The framebuffer can be addressed either in linear, 1D, or 2D tiled modes. 2D tiled mode can
-provide significant performance benefits over 1D tiling with 3D applications. Tiling
-will be disabled if the drm module is too old or if the current display configuration
-does not support it. KMS ColorTiling2D is only supported on R600 and newer chips and requires
-Mesa 9.0 or newer for R6xx-ARUBA, Mesa 9.2 or newer for Southern Islands, and Mesa
-10.1 or newer for Sea Islands.
+The framebuffer can be addressed either in linear, 1D, or 2D tiled
+modes.
+The 2D tiled mode can
+provide significant performance benefits over 1D tiling with 3D
+applications.
+Tiling will be disabled if the drm module is too old or if the current
+display configuration does not support it.
+KMS ColorTiling2D is only supported on R600 and newer chips and
+requires Mesa 9.0 or newer for R6xx-ARUBA,
+Mesa 9.2 or newer for Southern Islands, and Mesa 10.1 or newer for Sea
+Islands.
.br
The default value is
.B on
-for R/RV6XX, R/RV7XX, RS780, RS880, EVERGREEN, CAYMAN, ARUBA, Southern Islands, and
-Sea Islands.
+for R/RV6XX, R/RV7XX, RS780, RS880, EVERGREEN, CAYMAN, ARUBA, Southern
+Islands, and Sea Islands.
.TP
.BI "Option \*qDRI\*q \*q" integer \*q
-Define the maximum level of DRI to enable. Valid values are 2 for DRI2 or 3 for DRI3.
+Define the maximum level of DRI to enable. Valid values are 2 for
+DRI2 or 3 for DRI3.
The default is
.B 3 for DRI3
if the Xorg version is >= 1.18.3 and glamor is enabled, otherwise
@@ -283,11 +296,11 @@ Pageflipping is supported on all radeon
.TP
.BI "Option \*qTearFree\*q \*q" boolean \*q
Set the default value of the per-output 'TearFree' property, which controls
-tearing prevention using the hardware page flipping mechanism. TearFree is
-on for any CRTC associated with one or more outputs with TearFree on. Two
+tearing prevention using the hardware page flipping mechanism. TearFree is
+on for any CRTC associated with one or more outputs with TearFree on. Two
separate scanout buffers need to be allocated for each CRTC with TearFree
-on. If this option is set, the default value of the property is 'on' or 'off'
-accordingly. If this option isn't set, the default value of the property is
+on. If this option is set, the default value of the property is 'on' or 'off'
+accordingly. If this option isn't set, the default value of the property is
.B auto,
which means that TearFree is on for rotated outputs, outputs with RandR
transforms applied and for RandR 1.4 slave outputs, otherwise off.
@@ -297,9 +310,10 @@ Chooses between available acceleration a
.B EXA
(for pre-TAHITI GPUs) and
.B glamor
-(for R300 or higher). The default is
+(for R300 or higher). The default is
.B glamor
-with R600 or newer (with Xorg >= 1.18.3, otherwise with TAHITI or newer), otherwise
+with R600 or newer (with Xorg >= 1.18.3, otherwise with TAHITI or
+newer), otherwise
.B EXA.
.PP
@@ -313,7 +327,7 @@ are supported for
This option enables a so-called "shadow primary" buffer for fast CPU access to
pixel data, and separate scanout buffers for each display controller (CRTC).
This may improve performance for some 2D workloads, potentially at the expense
-of other (e.g. 3D, video) workloads.
+of other (e.g., 3D, video) workloads.
Note in particular that enabling this option currently disables page flipping.
The default is
.B off.
@@ -338,7 +352,9 @@ we use a heuristic based on VRAM amount
to use VRAM for non-essential pixmaps. This option allows us to override the
heuristic. The default is
.B on
-with > 32MB VRAM, off with < 32MB or when fast fb feature is enabled for RS690/RS780/RS880.
+with > 32\ MB VRAM,
+.B off
+with < 32\ MB or when fast fb feature is enabled for RS690/RS780/RS880.
.TP
.BI "Option \*qSwapbuffersWait\*q \*q" boolean \*q
This option controls the behavior of glXSwapBuffers and glXCopySubBufferMESA
@@ -356,29 +372,29 @@ The driver supports the following X11 Xv
You can use the "xvattr" tool to query/set those attributes at runtime.
.TP
-.BI "XV_VSYNC"
+.B XV_VSYNC
XV_VSYNC is used to control whether textured adapter synchronizes
the screen update to the monitor vertical refresh to eliminate tearing.
-It has two values: 'off'(0) and 'on'(1). The default is
+It has two values: 'off'(0) and 'on'(1). The default is
.B 'on'(1).
.TP
-.BI "XV_CRTC"
+.B XV_CRTC
XV_CRTC is used to control which display controller (crtc) the textured
adapter synchronizes the screen update with when XV_VSYNC is enabled.
-The default, 'auto'(-1), will sync to the display controller that more
+The default, 'auto'(\-1), will sync to the display controller that more
of the video is on; when this is ambiguous, the display controller associated
with the RandR primary output is preferred. This attribute is useful for
things like clone mode where the user can best decide which display should be
synced.
The default is
-.B 'auto'(-1).
+.B 'auto'(\-1).
.TP
-.BI "XV_BICUBIC"
+.B XV_BICUBIC
XV_BICUBIC is used to control whether textured adapter should apply
-a bicubic filter to smooth the output. It has three values: 'off'(0), 'on'(1)
-and 'auto'(2). 'off' means never apply the filter, 'on' means always apply
+a bicubic filter to smooth the output. It has three values: 'off'(0), 'on'(1)
+and 'auto'(2). 'off' means never apply the filter, 'on' means always apply
the filter and 'auto' means apply the filter only if the X and Y
sizes are scaled to more than double to avoid blurred output. Bicubic
filtering is not currently compatible with other Xv attributes like hue,
@@ -407,27 +423,31 @@ https://lists.freedesktop.org/mailman/li
IRC channel:
.RS 4
#radeon on irc.freenode.net
+.sp 1
+Use the bugtracker "https://bugs.freedesktop.org/"
.RE
.IP " 5." 4
-Query the bugtracker for radeon bugs:
+to query for radeon bugs:
.RS 4
-https://bugs.freedesktop.org/query.cgi?product=xorg&component=Driver/Radeon
+query.cgi?product=xorg&component=Driver/Radeon
.RE
.IP " 6." 4
-Submit bugs & patches:
+to submit bugs & patches:
.RS 4
-https://bugs.freedesktop.org/enter_bug.cgi?product=xorg&component=Driver/Radeon
+enter_bug.cgi?product=xorg&component=Driver/Radeon
.RE
-
.SH AUTHORS
-.nf
Authors include:
-Rickard E. (Rik) Faith \fIfaith at precisioninsight.com\fP
-Kevin E. Martin \fIkem at freedesktop.org\fP
-Alan Hourihane \fIalanh at fairlite.demon.co.uk\fP
-Marc Aurele La France \fItsi at xfree86.org\fP
-Benjamin Herrenschmidt \fIbenh at kernel.crashing.org\fP
-Michel D\(:anzer \fImichel at daenzer.net\fP
-Alex Deucher \fIalexdeucher at gmail.com\fP
-Bogdan D. \fIbogdand at users.sourceforge.net\fP
-Eric Anholt \fIeric at anholt.net\fP
+.if n .bp \" avoid a possible extra empty line in the table
+.TS
+l l .
+Rickard E.\& (Rik) Faith \fIfaith at precisioninsight.com\fP
+Kevin E.\& Martin \fIkem at freedesktop.org\fP
+Alan Hourihane \fIalanh at fairlite.demon.co.uk\fP
+Marc Aurele La France \fItsi at xfree86.org\fP
+Benjamin Herrenschmidt \fIbenh at kernel.crashing.org\fP
+Michel D\(:anzer \fImichel at daenzer.net\fP
+Alex Deucher \fIalexdeucher at gmail.com\fP
+Bogdan D.\& \fIbogdand at users.sourceforge.net\fP
+Eric Anholt \fIeric at anholt.net\fP
+.TE
More information about the xorg-driver-ati
mailing list