summaryrefslogtreecommitdiff
path: root/doc
AgeCommit message (Collapse)AuthorFilesLines
2019-02-05quirks: add a quirk to ignore unreliable tablet mode switch devicesPeter Hutterer1-0/+2
On the Asus Vivobook Flip 14, the tablet mode switch is unreliable and always on. Instead of marking every device as 'do not suspend', just mark the tablet switch itself. Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
2019-01-16doc/user: fix a leftover html tagPeter Hutterer1-1/+1
Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
2018-11-27doc/user: bugzilla → gitlab issuePeter Hutterer1-1/+1
Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
2018-10-29quirks: add the ability to disable custom event codes/typesPeter Hutterer1-0/+4
This is a more flexible approach than adding a model flag and the C code to just call libevdev_disable_event_code(). There's a risk users will think this is is a configuration API but there are some devices out there (e.g. the Microsoft Sculpt mouse) that need a more generic solution. Case in point: the Sculpt mouse insists on holding BTN_SIDE down at all times. We cannot ship any quirks for that device because we only have the receiver's generic VID/PID. So a local override is required, but we might as well make that one generic enough to catch other devices too in the future. Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
2018-10-03doc/user: add a warning that udevadm test doesn't always workPeter Hutterer1-0/+5
We rely on the udev keyboard builtin to set the fuzz but that builtin isn't run during udevadm test. So running sudo udevadm test shows the LIBINPUT_FUZZ properties the first time round (still set from boot), but not the second time. Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
2018-10-03doc/user: fix typoPeter Hutterer1-1/+1
Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
2018-09-18doc: fix libinput_event_destroy parameterDiego Rondini1-1/+1
Fix libinput_event_destroy call by passing the correct parameter (event) in the example code. Signed-off-by: Diego Rondini <diego.rondini@kynetics.com>
2018-09-17Fixes incorrect bug reporting documentationBennett Hardwick1-1/+1
2018-09-04doc/user: update the trackpoint pointer acceleration graphPeter Hutterer1-80/+38
Never got updated when the new code was merged Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
2018-08-29doc/user: expand the Contributing documentPeter Hutterer1-9/+164
This is mostly taken from the Weston Contributing.md document. Main changes from there are: - more detailed step-by-step on how to create a MR - commit history/messages in two sections - s/Weston/libinput/ I skipped the Review/Commit Rights sections for now until there's some demand for it. Same with the Licensing/Stabilising for releases sections. Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net> Acked-by: Pekka Paalanen <pekka.paalanen@collabora.co.uk> Acked-by: Daniel Stone <daniels@collabora.com>
2018-08-20doc/user: move the tablet capabilities debugging to a separate pagePeter Hutterer4-34/+46
Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
2018-08-19doc/user: correct some small typosMatt Mayfield4-4/+4
2018-08-16doc/user: move the trackpoint multiplier debugging to TroubleshootingPeter Hutterer5-144/+169
Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
2018-08-16doc/user: fix two links for sphinx syntaxPeter Hutterer1-5/+7
Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
2018-08-10doc/user: move touchpad jitter to troubleshootingPeter Hutterer2-1/+1
Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
2018-08-10doc/user: move the jumping cursor page to troubleshootingPeter Hutterer2-1/+1
Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
2018-08-09doc: use configure_file()'s @PLAINNAME@ instead of calling installPeter Hutterer2-18/+36
Instead of calling out to install on every ninja call, use @PLAINNAME@ as substitution for just copying the file over. This gets around the "no directory allowed in output file" limitation. Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
2018-08-09doc/api: drop git-version.doxPeter Hutterer2-9/+2
No longer needed Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
2018-08-08doc/user: add 90-degree scroll behaviorMatt Mayfield1-0/+4
2018-08-06doc/user: drop the sphinx -a flagPeter Hutterer1-2/+1
Let's trust sphinx to know what to rebuild Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
2018-08-06doc/user: add touchpad pressure debugging as separate pagePeter Hutterer4-186/+211
This way we can put it under Troubleshooting Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
2018-08-06doc/user: add the quirks tool to the tool listPeter Hutterer1-0/+16
Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
2018-08-06doc/user: match the quirks list output with the codePeter Hutterer1-2/+2
Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
2018-08-03doc/user: mark the touchpads page as orphanPeter Hutterer1-0/+2
Only one link leads to it and it doesnt (right now) fit into the hierarchy. Let's get rid of the sphinx warning. Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
2018-08-03doc/user: add custom 404 pages for the old linksPeter Hutterer2-1/+76
Switching from doxygen to sphinx broke a bunch of links because doxygen used whatever the argument to @page was - and that usually had underscores. Sphinx uses filenames (which use dashes) so now we have a bunch of old links going to a 404. For the transition period at least, insert a custom 404 page for each of those to tell users this doesn't exist anymore. Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
2018-08-03Revert "doc/user: add a custom 404 page"Peter Hutterer3-15/+0
Nope, doesn't work, our server doesn't support htaccess. This reverts commit 548e0eb98b46e328a64215323962c11df17b49ce.
2018-08-02doc/user: add a custom 404 pagePeter Hutterer3-0/+15
Things moved around, so let's have a custom 404 page where we can put information in. This ist the barebones version, not sure if .htaccess is supported. Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
2018-08-02doc: drop the doxygen conversion scriptPeter Hutterer1-83/+0
It's really not that good, so no point to keep it around Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
2018-08-02doc/user: rename filenames with underscores to dashesPeter Hutterer3-2/+2
Everything else is, let's be consistent here. Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
2018-08-02doc/user: swap some note out with hintPeter Hutterer3-6/+6
Because why not... Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
2018-08-02doc/user: add a hack to get to the git versionPeter Hutterer5-11/+40
meson doesn't have configuration_data() in vcs_tag so we can only replace one string. sphinx cannot include things in-line. Since we want the git version to be replaced in random places, we need to put it into rst_prolog in conf.py - but that's where we neet to replace other things too. Work around this by generating a mini python module that returns the git version, then call that in conf.py. Side-bonus: we now have access to the full commit and the abbreviated commit. Not that anything actually uses this... Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
2018-08-02doc/user: drop the old page-hierarchy pagePeter Hutterer1-84/+0
Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
2018-08-02doc/user: use extlink for a common commit linksPeter Hutterer3-5/+9
Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
2018-08-02doc/user: more fixes including adding a device-types sectionPeter Hutterer11-37/+86
Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
2018-08-02doc/user: tidy up the development pagePeter Hutterer1-10/+14
Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
2018-08-01doc/user: more documentation cleanups and fixesPeter Hutterer9-88/+559
Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
2018-07-31doc/user: some rewording and improvementsPeter Hutterer5-52/+76
Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
2018-07-31doc/user: update the 'no package found' link to the meson version postPeter Hutterer1-1/+1
Now that we dropped autotools anyway, it's better to link to the meson version of that blog post. Related #96 Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
2018-07-31doc/user: building - promote dependencies to a higher-level sectionPeter Hutterer1-2/+2
Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
2018-07-31doc/user: the SELinux section doesn't apply to modern mesonPeter Hutterer1-0/+2
Related #96 Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
2018-07-31doc/user: re-do the conditional build sectionPeter Hutterer1-38/+31
Related #96 Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
2018-07-31doc/user: drop the autotools buildsPeter Hutterer1-59/+4
Anyone who's still on <= 1.8 either knows how to build it already or relies on a distribution to do that for them. Drop the section. Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
2018-07-31doc/user: add a note on meson's dependency() in the building docsPeter Hutterer1-2/+10
See #96 Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
2018-07-31doc/user: mesonconf is meson configurePeter Hutterer1-3/+3
Listed in #96 Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
2018-07-30doc/user: add a page detailing what configuration toggles are availablePeter Hutterer3-0/+161
High level view only but at least it's a link we can point people to. Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
2018-07-30dox: switch to sphinx for the user-visible documentationPeter Hutterer97-2825/+4271
This is a large commit because it's difficult to split this up and we don't care about bisecting here anyway. doxygen is going to produce the API documentation only sphinx is going to produce the prose user (and a bit of developer) documentation. The source split is doc/api and doc/user. Steps performed: - run the doxygen-to-sphinx.sh script to convert all .dox sources to .rst - manually fixed the .rst to render correctly - add a few extra .rst documents to generate the right hierarchy - hook up sphinx-build in meson - add a new @mainpage for doxygen more aimed at developers For the build directory: - sphinx produces /Documentation - doxygen now produces /api/ These need to be manually combined in the wayland-web repo, meson doesn't support subdirectories as output paths within the build dir and the documentation doesn't need to be installed anywhere. Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
2018-07-27doc: split the graphs into a separate array for re-usePeter Hutterer1-37/+40
We need this in the sphinx documentation. Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
2018-07-27doc: move the @verbatim start to the list itemPeter Hutterer1-4/+2
This is mostly for sphinx' parsing benefit, doxygen doesn't need it and renders the same either way. Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
2018-07-27doc: device-quirks: redo the model quirks <dl> for sphinx' benefitPeter Hutterer1-13/+5
sphinx only supports one line of <dt> content, so we have to compress these. Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
2018-07-27doc: a few replacements to make sphinx happy/prettierPeter Hutterer3-3/+8
Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
generated by cgit v1.2.3 (git 2.39.1) at 2024-11-28 04:17:22 +0000