#1656·ginkgo

doc: --asan and --msan help text is incomplete and outdated

Author: Nikshitha-DevadigaCreated Apr 22, 2026Updated Sep 10, 2026

Problem

Running ginkgo help build shows incomplete and outdated platform information for --asan and --msan.

--asan shows only:

enable interoperation with address sanitizer.

No platform or compiler requirements are mentioned, unlike --race and --msan which both include that information.

--msan shows:

Supported only on linux/amd64, linux/arm64 and only with Clang/LLVM as the host C compiler. On linux/arm64, pie build mode will be used.

But go help build says:

Supported only on linux/amd64, linux/arm64, linux/loong64, freebsd/amd64 and only with Clang/LLVM as the host C compiler. PIE build mode will be used on all platforms except linux/amd64.

Two platforms are missing (linux/loong64, freebsd/amd64) and the PIE statement is incorrect as it applies to all platforms except linux/amd64, not just linux/arm64.

Question

Would you prefer:

  1. Updating the strings to match current go help build output (risks going stale again)
  2. Replacing platform details with a reference like "see go help build for supported platforms" (stays accurate forever)