Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[csolution] review error messages #1898

Open
ReinhardKeil opened this issue Dec 12, 2024 · 2 comments
Open

[csolution] review error messages #1898

ReinhardKeil opened this issue Dec 12, 2024 · 2 comments
Assignees
Labels
discussion Indicates an issue being in discussion enhancement New feature or request

Comments

@ReinhardKeil
Copy link
Collaborator

The Problem To Be Solved

VS Code shows error messages like this which is a little overwelming:

image

Suggest A Solution

Keep messages shorter:

  • 'was' is a redundant word
  • As the error is listed under a context, the information about the context for the run command is irrelevant
  • the message "error processing context" is irrelevant (as there are errors listed for this context already). The message itself does not add new information.
@ReinhardKeil ReinhardKeil added the enhancement New feature or request label Dec 12, 2024
@jkrech jkrech moved this to Todo in CMSIS-Toolbox 2.8.0 Feb 4, 2025
@jkrech
Copy link
Member

jkrech commented Feb 4, 2025

The messages are taken from the *.cbuild-idx.yml where they have a context. When used at the command line the error message may not have that context. Needs investigation.

@jkrech jkrech changed the title review error messages [csolution] review error messages Feb 4, 2025
@soumeh01
Copy link
Collaborator

soumeh01 commented Feb 11, 2025

@ReinhardKeil Please find my comments on the suggested solution after the investigation:

  • Yes as correctly pointed out by @jkrech , Adding context information as part of the error message or the processing context error message—seems to be intended for command-line usage, where the user may or may not have a specified context.

  • It's important to note that the error processing context acts as both informational and a separator for multiple errors occurring in different contexts. For example, Here is the series of error messages from one of example:

line1: error csolution: redefinition from 'conflict' into 'renaming_conflict' is not allowed
line2: error csolution: processing context 'outputFiles.BaseNameConflict+Target' failed
line3: error csolution: output 'lib' is incompatible with other output types
line4: error csolution: processing context 'outputFiles.TypeConflict+Target' failed

Here, the error messages on line 1 and line 3 lack context information. However, the lines below them provide a hint about the context in which these errors occurred.

In my opinion, the error: processing context message should be removed. However, we should instead add the relevant context information to each individual error message for command line usage. That said, this approach won't fully resolve this issue, as the context information will still be present within the context-specific nodes listed in *.cbuild-idx.yml.

@soumeh01 soumeh01 added the discussion Indicates an issue being in discussion label Feb 11, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
discussion Indicates an issue being in discussion enhancement New feature or request
Projects
Status: Todo
Development

No branches or pull requests

3 participants