Better error messages, context

Open
#2,079 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
4/5
Estimated time
3-5 days
Newbie friendliness
35/100
Issue type
Feature
Clarity
Mostly clear
Activity status
Stale
Tech stack
python
Domain
build-system

Research direction

Start by reviewing the SourceError class and the handling of the invalid git ref entry shown in the issue. Trace where the error loses its file and line context across the relevant bst files. Done means the error identifies the faulty file, ideally its line, with a consistent formatting policy.

Written by the indexing model from the issue text.

Description

[00:00:00][        ][    main:core activity                 ] FAILURE Resolving elements
[00:00:01][        ][    main:core activity                 ] FAILURE Build

ref  is not in the expected format

In the issue here I had a git ref: entry without a value. My fault. Still from the error message we can't even tell which of all the many bst files is at fault.

It would have been useful if it tells me which file is at fault; the line would be even better.

I'm putting it here instead of buildstream-plugins-community because looking at the SourceError class it doesn't have a location argument.

Of course, the conclusion could be that this ought to be included in the message. In such case we'd need a policy somewhere for such formatting.

Dominant language
Python
Stars
144
Forks
45
Avg merge
20h 38m
Merged PRs (30d)
6

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.

More from apache/buildstream

All issues in apache/buildstream

Similar issues

More Python issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.