diff --git a/reference/hde/2023-12-20-21-12-17.png b/reference/hde/2023-12-20-21-12-17.png new file mode 100644 index 0000000..2f5f643 Binary files /dev/null and b/reference/hde/2023-12-20-21-12-17.png differ diff --git a/reference/hde/2023-12-20-21-14-47.png b/reference/hde/2023-12-20-21-14-47.png new file mode 100644 index 0000000..8c49dbc Binary files /dev/null and b/reference/hde/2023-12-20-21-14-47.png differ diff --git a/reference/hde/2023-12-20-21-15-29.png b/reference/hde/2023-12-20-21-15-29.png new file mode 100644 index 0000000..76ee122 Binary files /dev/null and b/reference/hde/2023-12-20-21-15-29.png differ diff --git a/reference/hde/debugging-apphealth.md b/reference/hde/debugging-apphealth.md index 81c382a..8944a59 100644 --- a/reference/hde/debugging-apphealth.md +++ b/reference/hde/debugging-apphealth.md @@ -4,6 +4,8 @@ Here you'll see an overview of issues coming from your running application. These can be exceptions (the pink nodes) or come from a `Warn [VL.Session]` node that you can even use yourself in patches to indicate a problem. +![](2023-12-20-21-14-47.png) + Exceptions are critical and should be taken seriously. Your application crashed. Errors, Warnings, and Infos are messages from the library developer. The app didn't crash, but there is something fishy, which you should probably take another look at. diff --git a/reference/hde/debugging-buildresult.md b/reference/hde/debugging-buildresult.md index e7a6305..ffe104f 100644 --- a/reference/hde/debugging-buildresult.md +++ b/reference/hde/debugging-buildresult.md @@ -2,21 +2,22 @@ **As of vvvv gamma 5.3-preview 413** -Here you'll see errors, warnings, and infos that came up as a result of the build process. Whenever vvvv is building your patches (ie. whenever you make a change), this list is cleared and you'll get a fresh view of the latest issues. +Here you'll see errors, warnings and infos that came up as a result of the build process. Whenever vvvv is building your patches (ie. whenever you make a change), this list is cleared and you'll get a fresh view of the latest issues. -Most commonly, you'll see errors relating to -* missing dependency references or nodes -* typing issues on links, pins, or pads +![](2023-12-20-21-12-17.png) + +Most commonly, you'll see errors relating to: +* Missing dependency references or nodes +* Typing issues on links, pins, or pads Double-clicking an entry brings you to the source of the message: right in the patch, where you'll find the same issue visualized as a red or yellow node, link, pin, or pad. -While the patch is the place that allows you to understand and fix a problem, the Build Result view is supposed to help you -* zoom out and understand the big picture of build issues -* navigate and find the root issues +While the patch is the place that allows you to understand and fix a problem, the Build Result view is supposed to help you: +* Zoom out and understand the big picture of build issues +* Navigate and find the root issues Keeping this list in check is the basis of a [healthy app](debugging-apphealth.md). - -Remarks: -* Typically only the Errors are of interest. -* vvvv can build patches with errors. This allows for faster iterations and refactorings. You don't need to fix every error to test a new idea. If you are in the process of such a refactoring you might see a lot of errors. The Build Result view reminds you of those, but don't feel bad. Sometimes when developing bigger patches, this is just part of working, a proof that things are moving. Decide for yourself when it's about tackling those errors again. For sure, when testing your app, searching for a bug is easier if there are no build errors left. -* Warnings: There are too many of them typically and it's quite hard to get rid of them. So it's a bit tricky to take them seriously. However, they still have a purpose which is trying to help you with reasoning about what your app does. Especially when it comes to object mutability and order of execution. +**Remarks** +* Typically only the Errors are of interest +* vvvv can build patches with errors. This allows for faster iterations and refactorings. You don't need to fix every error to test a new idea. If you are in the process of such a refactoring you might see a lot of errors. The Build Result view reminds you of those, but don't feel bad. Sometimes when developing bigger patches, this is just part of working, a proof that things are moving. Decide for yourself when it's about tackling those errors again. For sure, when testing your app, searching for a bug is easier if there are no build errors left +* Warnings: There are too many of them typically and it's quite hard to get rid of them. So it's a bit tricky to take them seriously. However, they still have a purpose which is trying to help you with reasoning about what your app does. Especially when it comes to object mutability and order of execution \ No newline at end of file diff --git a/reference/hde/debugging-log.md b/reference/hde/debugging-log.md index dbba26e..3010cb3 100644 --- a/reference/hde/debugging-log.md +++ b/reference/hde/debugging-log.md @@ -4,8 +4,9 @@ The log is collecting all messages over time and shows you the whole history, until you clear it or the buffer runs over (Buffer length defaults to 5000 but can be configured via the Settings). -Here you'll find all messages sent by the system, but also by your app. To distinguish between those, see the "Source" column. +![](2023-12-20-21-15-29.png) +Here you'll find all messages sent by the system, but also by your app. To distinguish between those, see the "Source" column. To create log messages from your patches use the Log [System.Logging] node.