[go] doc: Improve documentation for GOAMD64
Ulrich Kunitz (Gerrit)
Ulrich Kunitz has uploaded this change for review.
doc: Improve documentation for GOAMD64
The change clarifies in the release notes for go1.18 that the variable
is for compilation and references the microarchitecture description in
the Go Wiki,
https://github.com/golang/go/wiki/MinimumRequirements#microarchitecture-support,
and references the same information in the output of go help
environment.
Fixes #50174
Change-Id: I6a7d5a06f48463a810c96cc9c76fe66113d5147c
---
M src/cmd/go/internal/help/helpdoc.go
M doc/go1.18.html
M src/cmd/go/alldocs.go
3 files changed, 24 insertions(+), 5 deletions(-)
diff --git a/doc/go1.18.html b/doc/go1.18.html
index e5222b7..afdfac9 100644
--- a/doc/go1.18.html
+++ b/doc/go1.18.html
@@ -118,10 +118,11 @@
<p><!-- CL 349595 -->
Go 1.18 introduces the new <code>GOAMD64</code> environment variable which selects
- a version of the AMD64 architecture. Allowed values are <code>v1</code>,
+ a version of the AMD64 architecture for compilation. Allowed values are <code>v1</code>,
<code>v2</code>, <code>v3</code>, or <code>v4</code>. Each higher level requires,
- and takes advantage of, additional processor features. A detailed description of the
- versions is <a href="https://en.wikipedia.org/wiki/X86-64#Microarchitecture_levels">here</a>.
+ and takes advantage of, additional processor features. A detailed
+ description can be found
+ <a href="https://github.com/golang/go/wiki/MinimumRequirements#microarchitecture-support">here</a>.
</p>
<p>
The <code>GOAMD64</code> environment variable defaults to <code>v1</code>.
diff --git a/src/cmd/go/alldocs.go b/src/cmd/go/alldocs.go
index 6703792..b1a9abc 100644
--- a/src/cmd/go/alldocs.go
+++ b/src/cmd/go/alldocs.go
@@ -2077,7 +2077,7 @@
// GOAMD64
// For GOARCH=amd64, the microarchitecture level for which to compile.
// Valid values are v1 (default), v2, v3, v4.
-// See https://en.wikipedia.org/wiki/X86-64#Microarchitecture_levels.
+// See https://github.com/golang/go/wiki/MinimumRequirements#microarchitecture-support
// GOMIPS
// For GOARCH=mips{,le}, whether to use floating point instructions.
// Valid values are hardfloat (default), softfloat.
diff --git a/src/cmd/go/internal/help/helpdoc.go b/src/cmd/go/internal/help/helpdoc.go
index 035235f..0767730 100644
--- a/src/cmd/go/internal/help/helpdoc.go
+++ b/src/cmd/go/internal/help/helpdoc.go
@@ -595,7 +595,7 @@
GOAMD64
For GOARCH=amd64, the microarchitecture level for which to compile.
Valid values are v1 (default), v2, v3, v4.
- See https://en.wikipedia.org/wiki/X86-64#Microarchitecture_levels.
+ See https://github.com/golang/go/wiki/MinimumRequirements#microarchitecture-support
GOMIPS
For GOARCH=mips{,le}, whether to use floating point instructions.
Valid values are hardfloat (default), softfloat.
To view, visit change 372194. To unsubscribe, or for help writing mail filters, visit settings.
Ian Lance Taylor (Gerrit)
Attention is currently required from: Bryan Mills, Keith Randall, Michael Matloob, Ulrich Kunitz.
Patch set 1:Run-TryBot +1
Bryan Mills (Gerrit)
Attention is currently required from: Keith Randall, Ulrich Kunitz.
Bryan Mills removed Michael Matloob from this change.
To view, visit change 372194. To unsubscribe, or for help writing mail filters, visit settings.
Keith Randall (Gerrit)
Attention is currently required from: Ulrich Kunitz.
4 comments:
File doc/go1.18.html:
Patch Set #1, Line 121:
for compilationI don't think "for compilation" adds anything. Maybe "... selects a target version of the AMD64 architecture"? "... target minimum version ..."?
Patch Set #1, Line 125:
#microarchitecture-supportShould probably link directly to #amd64
File src/cmd/go/alldocs.go:
Patch Set #1, Line 2080:
#microarchitecture-supportSame here, link to #amd64 section.
(maybe the title above could be linked to #microarchitecture-support ?)
File src/cmd/go/internal/help/helpdoc.go:
To view, visit change 372194. To unsubscribe, or for help writing mail filters, visit settings.
Ulrich Kunitz (Gerrit)
Attention is currently required from: Ulrich Kunitz.
Ulrich Kunitz uploaded patch set #2 to this change.
doc: Improve documentation for GOAMD64
The change clarifies in the release notes for go1.18 that the variable
is for compilation and references the microarchitecture description in
the Go Wiki,
https://github.com/golang/go/wiki/MinimumRequirements#amd64,
and references the same information in the output of go help
environment.
Fixes #50174
Change-Id: I6a7d5a06f48463a810c96cc9c76fe66113d5147c
---
M src/cmd/go/internal/help/helpdoc.go
M doc/go1.18.html
M src/cmd/go/alldocs.go
3 files changed, 25 insertions(+), 6 deletions(-)
To view, visit change 372194. To unsubscribe, or for help writing mail filters, visit settings.
Ulrich Kunitz (Gerrit)
Attention is currently required from: Keith Randall.
5 comments:
Patchset:
I have addressed Keith's comments in a second patch set.
File doc/go1.18.html:
Patch Set #1, Line 121:
for compilation
I don't think "for compilation" adds anything. Maybe "... […]
Done
Patch Set #1, Line 125:
#microarchitecture-supportShould probably link directly to #amd64
My intention was to include to reference the general information as well. I have now added a reference to the general section in the amd64 section and link to it directly.
File src/cmd/go/alldocs.go:
Patch Set #1, Line 2080:
#microarchitecture-support
Same here, link to #amd64 section. […]
Done
File src/cmd/go/internal/help/helpdoc.go:
Done
To view, visit change 372194. To unsubscribe, or for help writing mail filters, visit settings.
Keith Randall (Gerrit)
Attention is currently required from: Ulrich Kunitz.
Patch set 2:Code-Review +2
Keith Randall (Gerrit)
Attention is currently required from: Ulrich Kunitz.
Patch set 2:Run-TryBot +1
Ian Lance Taylor (Gerrit)
Attention is currently required from: Ulrich Kunitz.
3 comments:
Commit Message:
Patch Set #2, Line 7:
doc: Improve documentation for GOAMD64s/Improve/improve/
Patch Set #2, Line 12:
https://github.com/golang/go/wiki/MinimumRequirements#amd64,Write this as
File src/cmd/go/internal/help/helpdoc.go:
To view, visit change 372194. To unsubscribe, or for help writing mail filters, visit settings.
Ulrich Kunitz (Gerrit)
Attention is currently required from: Ulrich Kunitz.
Ulrich Kunitz uploaded patch set #3 to this change.
doc: improve documentation for GOAMD64
The change clarifies in the release notes for go1.18 that the variable
is for compilation and references the microarchitecture description in
the Go Wiki,
https://golang.org/wiki/MinimumRequirements#amd64,
and references the same information in the output of go help
environment.
Fixes #50174
Change-Id: I6a7d5a06f48463a810c96cc9c76fe66113d5147c
---
M src/cmd/go/internal/help/helpdoc.go
M doc/go1.18.html
M src/cmd/go/alldocs.go
3 files changed, 25 insertions(+), 6 deletions(-)
To view, visit change 372194. To unsubscribe, or for help writing mail filters, visit settings.
Ulrich Kunitz (Gerrit)
Attention is currently required from: Ian Lance Taylor.
4 comments:
Commit Message:
Patch Set #2, Line 7:
doc: Improve documentation for GOAMD64s/Improve/improve/
Done
Write this as […]
Done
Patchset:
Resolved all of Ian's comments.
File src/cmd/go/internal/help/helpdoc.go:
https://golang. […]
I have changed the reference in all place where it is listed: commit message, doc/go1.18.html, src/cmd/go/internal/help/helpdoc.go and also src/cmd/go/alldocs.go by executing src/cmd/go/mkalldocs.sh.
To view, visit change 372194. To unsubscribe, or for help writing mail filters, visit settings.
Ian Lance Taylor (Gerrit)
Attention is currently required from: Ulrich Kunitz.
Patch set 3:Run-TryBot +1Code-Review +2
Keith Randall (Gerrit)
Keith Randall submitted this change.
doc: improve documentation for GOAMD64
The change clarifies in the release notes for go1.18 that the variable
is for compilation and references the microarchitecture description in
the Go Wiki,
https://golang.org/wiki/MinimumRequirements#amd64,
and references the same information in the output of go help
environment.
Fixes #50174
Change-Id: I6a7d5a06f48463a810c96cc9c76fe66113d5147c
Reviewed-on: https://go-review.googlesource.com/c/go/+/372194
Reviewed-by: Keith Randall <k...@golang.org>
Reviewed-by: Ian Lance Taylor <ia...@golang.org>
Run-TryBot: Ian Lance Taylor <ia...@golang.org>
TryBot-Result: Gopher Robot <go...@golang.org>
---
M src/cmd/go/internal/help/helpdoc.go
M doc/go1.18.html
M src/cmd/go/alldocs.go
3 files changed, 30 insertions(+), 6 deletions(-)
diff --git a/doc/go1.18.html b/doc/go1.18.html
index a5d7dcf..0f313ee 100644
--- a/doc/go1.18.html
+++ b/doc/go1.18.html
@@ -143,11 +143,12 @@
<h3 id="amd64">AMD64</h3>
<p><!-- CL 349595 -->
- Go 1.18 introduces the new <code>GOAMD64</code> environment variable which selects
- a version of the AMD64 architecture. Allowed values are <code>v1</code>,
+ Go 1.18 introduces the new <code>GOAMD64</code> environment variable, which selects
+ a mininum target version of the AMD64 architecture. Allowed values are <code>v1</code>,
<code>v2</code>, <code>v3</code>, or <code>v4</code>. Each higher level requires,
- and takes advantage of, additional processor features. A detailed description of the
- versions is <a href="https://en.wikipedia.org/wiki/X86-64#Microarchitecture_levels">here</a>.
+ and takes advantage of, additional processor features. A detailed
+ description can be found
+ <a href="https://golang.org/wiki/MinimumRequirements#amd64">here</a>.
</p>
<p>
The <code>GOAMD64</code> environment variable defaults to <code>v1</code>.
diff --git a/src/cmd/go/alldocs.go b/src/cmd/go/alldocs.go
index d903214..3bb9d14 100644
--- a/src/cmd/go/alldocs.go
+++ b/src/cmd/go/alldocs.go
@@ -2131,7 +2131,7 @@
// GOAMD64
// For GOARCH=amd64, the microarchitecture level for which to compile.
// Valid values are v1 (default), v2, v3, v4.
-// See https://en.wikipedia.org/wiki/X86-64#Microarchitecture_levels.
+// See https://golang.org/wiki/MinimumRequirements#amd64
// GOMIPS
// For GOARCH=mips{,le}, whether to use floating point instructions.
// Valid values are hardfloat (default), softfloat.
diff --git a/src/cmd/go/internal/help/helpdoc.go b/src/cmd/go/internal/help/helpdoc.go
index 035235f..7dc066c 100644
--- a/src/cmd/go/internal/help/helpdoc.go
+++ b/src/cmd/go/internal/help/helpdoc.go
@@ -595,7 +595,7 @@
GOAMD64
For GOARCH=amd64, the microarchitecture level for which to compile.
Valid values are v1 (default), v2, v3, v4.
- See https://en.wikipedia.org/wiki/X86-64#Microarchitecture_levels.
+ See https://golang.org/wiki/MinimumRequirements#amd64
GOMIPS
For GOARCH=mips{,le}, whether to use floating point instructions.
Valid values are hardfloat (default), softfloat.
To view, visit change 372194. To unsubscribe, or for help writing mail filters, visit settings.