Details
-
Bug
-
Resolution: Unresolved
-
P2: Important
-
None
-
5.15.10, 6.5.4
-
None
-
Gentoo x86_64 - kernel 6.1.46
Qt 5.15.10
llvm/clang 16.0.6
Description
Discovered by accident that documentation for QSettings class is incomplete. Documentation does not clarify that "General" is considered a "reserved" section heading for ini-based settings usage.
Docs discuss usage of the "%" character to escape certain non-ini usable characters to circumvent limitation of ini-file usage/commonly understood specifications. (see QSettings::Format enum description end paragraphs).
However, documentation does not mention the hard-coded Qt-specific implementation.
See:
qsettings.cpp - 5.15 branch line 1869.
qsettings.cpp - head (6.5.x) branch line 1821.
An advanced search of Qt Bug reports with advanced search:
text ~ "QSettings" AND text ~ "General"
will reveal multiple instances where users are confronted with this situation and/or misunderstand what is being done inside QSettings sources.
Recommend that the behavior of QSettings and usage of "General" as a reserved word be fully documented for users to appreciate what is being imposed, as well as, minimize noise with erroneous/invalid bugs.