Hi,

here's some hopefully final embellishments.

Fernando, thanks for reviewing. If you wish a more formal attribution,
please send your reviewed-by tag.

Peter, one small and hopefully uncontroversial update, feel free to
squash it in. For your changes:

Signed-off-by: Simon Thum <[email protected]>

Cheers,

Simon


Fernando Carrijo wrote:
> Hi Simon,
> 
> Here's a couple of typos to be corrected before they go upstream.
> 
> On Wed, 06 Jan 2010 20:27:34 +0100, Simon Thum <[email protected]> wrote:
>> From 920c13502f8184c18a0e7e6f362f0b5a75463267 Mon Sep 17 00:00:00 2001
>> From: Simon Thum <[email protected]>
>> Date: Wed, 6 Jan 2010 19:43:59 +0100
>> Subject: [PATCH 3/5] xfree86: document pointer acceleration in xorg.conf.man
>>
>> ---
>>  hw/xfree86/doc/man/xorg.conf.man.pre |   44 
>> ++++++++++++++++++++++++++++++++++
>>  1 files changed, 44 insertions(+), 0 deletions(-)
>>
>> diff --git a/hw/xfree86/doc/man/xorg.conf.man.pre 
>> b/hw/xfree86/doc/man/xorg.conf.man.pre
>> index 9420dfe..1b88ecb 100644
>> --- a/hw/xfree86/doc/man/xorg.conf.man.pre
>> +++ b/hw/xfree86/doc/man/xorg.conf.man.pre
>> @@ -915,6 +915,50 @@ may be reattached or set floating at runtime.
>>  .TP 7
>>  .BI "Option \*qSendDragEvents\*q  \*q" boolean \*q
>>  Send core events while dragging. Enabled by default.
>> +.PP
>> +For pointing devices, the following options control how the pointer
>> +is accelerated or decelerated with respect to physical device motion. Most 
>> of
>> +these can be adjusted at runtime, see the xinput(1) man page for details. 
>> Only
>> +the most important acceleration options are discussed here.
>> +.TP 7
>> +.BI "Option \*qAccelerationProfile\*q  \*q" integer \*q
>> +Select the profile, which determines actual acceleration as a function of
>> +device velocity and acceleration controls (acceleartion and threshold, 
>> dubbed
>                                               ^^^^^^^^^^^^
> 
>> +pointer feedback). This is mainly a matter of personal preference.
>> +.PP
>> +.RS 6
>> +.nf
>> +.B  " 0      classic (mostly compatible)"
>> +.B  "-1      none (only constant deceleration is applied)"
>> +.B  " 1      device-dependent"
>> +.B  " 2      polynomial (polynomial function)"
>> +.B  " 3      smooth linear (hockey)"
>> +.B  " 4      simple (normal wehn slow, then accelerated)"
>                                ^^^^
> 
>> +.B  " 5      power (power function)"
>> +.B  " 6      linear (more speed, more acceleration)"
>> +.B  " 7      limited (like linear, but maxes out at threshold)"
> 
> Cheers,
> Fernando Carrijo.
> 

>From 3336cb0fd242c1f46bde46df935e28d2343e624b Mon Sep 17 00:00:00 2001
From: Simon Thum <[email protected]>
Date: Thu, 7 Jan 2010 12:05:47 +0100
Subject: [PATCH 1/2] xfree86: fix typos in xorg.conf.man

spotted by Fernando Carrijo.

Signed-off-by: Simon Thum <[email protected]>
---
 hw/xfree86/doc/man/xorg.conf.man.pre |    4 ++--
 1 files changed, 2 insertions(+), 2 deletions(-)

diff --git a/hw/xfree86/doc/man/xorg.conf.man.pre 
b/hw/xfree86/doc/man/xorg.conf.man.pre
index 77e65f0..a21bcf0 100644
--- a/hw/xfree86/doc/man/xorg.conf.man.pre
+++ b/hw/xfree86/doc/man/xorg.conf.man.pre
@@ -923,7 +923,7 @@ the most important acceleration options are discussed here.
 .TP 7
 .BI "Option \*qAccelerationProfile\*q  \*q" integer \*q
 Select the profile, which determines actual acceleration as a function of
-device velocity and acceleration controls (acceleartion and threshold, dubbed
+device velocity and acceleration controls (acceleration and threshold, dubbed
 pointer feedback). This is mainly a matter of personal preference.
 .PP
 .RS 6
@@ -933,7 +933,7 @@ pointer feedback). This is mainly a matter of personal 
preference.
 .B  " 1      device-dependent"
 .B  " 2      polynomial (polynomial function)"
 .B  " 3      smooth linear (hockey)"
