Skip to content

Commit

Permalink
Backport doc changes from official fieldalignment
Browse files Browse the repository at this point in the history
  • Loading branch information
dkorunic committed Jul 24, 2024
1 parent 4aba249 commit 571033c
Showing 1 changed file with 9 additions and 0 deletions.
9 changes: 9 additions & 0 deletions betteralign.go
Original file line number Diff line number Diff line change
Expand Up @@ -74,6 +74,15 @@ Be aware that the most compact order is not always the most efficient.
In rare cases it may cause two variables each updated by its own goroutine
to occupy the same CPU cache line, inducing a form of memory contention
known as "false sharing" that slows down both goroutines.
Unlike most analyzers, which report likely mistakes, the diagnostics
produced by betteralign very rarely indicate a significant problem,
so the analyzer is not included in typical suites such as vet or
gopls. Use this standalone command to run it on your code:
$ go install github.com/dkorunic/betteralign/cmd/betteralign@latest
$ betteralign [packages]
`

const ignoreStruct = "betteralign:ignore"
Expand Down

0 comments on commit 571033c

Please sign in to comment.