diff options
author | Peter Hutterer <peter.hutterer@who-t.net> | 2018-07-24 13:01:23 +1000 |
---|---|---|
committer | Peter Hutterer <peter.hutterer@who-t.net> | 2018-07-26 09:04:33 +1000 |
commit | 80273c050ee7591410a58b3b33b405ebe9e9b1bb (patch) | |
tree | 5e65e17c46eb2a3adc96e90cdc3024b215555b2e /doc | |
parent | c1f010a6ebe5df6265d161f3ae1bf8a22167e1d2 (diff) |
doc: single ` is enough for code highlighting
Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
Diffstat (limited to 'doc')
-rw-r--r-- | doc/building.dox | 34 | ||||
-rw-r--r-- | doc/contributing.dox | 2 | ||||
-rw-r--r-- | doc/palm-detection.dox | 2 | ||||
-rw-r--r-- | doc/reporting-bugs.dox | 2 | ||||
-rw-r--r-- | doc/touchpad-pressure.dox | 26 |
5 files changed, 33 insertions, 33 deletions
diff --git a/doc/building.dox b/doc/building.dox index ba0c593d..d284c7ea 100644 --- a/doc/building.dox +++ b/doc/building.dox @@ -38,8 +38,8 @@ $> meson --prefix=/usr -Ddocumentation=false builddir/ We recommend that users disable the documentation, it's not usually required for testing and reduces the number of dependencies needed. -The ```prefix``` or other options can be changed later with the -```mesonconf``` command. For example: +The `prefix` or other options can be changed later with the +`mesonconf` command. For example: @verbatim $> mesonconf builddir/ -Dprefix=/some/other/prefix -Ddocumentation=true $> ninja -C builddir @@ -72,7 +72,7 @@ lrwxrwxrwx 1 root root 19 Feb 1 15:12 /usr/lib64/libinput.so.10 -> libinput The recommended way to revert to the system install is to use the package manager to reinstall the libinput package. In some cases, this may leave -files in the system (e.g. ```/usr/lib/libinput.la```) but these files are +files in the system (e.g. `/usr/lib/libinput.la`) but these files are usually harmless. To definitely remove all files, run the following command from the libinput source directory: @@ -86,12 +86,12 @@ The following commands reinstall the current system package for libinput, overwriting manually installed files. <ul> -<li><b>Debian/Ubuntu</b> based distributions: ```sudo 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>Debian/Ubuntu</b> based distributions: `sudo 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> </ul> @subsection building_selinux SELinux adjustments @@ -107,8 +107,8 @@ May 25 15:28:42 localhost.localdomain org.gnome.Shell.desktop[23270]: /usr/bin/g @endverbatim The summary of this error message is that gdm's gnome-shell runs in the -```system_u:system_r:xdm_t``` context but libinput is installed with the -context ```unconfined_u:object_r:user_home_t```. +`system_u:system_r:xdm_t` context but libinput is installed with the +context `unconfined_u:object_r:user_home_t`. To avoid this issue, restore the SELinux context for any system files. @@ -133,10 +133,10 @@ distribution uses to build the libinput package. These can be installed with one of the following commands: <ul> -<li><b>Debian/Ubuntu</b> based distributions: ```sudo 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>Debian/Ubuntu</b> based distributions: `sudo 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>openSUSE</b>: @verbatim $> sudo zypper modifyrepo --enable `zypper repos | grep source | awk '{print $5}'` @@ -156,7 +156,7 @@ $> makepkg --syncdeps --nobuild --noextract </li> </ul> -If dependencies are missing, a message ```No package 'foo' found``` will be +If dependencies are missing, a message `No package 'foo' found` will be shown during the configure stage. See [this blog post here](https://who-t.blogspot.com.au/2014/05/configure-fails-with-no-package-foo.html) for instructions on how to fix it. @@ -209,7 +209,7 @@ $> sudo udevadm hwdb --update @endverbatim @note On Debian-based distributions including Ubuntu and its derivatives skip the - ```--libdir=/usr/lib64``` argument. + `--libdir=/usr/lib64` argument. To uninstall libinput as detailed in section @ref reverting_install, run diff --git a/doc/contributing.dox b/doc/contributing.dox index 9dd17c8e..335ce6e0 100644 --- a/doc/contributing.dox +++ b/doc/contributing.dox @@ -5,7 +5,7 @@ Contributions to libinput are always welcome. Any patches should be sent to the [wayland-devel](https://lists.freedesktop.org/mailman/listinfo/wayland-devel) -email list with a subject prefix of ````[PATCH libinput]````. The easiest +email list with a subject prefix of `[PATCH libinput]`. The easiest way to achieve that is to run the following command in the libinput repository: diff --git a/doc/palm-detection.dox b/doc/palm-detection.dox index 537b6da3..75fdd90e 100644 --- a/doc/palm-detection.dox +++ b/doc/palm-detection.dox @@ -32,7 +32,7 @@ disable-while-typing. @section palm_tool Palm detection based on firmware labelling Some devices provide palm detection in the firmware, forwarded by the kernel -as the ```EV_ABS/ABS_MT_TOOL``` axis with a value of ```MT_TOOL_PALM``` +as the `EV_ABS/ABS_MT_TOOL` axis with a value of `MT_TOOL_PALM` (whenever a palm is detected). libinput honors that value and switches that touch to a palm. diff --git a/doc/reporting-bugs.dox b/doc/reporting-bugs.dox index d7a9550a..adc295f0 100644 --- a/doc/reporting-bugs.dox +++ b/doc/reporting-bugs.dox @@ -154,7 +154,7 @@ When you file a bug, please attach the following information: In many cases, we require the udev properties assigned to the device to verify whether device-specific quirks were applied. This can be obtained -with ````udevadm info /sys/class/input/eventX```, with the correct event +with `udevadm info /sys/class/input/eventX`, with the correct event node for your device. An example output is below: @verbatim diff --git a/doc/touchpad-pressure.dox b/doc/touchpad-pressure.dox index 43eff12d..6cc7f642 100644 --- a/doc/touchpad-pressure.dox +++ b/doc/touchpad-pressure.dox @@ -17,28 +17,28 @@ how to adjust the touch size ranges. @section kernel_pressure_information Information provided by the kernel The kernel sends multiple values to inform userspace about a finger touching -the touchpad. The most basic is the ```EV_KEY/BTN_TOUCH``` boolean event +the touchpad. The most basic is the `EV_KEY/BTN_TOUCH` boolean event that simply announces physical contact with the touchpad. The decision when this event is sent is usually made by the kernel driver and may depend on device-specific thresholds. These thresholds are transparent to userspace and cannot be modified. On touchpads where pressure or touch size is not -available, libinput uses ```BTN_TOUCH``` to determine when a finger is +available, libinput uses `BTN_TOUCH` to determine when a finger is logically down. Many contemporary touchpad devices provide an absolute pressure axis in -addition to ```BTN_TOUCH```. This pressure generally increases as the pressure +addition to `BTN_TOUCH`. This pressure generally increases as the pressure increases, however few touchpads are capable of detecting true pressure. The pressure value is usually related to the covered area - as the pressure increases a finger flattens and thus covers a larger area. The range provided by the kernel is not mapped to a specific physical range and -often requires adjustment. Pressure is sent by the ```ABS_PRESSURE``` axis -for single-touch touchpads or ```ABS_MT_PRESSURE``` on multi-touch capable +often requires adjustment. Pressure is sent by the `ABS_PRESSURE` axis +for single-touch touchpads or `ABS_MT_PRESSURE` on multi-touch capable touchpads. Some devices can detect multiple fingers but only provide -```ABS_PRESSURE```. +`ABS_PRESSURE`. Some devices provide additional touch size information through -the ```ABS_MT_TOUCH_MAJOR/ABS_MT_TOUCH_MINOR``` axes and/or -the ```ABS_MT_WIDTH_MAJOR/ABS_MT_WIDTH_MINOR``` axes. These axes specifcy +the `ABS_MT_TOUCH_MAJOR/ABS_MT_TOUCH_MINOR` axes and/or +the `ABS_MT_WIDTH_MAJOR/ABS_MT_WIDTH_MINOR` axes. These axes specifcy the size of the touch ellipse. While the kernel documentation specifies how these axes are supposed to be mapped, few devices forward reliable information. libinput uses these values together with a device-specific @@ -53,7 +53,7 @@ device-quirks locally. Note that the quirk is **not public API** and **may change at any time**. Users are advised to @ref reporting_bugs "report a bug" with the updated pressure ranges when testing has completed. -Use the ```libinput measure touchpad-pressure``` tool provided by libinput. +Use the `libinput measure touchpad-pressure` tool provided by libinput. This tool will search for your touchpad device and print some pressure statistics, including whether a touch is/was considered logically down. @@ -79,7 +79,7 @@ Touchpad pressure: 47 min: 47 max: 86 tags: down The example output shows five completed touch sequences and one ongoing one. For each, the respective minimum and maximum pressure values are printed as -well as some statistics. The ```tags``` show that sequence was considered +well as some statistics. The `tags` show that sequence was considered logically down at some point. This is an interactive tool and its output may change frequently. Refer to the <i>libinput-measure-touchpad-pressure(1)</i> man page for more details. @@ -148,11 +148,11 @@ device-quirks locally. Note that the quirk is **not public API** and **may change at any time**. Users are advised to @ref reporting_bugs "report a bug" with the updated pressure ranges when testing has completed. -Use the ```libinput measure touch-size``` tool provided by libinput. +Use the `libinput measure touch-size` tool provided by libinput. This tool will search for your touchpad device and print some touch size statistics, including whether a touch is/was considered logically down. -@note This tool will only work on touchpads with the ```ABS_MT_MAJOR``` axis. +@note This tool will only work on touchpads with the `ABS_MT_MAJOR` axis. Example output of the tool is below: @@ -175,7 +175,7 @@ Sequence: major: [ 4.. 33] minor: [ 1.. 5] down palm The example output shows five completed touch sequences. For each, the respective minimum and maximum pressure values are printed as well as some -statistics. The ```down``` and ```palm``` tags show that sequence was considered +statistics. The `down` and `palm` tags show that sequence was considered logically down or a palm at some point. This is an interactive tool and its output may change frequently. Refer to the <i>libinput-measure-touch-size(1)</i> man page for more details. |