Skip to content

docs: broken common.mk default target #941

@lczyk

Description

@lczyk

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

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions