Bug 7148 - fix documentation bug and document missing feature
Summary: fix documentation bug and document missing feature
Alias: None
Product: xorg
Classification: Unclassified
Component: Driver/Radeon (show other bugs)
Version: 7.0 (2005.12)
Hardware: x86 (IA32) Linux (All)
: high normal
Assignee: Xorg Project Team
QA Contact: Xorg Project Team
Keywords: janitor, patch
Depends on:
Reported: 2006-06-07 09:13 UTC by John Heidemann
Modified: 2008-10-26 08:10 UTC (History)
0 users

See Also:
i915 platform:
i915 features:


Description John Heidemann 2006-06-07 09:13:01 UTC
The patch included here (1) fixes a doc bug for radeon.4 (the SEE ALSO section
is indented and shouldn't be), and (2) documents that there is currently no
rotate function (as confirmed by bug #3871).

The patch is against xorg 7.0 in Fedora Core 5, but the man page is pretty
stable :-)

Can someone apply this to the tree?  (Even if bug 3871 is fixed, the minor
indentation bug should still be fixed.)

--- radeon.4-   2006-06-07 09:06:03.000000000 -0700
+++ radeon.4    2006-06-07 09:05:46.000000000 -0700
@@ -587,7 +587,10 @@
 case.  This is only useful for LVDS panels (laptop internal panels).
 The default is
 .B on.
+Rotation (e.g., Option "Rotate" "CW") is not currently supported.

 Xorg(1x), xorg.conf(5x), xorgconfig(1x), Xserver(1x), X(7)
Comment 1 Michel Dänzer 2006-06-08 02:22:33 UTC
You failed to mention all the other missing features. ;) Seriously, I don't
think this belongs in the BUGS section.
Comment 2 John Heidemann 2006-06-08 09:07:30 UTC
There are two things in the patch.  Removing the .TP fixes an unambigious
formatting bug.

About adding the text about rotation:  The bug is that a common feature to many
drivers is not supported and there is no explicit indication of this fact.

I spent about 45 minutes Googling and trying it out in different parts of
xorg.conf (with NO error or warning messages, just the unsupported rotate option
silently ignored).  Wasting ones time like that, I argue, is a serious
misfeature.  I suggest documenting it.  If you prefer to fix it in a better way
(implement the rotate feature, or at least implement a warning message that it's
not supported), I agree those are better fixes.  Just a lot more work.

(If you simply don't like calling the section BUGS, it would be constructive to
propose an alternate term.  My understanding is that's a common use of the bugs
section in Unix man pages.)

Comment 3 Michel Dänzer 2006-06-08 09:13:00 UTC
Only a small minority of drivers support rotation (and only a much smaller
number with acceleration), so it's not reasonable to expect any given driver to
support it.

If you insist on documenting it in the driver manpage nonetheless, I suggest
doing so in the DESCRIPTION section.
Comment 4 John Heidemann 2006-06-08 09:35:34 UTC
The description section does not seem like a better place to me... right now
it's a 1 paragraph overview.  How about the end of the options section?

Revised patch against the original file.  (Actually turns the extra .TP into a
feature :-)

--- /tmp/radeon.4-      2006-06-08 09:30:59.000000000 -0700
+++ /tmp/radeon.4       2006-06-08 09:33:03.000000000 -0700
@@ -588,6 +588,7 @@
 The default is
 .B on.
+(Rotation (e.g., Option "Rotate" "CW") is not currently supported.)

 Xorg(1x), xorg.conf(5x), xorgconfig(1x), Xserver(1x), X(7)
Comment 5 Daniel Stone 2007-02-27 01:32:27 UTC
Sorry about the phenomenal bug spam, guys.  Adding xorg-team@ to the QA contact so bugs don't get lost in future.
Comment 6 Timo Jyrinki 2007-09-05 00:10:27 UTC
I think this could be marked as fixed, since the rotation support is now available for some cards.
Comment 7 John Heidemann 2007-09-05 09:40:52 UTC
Please see comment #2.  There are actually *two* separate bugs here,
one lack of documentation about rotation (that may now be resolved),
and the other a simple roff formatting bug.

If you think rotation is solved, fine (although radeon(4) doesn't include the word "rotation" in my current release, xorg-x11-drv-ati-6.6.3-4.fc7, on Fedora 7).

However, the roff formatting bug is still there.  Here is a patch that just fixes that:

--- /tmp/radeon.4-      2007-09-05 09:38:15.000000000 -0700
+++ /tmp/radeon.4       2007-09-05 09:38:23.000000000 -0700
@@ -610,7 +610,7 @@
 case.  This is only useful for LVDS panels (laptop internal panels).
 The default is
 .B on.
 Xorg(1x), xorg.conf(5x), xorgconfig(1x), Xserver(1x), X(7)

Please at least apply this patch before closing out this bug.
Comment 8 Julien Cristau 2008-10-26 08:10:52 UTC
formatting bug fixed, thanks.
rotation for RandR1.2 drivers is documented in xorg.conf(5) and xrandr(1).

Use of freedesktop.org services, including Bugzilla, is subject to our Code of Conduct. How we collect and use information is described in our Privacy Policy.