mesonbuild/meson

`meson setup` output ignores `b_colorout`

Closed

#13,708 opened on Sep 23, 2024

View on GitHubContributor guide
 (1 comment) (0 reactions) (0 assignees)Python (1,465 forks)batch import
enhancementgood first issue

Repository metrics

Stars
 (4,978 stars)
PR merge metrics
 (Avg merge 139d 13h) (51 merged PRs in 30d)

Description

Describe the bug

meson setup -Db_colorout=always does not cause meson setup to produce color output when stdout is not a TTY. It appears that the logging code does not check the flag:

https://github.com/mesonbuild/meson/blob/dbad301c8b039c4469f8727924baf250421d64ac/mesonbuild/mlog.py#L395-L398

To Reproduce

$ cat > meson.build <<EOF
project('c', 'c')
summary('test', true, bool_yn: true)
EOF
$ meson setup build -Db_colorout=always | cat

Expected behavior

The meson setup log includes bold and green text.

system parameters

  • Is this a cross build or just a plain native build (for the same computer)? Native
  • what operating system (e.g. MacOS Catalina, Windows 10, CentOS 8.0, Ubuntu 18.04, etc.) Fedora 40
  • what Python version are you using e.g. 3.8.0 3.12.5
  • what meson --version 1.5.2
  • what ninja --version if it's a Ninja build n/a

Contributor guide

Research direction
Investigate the logging mechanism in `mesonbuild/mlog.py` around line 395-398. The issue is that `meson setup` does not respect the ` Db colorout=always` flag when stdout is not a TTY. To fix, add a check to enable color output based on the `b colorout` option, even when not a TTY. Refer to the linked code and consider consulting maintainer comments if any.
Tech stack
python
Domain
build systemcli
Issue type
Bug
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Basic Python knowledgeFamiliarity with Meson build system
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
80