Skip to content

Commit 7145f1c

Browse files
committed
cmd/compile: minor updates to the README
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 <[email protected]>
1 parent 36c6230 commit 7145f1c

File tree

1 file changed

+4
-2
lines changed

1 file changed

+4
-2
lines changed

src/cmd/compile/README.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
1+
<!---
12
// Copyright 2018 The Go Authors. All rights reserved.
23
// Use of this source code is governed by a BSD-style
34
// license that can be found in the LICENSE file.
5+
-->
46

57
## Introduction to the Go compiler
68

@@ -19,7 +21,7 @@ the `go/*` packages were developed to enable writing tools working with Go code,
1921
such as `gofmt` and `vet`.
2022

2123
It should be clarified that the name "gc" stands for "Go compiler", and has
22-
little to do with uppercase GC, which stands for garbage collection.
24+
little to do with uppercase "GC", which stands for garbage collection.
2325

2426
### 1. Parsing
2527

@@ -113,4 +115,4 @@ and debugging information.
113115
### Further reading
114116

115117
To dig deeper into how the SSA package works, including its passes and rules,
116-
head to `cmd/compile/internal/ssa/README.md`.
118+
head to [cmd/compile/internal/ssa/README.md](internal/ssa/README.md).

0 commit comments

Comments
 (0)