Feature #1139
Reference documentation in error reports
Status: | In Progress | Start date: | 04/13/2014 | ||
---|---|---|---|---|---|
Priority: | Normal | Due date: | |||
Assignee: | - | % Done: | 70% | ||
Category: | Documentation | ||||
Target version: | rsb-0.18 |
Description
It would be nice to refer users to suitable documentation when certain errors are encountered.
This has been suggested before (see #967).
There are examples in other middlewares:
6.210 [ Warning][DeploymentComponent::configureComponents] The protocol with id 3 did not register a fall-back handler for unknown types! 6.210 [ Warning][DeploymentComponent::configureComponents] triggered by: unknown_t which does not have a transport. 6.210 [ ERROR ][DeploymentComponent::configureComponents] Could not create transport stream for port FRIState with transport id 3 6.210 [ ERROR ][DeploymentComponent::configureComponents] No such transport registered. Check your policy.transport settings or add the transport for type /tFriIntfState
A more generic approach than the above would be attaching references as data structures to exceptions. The information could then be printed in way suiting the situation at hand. Here is an example of such a feature being implemented as a mixin class for exception classes:
The bounding indices 1 and 2 are bad for a sequence of length 0. [Condition of type SB-KERNEL:BOUNDING-INDICES-BAD-ERROR] See also: Common Lisp Hyperspec, _bounding index designator_ [:glossary] Common Lisp Hyperspec, _SUBSEQ-OUT-OF-BOUNDS:IS-AN-ERROR_ [:issue]
Where the
_..._
parts are hyperlinks.
Where could this be used?
- Incompatible payload type vs. informer type => "polymorphic informer" (source:rsb-manual|troubleshooting.rst@20f6d6bc#L215)
Subtasks
Related issues
Associated revisions
Moved troubleshooting into separate file troubleshooting.rst
refs #1139
refs #1139
- troubleshooting.rst: new file; contains troubleshooting; added link
targets to individual issues - preparation.rst: removed troubleshooting section
- index.rst: include file troubleshooting.rst
- _static/troubleshooting.svg: new file; icon for troubleshooting
- _templates/page.html: added link to troubleshooting
Added "Missing Converters" issue in troubleshooting.rst
refs #1139
refs #1139
- troubleshooting.rst: added "Missing Converters" issue
History
#1 Updated by J. Moringen over 11 years ago
- Description updated (diff)
#2 Updated by J. Moringen almost 11 years ago
- Target version changed from rsb-0.9 to rsb-0.10
#3 Updated by J. Moringen over 10 years ago
- Status changed from New to In Progress
- % Done changed from 0 to 20
My prototype implementation produces this when no suitable converter can be found:
The domain object :BLA could not be converted to a wire-type :UNDETERMINED representation using the wire-schema :UNDETERMINED Caused by: > No converter could handle the domain-object :BLA. Tried FUNDAMENTAL-VOID, > FUNDAMENTAL-BOOL, > FUNDAMENTAL-INT64, > FUNDAMENTAL-UINT32, > FUNDAMENTAL-INT32, > FUNDAMENTAL-UINT64, > FUNDAMENTAL-DOUBLE, > FUNDAMENTAL-FLOAT, > FUNDAMENTAL-UTF-8-STRING, > FUNDAMENTAL-BYTES, > PROTOCOL-BUFFER See also: RSB/MANUAL, Troubleshooting <http://docs.cor-lab.org/rsb-manual/trunk/html/troubleshooting.html> RSB/PROJECT, Report a bug <https://code.cor-lab.org/projects/rsb/issues/new> RSB/MANUAL, Troubleshooting ยป Missing Converters <http://docs.cor-lab.org/rsb-manual/trunk/html/troubleshooting.html#missing-converters> RSB/GLOSSARY, converter <http://docs.cor-lab.org/rsb-manual/trunk/html/glossary.html#term-converter>
Note the documentation references at the end of the error message.
#4 Updated by J. Moringen over 10 years ago
- Target version changed from rsb-0.10 to rsb-0.11
#5 Updated by J. Moringen almost 10 years ago
- % Done changed from 20 to 30
#6 Updated by J. Moringen over 9 years ago
- Target version changed from rsb-0.11 to rsb-0.12
#7 Updated by J. Wienke almost 9 years ago
- Target version changed from rsb-0.12 to rsb-0.13
#8 Updated by J. Moringen about 8 years ago
- Target version changed from rsb-0.13 to rsb-0.14
#9 Updated by J. Moringen almost 8 years ago
- Target version changed from rsb-0.14 to rsb-0.15
#10 Updated by J. Moringen over 7 years ago
- Target version changed from rsb-0.15 to rsb-0.16
#11 Updated by J. Moringen almost 7 years ago
- Target version changed from rsb-0.16 to rsb-0.17
#12 Updated by J. Moringen over 6 years ago
- Target version changed from rsb-0.17 to rsb-0.18