← Back to issue list

docs: broken common.mk default target

View original Github issue

Metadata

Project
rockcraft
Number
#941
Type
issue
State
closed
Author
lczyk
Labels
Type: Documentation
Created
Updated
Closed

Current evaluation

Fixed the common.mk help output, which showed empty Target names. PR #1105 (commit 6ae769e9) removed a faulty sed prefix-strip expression, based on the reporter lczyk's diff.

Resolution: closed resolved

Reason: Reporter lczyk pinpointed the redundant 's/^[^:]*://' sed expression in the help target and posted a working diff. Canonical/rockcraft#1105 ("fix: correct common.mk help target listing") was merged as commit 6ae769e9 and explicitly fixes #941; the current common.mk confirms the faulty sed is gone and target names are populated.

Evaluated by: mr-cal-bot

No scores available.

Issue body

### Bug Description the output of the default target (aka `help`) of `common.mk` does not appear quite right: ``` Target | Description ------------------------------ + ------------------------------------------------ └ | └ ##- Check spelling with codespell └ | └ ##- Format files with prettier └ | └ ##- Lint files with prettier └ | └ ##- Automatically format with ruff └ | └ ##- Lint with ruff └ | └ install-build-deps ##- Set up a testing environment for Tiobe TICS └ | └ ##- Check that uv.lock matches expectations from pyproject.toml └ | └ ##- Set up pre-commit hooks in this repository. └ | └ _setup-docs _setup-lint _setup-tests setup-precommit install-build-deps ## Set up a development environment └ | └ ##- Lint Python packages with twine | Build and host docs with sphinx-autobuild | Build documentation | Clean up the development environment | Generate coverage report | Run all tests └ | └ Build packages for pip (sdist, wheel) └ | └ Check types with mypy └ | └ Check types with pyright └ | └ Fix spelling issues with codespell └ | └ Format the entire repository using pre-commit └ | └ Identify slow tests. Set cutoff time in seconds with SLOW_CUTOFF_TIME └ | └ Lint shell scripts └ | └ Lint the documentation └ | └ Run fast tests └ | └ Run slow tests | Show this help. └ | └ ##- Set up a documentation-only environment └ | └ ##- Set up a linting-only environment └ | └ ##- Set up a testing environment without linters ``` ### To Reproduce ``` git clone https://github.com/canonical/rockcraft && cd rockcraft make -f common.mk ``` ``` make: 4.4.1 ubuntu 25.04 aarch64 ```

Evaluation history

Date Model Scores Action Summary
stealth/space-bunny-alpha — closed resolved Fixed the common.mk help output, which showed empty Target names. PR #1105 (commit 6ae769e9) removed a faulty sed prefix-strip expression, based on the reporter lczyk's diff.
stealth/space-bunny-alpha — closed resolved Fixed malformed common.mk help output by removing faulty sed prefix stripping; PR #1105 merged as commit 6ae769e9.
stealth/space-bunny-alpha — closed resolved Fixed in rockcraft PR #1105 (commit 6ae769e9, "fix: correct common.mk help target listing"), which dropped the spurious 's/^[^:]*://' sed that broke the help table. Author lczyk supplied the patch.
stealth/space-bunny-alpha — closed resolved Fixed the common.mk help output by removing a faulty prefix-stripping sed expression. PR #1105 was merged as commit 6ae769e9.
qwen/qwen3.6-35b-a3b — — Fixed broken help target formatting in common.mk by removing an unnecessary sed command from the parsing pipeline. The change restores correct alignment for make targets and descriptions.
qwen/qwen3.6-35b-a3b — — Fixed by removing an unnecessary sed command from the common.mk help target pipeline. The change corrects malformed make help output by simplifying the text processing chain.
qwen/qwen3.6-35b-a3b — — The broken formatting in the common.mk help target was resolved by removing an unnecessary sed expression. The contributor submitted a patch that corrected the output, and the issue was closed as fixed.
qwen3.6-35b-a3b-mtp-q6 — — Fixed malformed make help output in common.mk by removing a redundant sed substitution from the help target. The contributor verified the change resolves the formatting issue, and the issue was closed.

Update history

No update history recorded yet.

Related work

  • Likely Fixed By: canonical/rockcraft#1105 (confidence 97%)

    Merged PR 'fix: correct common.mk help target listing' (commit 6ae769e9); its summary states it preserves Makefile target names and fixes issue #941.

  • Caused By: canonical/rockcraft#1252 (confidence 25%)

    Later commit touching common.mk, not a cause of the bug; listed only as a subsequent change, low relevance.

Related issues

Issue Project State Summary Similarity
#1105 fix: correct common.mk help target listing rockcraft merged Merged PR #1105 as commit 6ae769e9, preserving Makefile target names in common.mk help output and fixing #941.
81%