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

[Bryce Harrington]

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.

(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.
>  .RE
>  .TP 7
>  .BI "seat=" name
> -- 
> 2.7.2
> 
> _______________________________________________
> wayland-devel mailing list
> wayland-devel at lists.freedesktop.org
> https://lists.freedesktop.org/mailman/listinfo/wayland-devel