-
Notifications
You must be signed in to change notification settings - Fork 47
Knowledgebase
Marek Bryša edited this page Jul 27, 2015
·
3 revisions
FAF has a simple built-in knowledgebase used to immediately find a solution for incoming reports without the need of further analysis (but the report itself is processed in the background as if no solution was found).
If at least one solution is found when creating a new report, the response contains solutions
list.
A solution is the hint sent to the user when the report matches some knowledgebase pattern. Each solution consists of 4 parts:
- Cause - Short summary of what caused the problem
- URL (optional) - URL where more relevant information can be found
- Text note - Plain-text explanation of what happend, an advice or anything else that should be shown to the client.
- HTML note (optional) - Same as above, but HTML-formatted
Solutions are managed by sf-prefilter-soladd
and sf-prefilter-solshow
actions.
Patterns consist of 4 parts:
- Pattern type - see below
- The pattern itself - a regexp
- Solution - a description of the solution shown to the user
-
Operating system - a pattern may be specific to an operating system
At the moment FAF provides two types of patterns:
-
Package name pattern - a match in package name (e.g. package
vlc
is not officially supported in Fedora). As the nature of "package" is determined by the operating system plugin, itscheck_pkgname_match
method is used to evaluate the match.
-
Backtrace path pattern - a match in backtrace path (e.g. the
nvidia
kernel module is proprietary and we are not able to provide support). As the nature of "backtrace" is determined by the problem plugin, itscheck_btpath_match
method is used to evaluate the match.
Patterns are managed by sf-prefilter-patadd
and sf-prefilter-patshow
actions.