Skip to content
This repository was archived by the owner on Apr 23, 2026. It is now read-only.

fix: update make help text - #1172

Merged
mergify[bot] merged 2 commits into
instructlab:mainfrom
nathan-weinberg:make-help
May 20, 2024
Merged

fix: update make help text#1172
mergify[bot] merged 2 commits into
instructlab:mainfrom
nathan-weinberg:make-help

Conversation

@nathan-weinberg

Copy link
Copy Markdown
Contributor

Example of before/after below

[nathan@nathan-redhat instructlab (make-help)]$ make help

Usage:
  make <target>

General
  help             Display this help.

Build
  images           Get the current controller, set the path, and build the Containerfile image. (auto-detect the compatible controller)
  cuda             Build container for NVidia CUDA
  hpu              Build container for Intel Gaudi HPU
  rocm             Build container for AMD ROCm (auto-detect the ROCm GPU arch)
  rocm-gfx1100     Build container for AMD ROCm RDNA3 (Radeon RX 7000 series)
  rocm-gfx1030     Build container for AMD ROCm RDNA2 (Radeon RX 6000 series)
  rocm-gfx90a      Build container for AMD ROCm gfx90a (untested)
  rocm-gfx908      Build container for AMD ROCm gfx908 (untested)
  rocm-gfx906      Build container for AMD ROCm gfx906 (untested)
  rocm-gfx900      Build container for AMD ROCm gfx900 (untested)
  toolbox-rocm     Create AMD ROCm toolbox from container
  toolbox-rm       Stop and remove toolbox container

Development
  tests            Run tox -e unit against code
  verify           Run tox -e fmt,lint,spellcheck against code
  docs             Run tox -e docs against code

Linting
  md-lint          Lint markdown files
[nathan@nathan-redhat instructlab (make-help)]$ make help

Usage:
  make <target>

General
  help             Display this help.

Build
  images           Get the current controller, set the path, and build the Containerfile image. (auto-detect the compatible controller)
  cuda             Build container for NVidia CUDA
  hpu              Build container for Intel Gaudi HPU
  rocm             Build container for AMD ROCm (auto-detect the ROCm GPU arch)
  rocm-gfx1100     Build container for AMD ROCm RDNA3 (Radeon RX 7000 series)
  rocm-gfx1030     Build container for AMD ROCm RDNA2 (Radeon RX 6000 series)
  rocm-gfx90a      Build container for AMD ROCm gfx90a (untested)
  rocm-gfx908      Build container for AMD ROCm gfx908 (untested)
  rocm-gfx906      Build container for AMD ROCm gfx906 (untested)
  rocm-gfx900      Build container for AMD ROCm gfx900 (untested)
  toolbox-rocm     Create AMD ROCm toolbox from container
  toolbox-rm       Stop and remove toolbox container

Development
  tests            Run tox -e unit against code
  verify           Run tox -e fmt,lint,spellcheck against code
  spellcheck-sort  Sort spellcheck directory
  docs             Run tox -e docs against code
  md-lint          Lint markdown files

@nathan-weinberg

Copy link
Copy Markdown
Contributor Author

I rebased this on top of #1156 by @leseb and added some additional text there

Development
  tests            Run tox -e unit against code
  verify           Run tox -e fmt,lint,spellcheck against code
  spellcheck-sort  Sort spellcheck directory
  docs             Run tox -e docs against code
  md-lint          Lint markdown files

Validation
  check-tox        ensure tox is installed
  check-toolbox    ensure toolbox is installed
  check-engine     ensure the container engine is installed
  check-rocm       ensure rocm is installed

Comment thread Makefile Outdated
Comment thread Makefile Outdated
@nathan-weinberg
nathan-weinberg requested review from leseb and russellb May 16, 2024 16:27
Added text for spellcheck-sort
Moved md-lint into 'Development' section
Added text for validation commands

Signed-off-by: Nathan Weinberg <nweinber@redhat.com>
Signed-off-by: Nathan Weinberg <nweinber@redhat.com>
@nathan-weinberg
nathan-weinberg requested a review from a team May 16, 2024 19:41
@mergify mergify Bot added the one-approval PR has one approval from a maintainer label May 17, 2024
@mergify
mergify Bot merged commit dee6164 into instructlab:main May 20, 2024
@mergify mergify Bot removed the one-approval PR has one approval from a maintainer label May 20, 2024
@nathan-weinberg
nathan-weinberg deleted the make-help branch June 24, 2024 17:17
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants