aboutsummaryrefslogtreecommitdiff
path: root/src/cmd/compile/README.md
AgeCommit message (Collapse)Author
2025-10-15cmd/compile: replace angle brackets with squareWill Faught
Caused Markdown rendering error on https://go.dev/src/cmd/compile/README in macOS (15.6.1) Safari (18.6). Change-Id: Id71436d9a7bc7e461e522500d66df5dda7cd9f7f GitHub-Last-Rev: 4e4447e163ac65e6c394807ec4874bc5ca26bb32 GitHub-Pull-Request: golang/go#75549 Reviewed-on: https://go-review.googlesource.com/c/go/+/704716 LUCI-TryBot-Result: Go LUCI <golang-scoped@luci-project-accounts.iam.gserviceaccount.com> Reviewed-by: Keith Randall <khr@golang.org> Auto-Submit: Dmitri Shuralyov <dmitshur@google.com> Reviewed-by: Dmitri Shuralyov <dmitshur@google.com> Reviewed-by: Keith Randall <khr@google.com>
2025-09-19cmd/compile: fix doc wordWill Faught
"using" -> "uses" Change-Id: I2bcefc6128dafd4fd05d7ce291b1afb28465a25c GitHub-Last-Rev: bf9006eeb65c94a4e492be29f530f511a3d6ffc1 GitHub-Pull-Request: golang/go#75548 Reviewed-on: https://go-review.googlesource.com/c/go/+/705515 Reviewed-by: Keith Randall <khr@google.com> Auto-Submit: Keith Randall <khr@golang.org> LUCI-TryBot-Result: Go LUCI <golang-scoped@luci-project-accounts.iam.gserviceaccount.com> Reviewed-by: Cherry Mui <cherryyz@google.com> Reviewed-by: Keith Randall <khr@golang.org>
2025-08-19cmd/compile: tweak example command in READMEJes Cok
While running ./src/all.bash, I got the following error: all.bash must be run from $GOROOT/src Change-Id: Iad271654ff8647501a324c282f01baf39605e3df GitHub-Last-Rev: 2e289babf1bc81c1a44c9a72a29659d8bf9d827b GitHub-Pull-Request: golang/go#75050 Reviewed-on: https://go-review.googlesource.com/c/go/+/696296 Reviewed-by: t hepudds <thepudds1460@gmail.com> Reviewed-by: Keith Randall <khr@google.com> LUCI-TryBot-Result: Go LUCI <golang-scoped@luci-project-accounts.iam.gserviceaccount.com> Reviewed-by: Carlos Amedee <carlos@golang.org>
2024-06-25cmd/compile: update README to reflect dead code elimination changesfunc25
The description of middle-end dead code elimination is inconsistent with the current implementation. The early dead code elimination pass of IR nodes is no longer located in cmd/compile/internal/deadcode and is no longer called by gc/main.go:Main. It has been moved to the unified IR writer phase. This update modifies the README to reflect this architectural change. Change-Id: I78bd486edefd6b02948fee7de9ce6c83b147bc1d GitHub-Last-Rev: 76493ce8b08cd585d761d65d29b984360f7ee628 GitHub-Pull-Request: golang/go#68134 Reviewed-on: https://go-review.googlesource.com/c/go/+/593638 Reviewed-by: Robert Griesemer <gri@google.com> Reviewed-by: Keith Randall <khr@google.com> Reviewed-by: Keith Randall <khr@golang.org> LUCI-TryBot-Result: Go LUCI <golang-scoped@luci-project-accounts.iam.gserviceaccount.com> Auto-Submit: Keith Randall <khr@golang.org>
2024-05-07cmd/compile: describe export dataAlan Donovan
Updates #30074 Change-Id: Ic74d482943d992c20f69edb106c666a7b26291c1 Reviewed-on: https://go-review.googlesource.com/c/go/+/578055 LUCI-TryBot-Result: Go LUCI <golang-scoped@luci-project-accounts.iam.gserviceaccount.com> Reviewed-by: Than McIntosh <thanm@google.com> Reviewed-by: Cuong Manh Le <cuong.manhle.vn@gmail.com>
2023-09-12cmd/compile: add a 'Tips' section to README to help new contributorsthepudds
This CL adds a new 'Tips' section to the cmd/compile README. The primary intent is to help new-ish contributors. It includes some basics on getting started, testing changes, viewing coverage, juggling different compiler versions, some links to additional tools, and so on. Updates #30074 Change-Id: I393bf1137db9d2bb851f7e254b08455273ccad8c Reviewed-on: https://go-review.googlesource.com/c/go/+/503895 TryBot-Result: Gopher Robot <gobot@golang.org> Reviewed-by: Matthew Dempsky <mdempsky@google.com> Run-TryBot: t hepudds <thepudds1460@gmail.com> Reviewed-by: Keith Randall <khr@golang.org> Reviewed-by: Keith Randall <khr@google.com>
2023-07-26cmd/compile: update README for unified IRKeith Randall
Change-Id: Ie84e88db4b84f04f2c6f7750a2a413ecad6d817a Reviewed-on: https://go-review.googlesource.com/c/go/+/513436 Reviewed-by: Matthew Dempsky <mdempsky@google.com> Reviewed-by: Keith Randall <khr@google.com> TryBot-Bypass: Keith Randall <khr@google.com>
2022-05-10cmd/compile: update README.mdMatthew Dempsky
This CL updates the description of the frontend packages of the compiler, which I'm more familiar with. Updates #30074. Change-Id: Ic279007f6102b21072d6558fa9035f0fcc267d93 Reviewed-on: https://go-review.googlesource.com/c/go/+/404694 Reviewed-by: Keith Randall <khr@golang.org> Reviewed-by: David Chase <drchase@google.com>
2022-02-02cmd/compile: edit READMEpierwill
Make some small edits for clarification of important concepts. Change-Id: I1f78f2a59489ac71e3948dc924641540508613ce GitHub-Last-Rev: 1819140ee607edf8be3ed35f846848178065391a GitHub-Pull-Request: golang/go#50980 Reviewed-on: https://go-review.googlesource.com/c/go/+/382458 Reviewed-by: Robert Griesemer <gri@golang.org> Reviewed-by: Matthew Dempsky <mdempsky@google.com>
2018-07-04cmd/compile: minor updates to the READMEDaniel Martí
Use an HTML comment with triple dashes for the copypright header, which means that the paragraph will be ignored when rendering both HTML and TeX. While at it, quote "GC", and properly link to internal/ssa/README.md. Change-Id: Ib18529d2fc777d836e74726ff1cfe685e08b063c Reviewed-on: https://go-review.googlesource.com/109875 Reviewed-by: Matthew Dempsky <mdempsky@google.com>
2018-06-11cmd/compile: fix wording in READMEYury Smolsky
"Syntax analysis" sounds more familiar and fits the item before, which says "lexical analysis". If there was specific intention to the original wording, I, as a reader, would like to see it instead of this confusing wording. Change-Id: Id32dbf75300a86b21cb9f35e54526184fe5df6cb Reviewed-on: https://go-review.googlesource.com/117696 Reviewed-by: Robert Griesemer <gri@golang.org>
2018-04-27cmd/compile: add initial READMEDaniel Martí
As a follow-up to the first README for cmd/compile/internal/ssa. Since this is the parent package for all the compiler packages, this README serves as an overview of the compiler and its packages. As more READMEs are added for specific parts with more detail, such as ssa's, they can be linked from this one. Thanks to Iskander Sharipov, Josh Bleecher Snyder, Matthew Dempsky, Alberto Donizetti, and Robert Griesemer for helping with all the details in this document. Change-Id: I820a535e25dce86ccc667ce1c6e92b75fc32f3af Reviewed-on: https://go-review.googlesource.com/103935 Reviewed-by: Martin Möhrmann <moehrmann@google.com> Reviewed-by: Josh Bleecher Snyder <josharian@gmail.com> Reviewed-by: Matthew Dempsky <mdempsky@google.com>