[PATCH] doc: compact installation instructions

[Peter Hutterer]

On Tue, Apr 25, 2017 at 11:29:07AM +0200, Jan Engelhardt wrote:
> * Drop version-specific SO version from source-install command where
>   this is not needed.
> * Less typing for the user: use zypper short forms.
> * Less typing for the user: libtool implies automake implies
>   autoconf, so trim the install command.

is anyone actually typing this? or do they just copy-paste anyway? I suspect
the latter, so I much prefer clarity over shortness.

> * Just specify the requirement for a root shell instead of lengthily
>   prefixing everything with one specific tool.
>   (People might be using, for example, kdesu/gksu.)
> ---
>  doc/building.dox | 28 ++++++++++++++--------------
>  1 file changed, 14 insertions(+), 14 deletions(-)
> 
> diff --git a/doc/building.dox b/doc/building.dox
> index 9bafa32..53829eb 100644
> --- a/doc/building.dox
> +++ b/doc/building.dox
> @@ -59,15 +59,15 @@ $> sudo make uninstall
>  @endcode
>  
>  The following commands reinstall the current system package for libinput,
> -overwriting manually installed files.
> +overwriting manually installed files. As root, issue:

nope to this, I prefer sudo because it's a lot more explicit than an
almost-hidden "as root". and yes, I still get occasional complaints of users
that don't know they need to be root to install. And I suspect that if
you're using kdesu/gksu then you're more likely to know to leave sudo off
(or leave it in, doesn't matter).

>  <ul>
> -<li><b>Debian/Ubuntu</b> based distributions: ```sudo apt-get install
> +<li><b>Debian/Ubuntu</b> based distributions: ```apt-get install
>  --reinstall libinput```</li>
> -<li><b>Fedora 22</b> and later: ```sudo dnf reinstall libinput```</li>
> -<li><b>RHEL/CentOS/Fedora 21</b> and earlier: ```sudo yum reinstall libinput```</li>
> -<li><b>openSUSE</b>: ```sudo zypper install --force libinput10```</li>
> -<li><b>Arch</b>: ```sudo packman -S libinput```</li>
> +<li><b>Fedora 22</b> and later: ```dnf reinstall libinput```</li>
> +<li><b>RHEL/CentOS/Fedora 21</b> and earlier: ```yum reinstall libinput```</li>
> +<li><b>openSUSE</b>: ```zypper in -f libinput10```</li>

tbh, this doesn't really help. yes, it may be a short form, but
"install --force" is a lot more readable and obvious if something goes
wrong.


> +<li><b>Arch</b>: ```pacman -S libinput```</li>

>  </ul>
>  
>  @subsection building_dependencies Build dependencies
> @@ -75,19 +75,19 @@ overwriting manually installed files.
>  libinput has a few build-time dependencies that must be installed prior to
>  running configure. In most cases, it is sufficient to install the
>  dependencies that your distribution uses to build the libinput package.
> -These can be installed with one of the following commands:
> +These can be installed with one of the following commands in a root shell:
>  
>  <ul>
> -<li><b>Debian/Ubuntu</b> based distributions: ```sudo apt-get build-dep
> +<li><b>Debian/Ubuntu</b> based distributions: ```apt-get build-dep
>  libinput```</li>
> -<li><b>Fedora 22</b> and later: ```sudo dnf builddep libinput```</li>
> -<li><b>RHEL/CentOS/Fedora 21</b> and earlier: ```sudo yum-builddep libinput```</li>
> +<li><b>Fedora 22</b> and later: ```dnf builddep libinput```</li>
> +<li><b>RHEL/CentOS/Fedora 21</b> and earlier: ```yum-builddep libinput```</li>
>  <li><b>openSUSE</b>:
>  <pre>
> -$> sudo zypper modifyrepo --enable `zypper repos | grep source | awk '{print $5}'`
> -$> sudo zypper source-install -d libinput10
> -$> sudo zypper install autoconf automake libtool
> -$> sudo zypper modifyrepo --disable `zypper repos | grep source | awk '{print $5}'`
> +# zypper modifyrepo --enable `zypper repos | grep source | awk '{print $5}'`
> +# zypper si -d libinput
> +# zypper in libtool
> +# zypper modifyrepo --disable `zypper repos | grep source | awk '{print $5}'`

any particular reason why to use # here? 

Cheers,
   Peter

>  </pre>
>  </li>
>  <li><b>Arch</b>:
> -- 
> 2.12.0
>