tmt icon indicating copy to clipboard operation
tmt copied to clipboard

Get rid of the too many empty new lines

Open psss opened this issue 2 years ago • 2 comments

They are useful in some cases (like visually separating phases) and at the same time quite disturbing or even ugly when there's just a single/simple step config.

Pull Request Checklist

  • [ ] implement the feature
  • [ ] write the documentation
  • [ ] extend the test coverage
  • [ ] update the specification
  • [ ] adjust plugin docstring
  • [ ] modify the json schema
  • [ ] mention the version
  • [ ] include a release note

psss avatar Dec 01 '23 08:12 psss

For now really just draft, need to finish some of the ideas discussed in #2443:

This is hard, isn't it? It's effectively tailoring the output to look nice in one use case, possibly making other use cases a bit uglier. I for one like to see those messages, and I suppose others don't.

Yes, yes, hard. And I can see that for multi-phase steps sometimes the empty lines are beneficial to visualy separate individual phases. Let's see if we can do it in a different way.

I'd say a change like this deserves its own pull request: if this family of logging messages is deemed not good enough for info, and should be shown only in more verbose modes, let's make it clear.

Ack, agreed, that's why I added a separate commit for this. I just had to get rid of the ugly output when debugging the tmt try functionality ;-) Here's the pull request:

  • #2534

Would it make sense to also add a log topic for "phase queue" messages? Maybe not, there are not a lot of them around, verbosity change is probably enough...

I find them quite useful, just would expect them on a lower verbosity level.

Would it make sense to also drop empty messages like this one? They are used for the separation of phases and queueing messages, but when they land in the log file by default anyway, who cares, and trying to hit the right terminal formatting in -vvv is probably a waste of time, there would be way too much output anyway...

Good point, I'd vote for getting rid of them and trying to do the visual separation in a different way. Will try something in the separate pull request.

psss avatar Dec 01 '23 08:12 psss

I don't think that removing empty lines solve verbosity problem. The cognitive load is from text. If there won't be separator, the load for the same amount of text will increase.

abitrolly avatar Jun 25 '24 22:06 abitrolly

7th milestone bump. Does it make sense to keep this PR anywhere near a milestone?

happz avatar Jan 13 '25 14:01 happz

@psss I dropped this from the milestone, please bring it back once moved forward

thrix avatar Jan 27 '25 19:01 thrix