-.B  " 4      simple (normal wehn slow, then accelerated)"
+.B  " 4      simple (normal when slow, otherwise accelerated)"
 .B  " 5      power (power function)"
 .B  " 6      linear (more speed, more acceleration)"
 .B  " 7      limited (like linear, but maxes out at threshold)"
-- 
1.6.4.4

>From 80240896454494a7ff2179752b541a10cfbd36e0 Mon Sep 17 00:00:00 2001
From: Simon Thum <[email protected]>
Date: Thu, 7 Jan 2010 13:03:05 +0100
Subject: [PATCH 2/2] some wording changes aimed at simplification

also, the hockey function seemingly has been taken to mean something
else.

Signed-off-by: Simon Thum <[email protected]>
---
 hw/xfree86/doc/man/xorg.conf.man.pre |   21 +++++++++++----------
 1 files changed, 11 insertions(+), 10 deletions(-)

diff --git a/hw/xfree86/doc/man/xorg.conf.man.pre 
b/hw/xfree86/doc/man/xorg.conf.man.pre
index a21bcf0..84d0d09 100644
--- a/hw/xfree86/doc/man/xorg.conf.man.pre
+++ b/hw/xfree86/doc/man/xorg.conf.man.pre
@@ -922,9 +922,10 @@ these can be adjusted at runtime, see the xinput(1) man 
page for details. Only
 the most important acceleration options are discussed here.
 .TP 7
 .BI "Option \*qAccelerationProfile\*q  \*q" integer \*q
-Select the profile, which determines actual acceleration as a function of
-device velocity and acceleration controls (acceleration and threshold, dubbed
-pointer feedback). This is mainly a matter of personal preference.
+Select the profile. In layman's terms, the profile constitutes the "feeling" of
+the acceleration. More formally, it defines how the transfer function (actual
+acceleration as a function of current device velocity and acceleration 
controls)
+is constructed. This is mainly a matter of personal preference.
 .PP
 .RS 6
 .nf
@@ -932,7 +933,7 @@ pointer feedback). This is mainly a matter of personal 
preference.
 .B  "-1      none (only constant deceleration is applied)"
 .B  " 1      device-dependent"
 .B  " 2      polynomial (polynomial function)"
-.B  " 3      smooth linear (hockey)"
+.B  " 3      smooth linear (soft knee, then linear)"
 .B  " 4      simple (normal when slow, otherwise accelerated)"
 .B  " 5      power (power function)"
 .B  " 6      linear (more speed, more acceleration)"
@@ -948,7 +949,7 @@ times slower than normal. Most useful for high-resolution 
devices.
 .BI "Option \*qAdaptiveDeceleration\*q  \*q" real \*q
 Allows to actually decelerate the pointer when going slow. At most, it will be
 .B adaptive deceleration
-times slower. Use this for very accurate hit-the-pixel work.
+times slower. Enables precise pointer placement without sacrificing speed.
 .TP 7
 .BI "Option \*qAccelerationScheme\*q  \*q" string \*q
 Selects the scheme, which is the underlying algorithm.
@@ -962,17 +963,17 @@ Selects the scheme, which is the underlying algorithm.
 .RE
 .TP 7
 .BI "Option \*qAccelerationNumerator\*q  \*q" integer \*q
-Set the numerator of the acceleration factor.
 .TP 7
 .BI "Option \*qAccelerationDenominator\*q  \*q" integer \*q
-Set the denominator of the acceleration factor. The acceleration factor is a
-rational which, together with threshold, can be used to tweak profiles to suit
-the users needs. The
+Set numerator and denominator of the acceleration factor. The acceleration
+factor is a rational which, together with threshold, can be used to tweak
+profiles to suit the users needs. The
 .B simple
 and
 .B limited
 profiles use it directly (i.e. they accelerate by the factor), for other
-profiles it should hold that higher acceleration leads to more acceleration.
+profiles it should hold that a higher acceleration factor leads to a faster
+pointer. Typically, 1 is unaccelerated and values up to 5 are sensible.
 .TP 7
 .BI "Option \*qAccelerationThreshold\*q  \*q" integer \*q
 Set the threshold, which is roughly the velocity (usually device units per 10
-- 
1.6.4.4

_______________________________________________
xorg-devel mailing list
[email protected]
http://lists.x.org/mailman/listinfo/xorg-devel

Reply via email to