summaryrefslogtreecommitdiffstats
path: root/tdeconf_update/Mainpage.dox
diff options
context:
space:
mode:
Diffstat (limited to 'tdeconf_update/Mainpage.dox')
-rw-r--r--tdeconf_update/Mainpage.dox31
1 files changed, 31 insertions, 0 deletions
diff --git a/tdeconf_update/Mainpage.dox b/tdeconf_update/Mainpage.dox
new file mode 100644
index 00000000..2557fe1c
--- /dev/null
+++ b/tdeconf_update/Mainpage.dox
@@ -0,0 +1,31 @@
+/** @mainpage ./tdeconf_update
+
+tdeconf_update is a tool designed to update config files. Over time applications
+sometimes need to rearrange the way configuration options are stored. Since
+such an update shouldn't influence the configuration options that the user
+has selected, the application must take care that the options stored in the
+old way will still be honored.
+
+What used to happen is that the application looks up both the old and the
+new configuration option and then decides which one to use. This method has
+several drawbacks:
+- The application may need to read more configuration files than strictly
+ needed, resulting in a slower startup.
+- The application becomes bigger with code that will only be used once.
+
+tdeconf_update addresses these problems by offering a framework to update
+configuration files without adding code to the application itself.
+
+See the README file for more information.
+
+@authors
+Waldo Bastian \<bastian@kde.org\>
+
+@maintainers
+[Unknown/None]
+
+@licenses
+@lgpl
+
+*/
+// vim:ts=4:sw=4:expandtab:filetype=doxygen