[PATCH weston] man: Clarify weston.ini scale option

[Yong Bakos]

On Apr 22, 2016, at 2:52 AM, Pekka Paalanen <ppaalanen at gmail.com> wrote:
> 
> On Thu, 21 Apr 2016 13:49:18 -0700
> Bryce Harrington <bryce at osg.samsung.com> wrote:
> 
>> On Thu, Apr 21, 2016 at 02:21:38PM -0500, Yong Bakos wrote:
>>> On Apr 21, 2016, at 2:15 PM, Bryce Harrington <bryce at osg.samsung.com> wrote:
>>>> 
>>>> On Thu, Apr 21, 2016 at 12:49:29PM -0500, Yong Bakos wrote:
>>>>> From: Yong Bakos <ybakos at humanoriented.com>
>>>>> 
>>>>> Add explanations of scaling that are a bit more approachable for users.
>>>>> 
>>>>> https://bugs.freedesktop.org/show_bug.cgi?id=94824
>>>>> 
>>>>> Signed-off-by: Yong Bakos <ybakos at humanoriented.com>
>>>> 
>>>> Looks good,
>>>> 
>>>> Reviewed-by: Bryce Harrington <bryce at osg.samsung.com>
>>>> 
>>>> Btw in changelogs when referring to bug tickets, a standard syntax is:
>>>> 
>>>> Fixes: https://bugs.freedesktop.org/show_bug.cgi?id=94824
>>>> 
>>>> if the patch is intended to close the bug report as fixed, as in this
>>>> case.
>>> 
>>> Thanks - yeah, I /just/ noticed this after sending the patch while
>>> reviewing other bugzilla-related stuff. It's no problem if you'd like
>>> me to send a v2 with this change.
>> 
>> Nah, this is fine.  I just mention it for future reference since I know
>> you like to know about the conventions for doing stuff.
>> 
>> I think this patch is probably ready to land but holding off a bit in
>> case others have input to give.
>> 
>> Bryce
>>> yong
>>> 
>>> 
>>> 
>>>> (Some bug trackers have watches on the vcs to notice this syntax and
>>>> automatically close the bugs with a link to the commit.  I don't think
>>>> we have bugzilla configured for doing this, but it's a good practice to
>>>> follow nonetheless.)
>>>> 
>>>> Bryce
>>>> 
>>>>> ---
>>>>> man/weston.ini.man | 17 +++++++++++------
>>>>> 1 file changed, 11 insertions(+), 6 deletions(-)
>>>>> 
>>>>> diff --git a/man/weston.ini.man b/man/weston.ini.man
>>>>> index 8cdc837..6fbeaf0 100644
>>>>> --- a/man/weston.ini.man
>>>>> +++ b/man/weston.ini.man
>>>>> @@ -389,15 +389,20 @@ be one of the following 8 strings:
>>>>> .RE
>>>>> .TP 7
>>>>> .BI "scale=" factor
>>>>> -An integer, 1 by default, typically configured as 2 when needed, denoting
>>>>> -the scale factor of the output. Applications that support it render at the
>>>>> -appropriate scale. For other applications, weston will scale their output
>>>>> -by this factor.
>>>>> +The scaling multiplier applied to the entire output, in support of high
>>>>> +resolution ("HiDPI" or "retina") displays. Applications that do not support high
>>>>> +resolution displays typically appear tiny and unreadable. Weston will scale the
>>>>> +output of such applications by this multiplier, to make them readable.
>>>>> +Applications that do support their own output scaling can draw their content in
>>>>> +high resolution, in which case they avoid compositor scaling. Weston will not
>>>>> +scale the output of such applications, and they are not affected by this
>>>>> +multiplier.
>>>>> .RE
>>>>> .RS
>>>>> .PP
>>>>> -Use a value of 2 for outputs with high resolution. Such displays are often
>>>>> -called "HiDPI" or "retina" displays.
>>>>> +An integer, 1 by default, typically configured as 2 or higher when needed,
>>>>> +denoting the scale factor of the output. This scale factor corresponds with
>>>>> +the pixel density of the display.
> 
> Hi,
> 
> I might say "This scale factor roughly corresponds", but either way:

Agreed, I'll fix in a v2. Perhaps 'roughly correlates with' is even better, since
'corresponds' infers a matching/similarity, and pixel density is often measured
as PPI rather than a density factor (scale != ppi).

Thanks for reviewing,
yong


> Reviewed-by: Pekka Paalanen <pekka.paalanen at collabora.co.uk>
> 
> 
> Thanks,
> pq
-------------- next part --------------
A non-text attachment was scrubbed...
Name: signature.asc
Type: application/pgp-signature
Size: 842 bytes
Desc: Message signed with OpenPGP using GPGMail
URL: <https://lists.freedesktop.org/archives/wayland-devel/attachments/20160422/0b50996a/attachment.sig>