From 62d74778fa315091c5f0b99093bd806a1ccd7a79 Mon Sep 17 00:00:00 2001 From: Christian Mollekopf Date: Tue, 15 Dec 2015 13:43:47 +0100 Subject: Docs --- docs/applicationdomaintypes.md | 17 +++++++++++++++++ docs/logging.md | 10 +++++----- 2 files changed, 22 insertions(+), 5 deletions(-) diff --git a/docs/applicationdomaintypes.md b/docs/applicationdomaintypes.md index b0097a6..502a349 100644 --- a/docs/applicationdomaintypes.md +++ b/docs/applicationdomaintypes.md @@ -31,6 +31,7 @@ This is a proposed set of types that we will need to evolve into what we actuall * Tag * Contact Group * Thread + * Akonadi Resource #### Properties ```no-highlight @@ -49,6 +50,22 @@ Event: startDate: The start date of the event. startTime: The start time of the event. Optional. ``` +```no-highlight +Mail: + uid: The message id. + subject: The subject of the email. + folder: The identifier of the parent folder. + date: The date of the email. + mimeMessage: A string containing the path to the mime message +``` +```no-highlight +Akonadi Resource: + type: The type of the resource. +``` +```no-highlight +Maildir Resource: + path: The path to the maildir. +``` ### References/Hierachies Some domain objects reference others, and that is often used to build hierarchies. diff --git a/docs/logging.md b/docs/logging.md index a88bc0f..a11a943 100644 --- a/docs/logging.md +++ b/docs/logging.md @@ -1,19 +1,19 @@ -For debugging purposes a logging framework is required. Simple qDebugs() proved to be insufficient for any non-trivial software. Developers should be enabled to add detailed debug information that allows to analize problems, and users should be enabled to record that information at runtime to debug a problem. The aim is to get away from the situation where developers remove messages because "it's to noisy", and then have to ship a special version with additional debug output to a user to debug a problem, just to then remove the debug output again. +For debugging purposes a logging framework is required. Simple qDebugs() proved to be insufficient for any non-trivial software. Developers should be enabled to add detailed debug information that allows to analyze problems, and users should be enabled to record that information at runtime to debug a problem. The aim is to get away from the situation where developers remove messages because "it's to noisy", and then have to ship a special version with additional debug output to a user to debug a problem, just to then remove the debug output again. ## Requirements * runtime configurability of debug level for specific components -* queriable debug logs. If everything is turned on a *lot* of information will be generated. +* queriable debug logs. If everything is turned on, a *lot* of information will be generated. * integration with the system log. It likely makes sense to integrate with the system-log instead of rolling our own solution or use .xsession-errors as dumping ground. In any case, simply logging to the console is not enough. * debug information *must* be available in release builds * It may make sense to be able to disable certain debug output (configurable per debug level) for certain components at compile time, for performance reasons. * Ideally little interaction with stdout (i.e. only warnings). Proper monitoring should happen through: * logfiles * a commandline monitor tool - * akonadiconsole + * some other developer tool ## Debug levels -* trace: trace individual codepaths. Likely outputs way to many information for all normal cases and likely is only ever temporarily enabled. Trace points are likely only inserted into code fragments that are known to be problematic. -* debug: Comprehensive debug output. Enabled on demand +* trace: trace individual codepaths. Likely outputs way to much information for all normal cases and likely is only ever temporarily enabled. Trace points are likely only inserted into code fragments that are known to be problematic. +* log: Comprehensive debug output. Enabled on demand * warning: Only warnings, should always be logged. * error: Critical messages that should never appear. Should always be logged. -- cgit v1.2.3