OpenCyphal / OpenCyphal/libudpard

Design a way to expose internal error states for debugging

Open
#39 1 comment 0 reactions 1 assignee View on GitHub

@pavel-kirienko is already working on this.

Since Jul 18, 2023.

enhancement
Dominant language
C
Stars
22
Forks
12
PR merge metrics
No merged PRs in 30d

Description

As is appropriate for libudpard, the error system exposed to applications is very simple. There are times, however, when deeper introspection would be helpful. For example, when first integrating with a system the integrator is likely to make a few mistakes that are atypical for a healthy system but which are common misconceptions or just dumb mistakes caused by the tendency of many to read variable names instead of documentation. There are not many of these conditions in our simple code base which makes it undesirable to design a normal error scheme to support this use case. One idea is to provide a -DDEBUG enabled structure that can store this type of error data when enabled (e.g. sort of a posix errno scheme). Other ideas are welcome but the end result would be to make libudpard a bit more friendly to new users.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.