summaryrefslogtreecommitdiffstats
path: root/src/sensors/doc/src
diff options
context:
space:
mode:
authorJuha Vuolle <juha.vuolle@insta.fi>2021-06-28 12:58:09 +0300
committerQt Cherry-pick Bot <cherrypick_bot@qt-project.org>2021-07-01 10:42:26 +0000
commit0eba2b36582fd676a79646fe5f24e18c784523f2 (patch)
treeab0506c5932abbfdb100ce7a4fe4fb4479b9e883 /src/sensors/doc/src
parent42a47f9ab397de4476eb5c91194d03fa95bb5c37 (diff)
Fix and improve sensor configuration file lookup
This commit addresses some of the sensor configuration lookup issues - The CMake rule to use compile-time flag was opposite than intended - The configuration file is now looked from all returned configuration paths, not just the last one which seemed a bit arbitrary - Update related documentation, and while doing that also remove references to "N900" which probably won't say that much to people these days (N900 was a smart phone released 12 years ago) Task-number: QTBUG-92505 Task-number: QTBUG-92512 Change-Id: Ib66ae052a815bbe3af32bd896931e65375e8546e Reviewed-by: Timur Pocheptsov <timur.pocheptsov@qt.io> (cherry picked from commit 108e7d9e5fad438e565305104ec3712bff6561b6) Reviewed-by: Qt Cherry-pick Bot <cherrypick_bot@qt-project.org>
Diffstat (limited to 'src/sensors/doc/src')
-rw-r--r--src/sensors/doc/src/qtsensors-backend.qdoc25
1 files changed, 16 insertions, 9 deletions
diff --git a/src/sensors/doc/src/qtsensors-backend.qdoc b/src/sensors/doc/src/qtsensors-backend.qdoc
index 7e62186d..752e8f92 100644
--- a/src/sensors/doc/src/qtsensors-backend.qdoc
+++ b/src/sensors/doc/src/qtsensors-backend.qdoc
@@ -89,9 +89,9 @@ An example follows.
Sensors was designed so that multiple sensors could exist for a given type. Why?
Consider this example.
-The N900 has an accelerometer built-in. It also features bluetooth and can pair
-with a gaming controller that features an accelerometer. To a developer writing
-a game these two devices are conceptually the same type.
+An Android device has an accelerometer built-in. It also features bluetooth and
+can pair with a gaming controller that features an accelerometer. To a developer
+writing a game these two devices are conceptually the same type.
\section1 Default Sensor for a Type
@@ -109,21 +109,28 @@ instead.
\section1 Sensors.conf
-The config file that determines the default sensor for a type is called Sensors.conf.
-If present, it is located in /etc/xdg/QtProject. It has the standard formatting
-of an ini file.
+The config file that determines the default sensor for a type is called
+\e Sensors.conf. The configuration file is looked for from \e QtProject
+directory under the directories given by
+QStandardPaths::standardLocations(QStandardPaths::ConfigLocation).
+An example of a complete file path is:
+\badcode
+/etc/xdg/QtProject/Sensors.conf
+\endcode
+The first found configuration file is used.
+The configuration file has the standard formatting of an ini file.
The settings live in the Default group and the general format is:
\code
type = identifier
\endcode
-An example: Sensors.conf ensures that the N900 accelerometer is used by default,
-not considering the order in which backends were registered.
+An example: Sensors.conf ensures that the \e sensorfw accelerometer is used by
+default, ignoring the order in which backends were registered.
\code
[Default]
-QAccelerometer = n900.accelerometer
+QAccelerometer=sensorfw.accelerometer
\endcode
If Sensors.conf specifies an identifier that is not registered, the system will