summaryrefslogtreecommitdiff
path: root/doc
AgeCommit message (Collapse)AuthorFilesLines
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>
2018-07-27doc: enable warnings in doxygenPeter Hutterer1-0/+1
We want to see missed links Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
2018-07-27doc: move the Architecture blurb to the 'what is libinput' pagePeter Hutterer1-0/+34
The vast majority of ppl reading the README is unlikely to care about this, but they do care about the Wayland vs X.Org situation so let's split this up. Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
2018-07-26doc: we don't need the Namespaces doxygen pagePeter Hutterer1-0/+1
Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
2018-07-26doc: fix erroneous </dt>Peter Hutterer1-2/+1
Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
2018-07-26doc: fix the url where to file a new bugPeter Hutterer1-2/+2
2018-07-26doc: add a warning note that the reporting-bugs instructions do matterPeter Hutterer1-4/+4
And remove the paragraph below that states the same thing. Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
2018-07-26doc: point to libinput --versionPeter Hutterer1-1/+1
This will fail pre 1.8 but oh well. Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
2018-07-26doc: replace a few <b> with markdown's **Peter Hutterer1-13/+11
At least where possible, doxygen doesn't parse lists starting with ** as emphasized. Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
2018-07-26doc: replace html lists with markdown onesPeter Hutterer1-18/+14
Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
2018-07-26doc: reporting-bugs: use evemu-record as link text, not evemuPeter Hutterer1-1/+1
Because that's the tool we're using Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
2018-07-26doc: single ` is enough for code highlightingPeter Hutterer5-33/+33
Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
2018-07-26doc: indent all @note continuation linesPeter Hutterer11-42/+44
This isn't required by doxygen but for a potential switch to RTD/sphinx (see #95) it helps having this set up correctly. Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
2018-07-25doc: document the device quirksPeter Hutterer4-2/+92
Add some documentation for the most common quirks or at least the ones that the user may eventually see or have to set. Drop the git commit hash into the docs to make sure it's spelled out that the quirks are only valid for that commit. Adding something with @include* requires the EXAMPLE_PATH to be set. Doxygen doesn't parse markdown in @includedoc so we have to insert the commit as normal HTML tag. Related to https://gitlab.freedesktop.org/libinput/libinput/issues/87 Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
2018-07-24doc: fix ref to device-quirksPeter Hutterer1-1/+1
Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
2018-07-24doc: replace <a href> links with the doxygen markdown equivalentPeter Hutterer11-51/+46
Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
2018-07-24doc: replace <pre> with @verbatimPeter Hutterer6-38/+38
Be more consistent here Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
2018-07-24doc: add a section name to seats-overviewPeter Hutterer1-1/+1
Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
2018-07-19doc: add a section to the FAQs "is libinput required for Wayland"Peter Hutterer1-0/+23
Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
2018-07-19doc: move the "General" section to the "Developer" sectionPeter Hutterer1-7/+4
The info here is mostly developer-oriented, let's group this together. Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
2018-07-19doc: fix references to a trackpoint range in the FAQsPeter Hutterer1-2/+2
Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
2018-07-19doc: break up the "what is libinput" page with two sectionsPeter Hutterer1-0/+4
Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
2018-07-13Rename data/ to quirks/Peter Hutterer2-3/+3
A better, less ambiguous name than just "datadir" Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
2018-07-12Merge branch 'wip/trackpoint-acceleration'Peter Hutterer4-128/+264
2018-07-12doc: move the meson.build in as subdir()Peter Hutterer2-10/+149
Doing so means we can ditch the specific input list for doxygen and just copy all files over into our builddir/doc/ subdir, then use that subdirectory as input data. This relies on meson putting a subdir() into a subdirectory in the build directory. This isn't technically guaranteed but I also suspect that if meson ever changes that, lots of other projects will break. Even in that case we should build just fine since we now filter for *.h and *.dox and don't copy any other doxygen-commented files into the builddir anyway. Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
2018-07-11filter: add a trackpoint multiplier factorPeter Hutterer3-108/+253
Measuring the trackpoint range has not shown to be sufficient or precise enough to be used as an ingredient for trackpoint acceleration. So let's just switch back to a generic multiplier that we can apply to the input deltas do undo any device-specific lack of scaling. Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
2018-07-11filter: replace the trackpoint accel with a velocity-based onePeter Hutterer1-20/+10
This gets rid of the trackpoint range propery that we've been parsing until now and instead just opts for a basic curve with some deceleration for low pressure. The speed range is taken from the touchpad and should be wide enough for most trackpoints that fall within the expected range. Trackpoints like the new ALPS ones need to be configured through a hwdb (this part is currently missing). Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
2018-07-10doc: add a subsection on how to use libinput record --autorestartPeter Hutterer1-0/+29
Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
2018-07-10doc: libinput-measure is a section, not a subsectionPeter Hutterer1-1/+1
Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
2018-07-06doc: drop the git version into the documentationPeter Hutterer1-1/+1
The libinput/doc/latest is now built automatically from git, so it's good to have a reference to show which commit it was being built from. Add a section to the readme with git commit information that is replaced by meson. Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
2018-07-05doc: add the switches page to a "other devices" categoryPeter Hutterer2-3/+7
It felt a bit lost at the bottom of the "pages" list. Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
2018-07-05doc: build doxygen output into "Documentation"Peter Hutterer1-0/+1
Slightly more obvious than just "html". Main motivation here is that we want to provide the documentation as artifact from GitLab's CI, so having it unzip to something slightly more meaningful makes sense. Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
2018-07-03tools: rename list-quirks to the more generic "quirks list"Peter Hutterer1-6/+8
Enables us to easily add more tools where needed and it is more consistent with the existing tools. The commands are now: libinput quirks list libinput quirks validate Fixes https://gitlab.freedesktop.org/libinput/libinput/issues/66 Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
2018-06-27doc: fix typo in pointer acceleration docsPeter Hutterer1-1/+1
Fixes https://gitlab.freedesktop.org/libinput/libinput/issues/69 Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
2018-06-21doc: update docs to use a .yml suffix for libinput recorded filesPeter Hutterer1-5/+5
Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
2018-06-21doc: use @verbatim, not @code for shell commandsPeter Hutterer5-58/+58
Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
2018-06-21doc: update docs to drop hwdb referencesPeter Hutterer5-130/+82
In favour of the device quirks system. Fixes #55 Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
2018-06-19doc: point to the gitlab ci file for a list of required packagesPeter Hutterer1-3/+12
Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
2018-06-08Implement a quirks system to replace the udev property parsingPeter Hutterer2-0/+103
Previously, we had all extra device information ("This is an Apple Touchpad", "This touchpad causes pointer jumps", etc.) in the udev hwdb. The problem with the hwdb is that updating it is nontrivial for the average user and debugging when things go wrong is even harder. Plus, the hwdb has a matching scheme that is unpredictable unless one is familiar with the implementation. This patch set moves the hwdb entries into .ini style text files, with a simple line-based parser. A new libinput list-quirks tool can list the quirks applied to any given device, in --verbose mode it prints all matches as they apply or not apply. The data files are currently unused by libinput, that comes in a later patch. They're installed though, the defaults point to the /usr/share/libinput directory and for *temporary* local overrides the single file /etc/libinput/local-overrides.quirks. Failure to parse any file is a hard failure for the quirks system, but if the local override file doesn't exist that's fine. THIS IS NOT A CONFIGURATION INTERFACE! None of these settings are exposed via the libinput_device_config_* calls. There is no API guarantee for these files, think of them as source code. Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
2018-06-05doc: Fix URLs for GitLab, HTTPSDaniel Stone4-6/+6
The GitLab migrations means that bugs should now be reported there rather than Bugzilla. Though the repository is still available via anongit, cloning through GitLab allows use of HTTPS. All freedesktop.org URLs are also preferentially served over HTTPS rather than unsecured HTTP. Signed-off-by: Daniel Stone <daniels@collabora.com>
2018-06-04doc: point at --verbose for libinput debug-eventsPeter Hutterer1-1/+2
Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
2018-06-04doc: improve the 'tools' pagePeter Hutterer1-20/+80
Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
2018-06-01doc: move the "Users" section to the top of the "pages" sectionPeter Hutterer1-7/+8
On the off-chance that someone actually looks at this page, let's put the comment most at risk by a TLDR attention span at the top. Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
2018-05-30Restore the old trackpoint pointer accel picturePeter Hutterer1-30/+111
Accidentally updated the wrong picture. This reverts part of commit d6e531349745ff38ae457169d5089ea61297accf. Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
2018-05-30doc: update the touchpad pointer acceleration graphsPeter Hutterer1-363/+378
Part of d6e531349745ff38ae457169d5089ea61297accf but I updated the wrong svg in that commit. Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
2018-05-21Merge branch 'wip/custom-pointer-accel-revert'Peter Hutterer2-356/+0
2018-05-21Merge branch 'wip/touchpad-pointer-accel-v7'Peter Hutterer1-111/+30
generated by cgit v1.2.3 (git 2.39.1) at 2024-04-25 14:13:53 +0000