aboutsummaryrefslogtreecommitdiff
path: root/_content/doc/modules/gomod-ref.md
AgeCommit message (Collapse)Author
2025-02-26doc/modules: fix link and formatting on godebug sectiondoc-modules-format.mailedShulhan
Using markdown inside HTML markup does not work, it rendered as is. So, replace the link by directly using anchor tag and backtick using code tag. Change-Id: I8ff966e64680640ec85b63811211a2e0fcbaf4b7
2024-12-06_content/doc: document module toolsConrad Irwin
For golang/go#48429 Change-Id: I81344da002afe92c8ec60ad5acef0b11e487934e Reviewed-on: https://go-review.googlesource.com/c/website/+/632595 Reviewed-by: Sam Thanawalla <samthanawalla@google.com> Reviewed-by: Michael Matloob <matloob@golang.org> LUCI-TryBot-Result: Go LUCI <golang-scoped@luci-project-accounts.iam.gserviceaccount.com>
2024-10-10_content/doc/modules: document godebug directive in go.modSean Liao
Fixes golang/go#69688 Updates golang/go#56986 Change-Id: I4c55b57d974b434fec74e38034d1ce033204ae12 Reviewed-on: https://go-review.googlesource.com/c/website/+/618115 Reviewed-by: Tim King <taking@google.com> Auto-Submit: Tim King <taking@google.com> Reviewed-by: Cherry Mui <cherryyz@google.com> LUCI-TryBot-Result: Go LUCI <golang-scoped@luci-project-accounts.iam.gserviceaccount.com> Reviewed-by: Michael Matloob <matloob@golang.org>
2023-06-15_content: fix broken Markdown links to /doc/toolchainMax Riveiro
Change-Id: I2256da09dcbc20832c5f6c3eb48a884af8ad604a GitHub-Last-Rev: fa7f86b3b409e8d27bf93aacb219ccbaadec9a78 GitHub-Pull-Request: golang/website#228 Reviewed-on: https://go-review.googlesource.com/c/website/+/503235 Reviewed-by: David Chase <drchase@google.com> Reviewed-by: Tatiana Bradley <tatianabradley@google.com> Run-TryBot: Russ Cox <rsc@golang.org> Reviewed-by: Bryan Mills <bcmills@google.com> TryBot-Result: Gopher Robot <gobot@golang.org> Auto-Submit: Russ Cox <rsc@golang.org> Reviewed-by: Russ Cox <rsc@golang.org>
2023-06-12_content: add https://go.dev/doc/toolchainRuss Cox
This documents the new toolchain selection and switching for the forward compatibility work. For golang/go#57001. Change-Id: I0efdac6771018063446dd0db22013c5fd756bea4 Reviewed-on: https://go-review.googlesource.com/c/website/+/500775 Run-TryBot: Russ Cox <rsc@golang.org> Reviewed-by: Michael Matloob <matloob@golang.org> Reviewed-by: Bryan Mills <bcmills@google.com> TryBot-Result: Gopher Robot <gobot@golang.org> Auto-Submit: Russ Cox <rsc@golang.org>
2021-09-08_content/doc: module naming best practicesSteve Traut
This adds new content with best practices for the module path. It also revises existing content to use the best practice. This change includes: * A new "Naming a module" section in "Managing dependencies" describing naming best practices and reserved terms for module paths. * Changing module path prefix from "example.com/*" to "example/*" where the content seems aimed specifically at new users. This is designed to reduce confusion for those who wonder if a domain name is required in the local, simple context. * Links to the "Naming a module" section so that new users can follow up from the simple case to learn about best practices. Change-Id: I07eac1f805ce506a486d3c0e7b54539554e3c30b Reviewed-on: https://go-review.googlesource.com/c/website/+/344469 Trust: Steve Traut <straut@google.com> Trust: Bryan C. Mills <bcmills@google.com> Reviewed-by: Bryan C. Mills <bcmills@google.com> Run-TryBot: Bryan C. Mills <bcmills@google.com> TryBot-Result: Go Bot <gobot@golang.org>
2021-08-06_content/ref/mod: update terminology for Go 1.17 changesBryan C. Mills
For golang/go#47397 Change-Id: I7046bddb17bdd7957603e16580e7c9bab4a8c05a Reviewed-on: https://go-review.googlesource.com/c/website/+/339991 Trust: Bryan C. Mills <bcmills@google.com> Run-TryBot: Bryan C. Mills <bcmills@google.com> TryBot-Result: Go Bot <gobot@golang.org> Reviewed-by: Jay Conrod <jayconrod@google.com>
2021-07-21_content/doc/modules: add retract directive to go.mod referenceJay Conrod
Change-Id: Ib2316795409776a9db2dd6293b76d7c0003ba7f4 Reviewed-on: https://go-review.googlesource.com/c/website/+/335690 Trust: Jay Conrod <jayconrod@google.com> Run-TryBot: Jay Conrod <jayconrod@google.com> TryBot-Result: Go Bot <gobot@golang.org> Reviewed-by: Steve Traut <straut@google.com>
2021-07-19_content/doc/modules/gomod-ref: add links to /ref/modBryan C. Mills
Also update the list of behaviors controlled by the go directive for Go 1.17. Change-Id: Ie9eee13f0c43efd41f97d8d7c30a5ec354064776 Reviewed-on: https://go-review.googlesource.com/c/website/+/335141 Trust: Bryan C. Mills <bcmills@google.com> Run-TryBot: Bryan C. Mills <bcmills@google.com> TryBot-Result: Go Bot <gobot@golang.org> Reviewed-by: Steve Traut <straut@google.com>
2021-07-15_content/doc: remove duplicated "does not"Frederik Zipp
Change-Id: I8930b2e394c30334b99bb3e169e805f2025ec7d9 Reviewed-on: https://go-review.googlesource.com/c/website/+/324709 Reviewed-by: Dmitri Shuralyov <dmitshur@golang.org> Reviewed-by: Jay Conrod <jayconrod@google.com> Run-TryBot: Dmitri Shuralyov <dmitshur@golang.org> Trust: Ian Lance Taylor <iant@golang.org>
2021-06-02_content/doc: clarify that a replace directive does not imply requireJay Conrod
This came up a couple times in Slack recently. I was confused about this myself before we switched to -mod=readonly. Change-Id: I3bafe347f4f9ecc3599e4b2568701422c95066c3 Reviewed-on: https://go-review.googlesource.com/c/website/+/322669 Trust: Jay Conrod <jayconrod@google.com> Reviewed-by: Bryan C. Mills <bcmills@google.com>
2021-03-24_content/doc/modules: fix typosJay Conrod
Fixes golang/go#45204 Fixes golang/go#45205 Change-Id: Ieb9f06a5eb35b2cc7d312a97db1293132e81251a Reviewed-on: https://go-review.googlesource.com/c/website/+/304469 Trust: Jay Conrod <jayconrod@google.com> Run-TryBot: Jay Conrod <jayconrod@google.com> TryBot-Result: Go Bot <gobot@golang.org> Reviewed-by: Steve Traut <straut@google.com>
2021-03-19_content/doc: add details about semantics of go directive in go.modJay Conrod
Change-Id: I53a86d44165cd5a8f7fa523dd914fb1b127bf953 Reviewed-on: https://go-review.googlesource.com/c/website/+/301349 Trust: Jay Conrod <jayconrod@google.com> Trust: Steve Traut <straut@google.com> Run-TryBot: Jay Conrod <jayconrod@google.com> TryBot-Result: Go Bot <gobot@golang.org> Reviewed-by: Steve Traut <straut@google.com> Reviewed-by: Bryan C. Mills <bcmills@google.com>
2021-03-12_content/doc: remove redundant Path metadataRuss Cox
CL 251343 (Feb 12) changed the default service URL for _content/doc/x.html from https://golang.org/doc/x.html to https://golang.org/doc/x. Remove Path metadata that simply restates this new default. Change-Id: Ia132c08f200c5a93554755cd1cd8429c9f8f3062 Reviewed-on: https://go-review.googlesource.com/c/website/+/296382 Trust: Russ Cox <rsc@golang.org> Run-TryBot: Russ Cox <rsc@golang.org> TryBot-Result: Go Bot <gobot@golang.org> Reviewed-by: Dmitri Shuralyov <dmitshur@golang.org>
2021-03-12_content: remove trailing spacesRuss Cox
Change-Id: Ide6008487c296dbd8d8f8cd6bd4eae54c2590127 Reviewed-on: https://go-review.googlesource.com/c/website/+/296381 Trust: Russ Cox <rsc@golang.org> Run-TryBot: Russ Cox <rsc@golang.org> TryBot-Result: Go Bot <gobot@golang.org> Reviewed-by: Dmitri Shuralyov <dmitshur@golang.org>
2021-03-07_content/doc: fix typosFrederik Zipp
This change corrects various misspelled words in the documentation and adds a missing "to" in the Code of Conduct. Change-Id: I64c65b1670faeb230144a29161c48c2c654871cd Reviewed-on: https://go-review.googlesource.com/c/website/+/299130 Reviewed-by: Alberto Donizetti <alb.donizetti@gmail.com> Reviewed-by: Emmanuel Odeke <emmanuel@orijtech.com> Trust: Alberto Donizetti <alb.donizetti@gmail.com> Run-TryBot: Alberto Donizetti <alb.donizetti@gmail.com> TryBot-Result: Go Bot <gobot@golang.org>
2021-03-02_content/doc: fix module and tutorial bugs and clean up flowSteve Traut
For golang/go#44241 - Fix issues 2, 3, 8, 16, 17, 18 from golang/go#44241 Other changes in multiple topics: - In markdown, replace HTML anchor tags with {#anchor} tags. - In a few places, add content to clarify that module path must be a location from which the module can be downloaded. - Where it was missing, add example.com domain to example module paths. Hopefully, this will reinforce the idea that the module path should typically include a domain. Docs will use something that looks like a domain name for module path. - Add more cross-references from tutorial to references for packages and commands. - Rewrite a few links so that they include the topic title, rather than simply inline text. Left those links whose destinations are references -- the item's name seems to suggest that a reference is at the destination. - Remove domain name from golang.org doc links, leaving root directory. Such as /cmd/go/* or /doc/modules/* - Add path up to root for all links in the same domain. Some were linking by file name only. - Change standard library links from golang.org to pkg.go.dev. Changes in the module tutorial: - Add text to help clarify that there should be a hello and greetings directory as siblings in their directory hierarchy. Some users thought one should be subordinate to the other. - Where needed, reorder steps so that `go mod init` is run before code is added. This is intended to reinforce the importance of the module's presence. - In require/replace steps, have the user use `go mod edit` rather than editing the go.mod file in an editor. The tools are more likely to yield a functioning result. - Where possible/appropriate, change module directive link destinations from "Modules reference" to go.mod reference. - Change "run the code" steps so that they all use `go run .` rather than `go build` or `go run <filename>`. This removes the impedance of explanation and more commands, while moving the explanation of `go build` and `go install` to a separate topic where they share a clearer context. - Add a "Conclusion" topic with a few links. The tutorial ended rather abruptly before. - Minor edits to remove some redundant language. Change-Id: I93055035d73c362ba73edea458fc53bc45e66512 Reviewed-on: https://go-review.googlesource.com/c/website/+/297531 Trust: Steve Traut <straut@google.com> Run-TryBot: Steve Traut <straut@google.com> TryBot-Result: Go Bot <gobot@golang.org> Reviewed-by: Jay Conrod <jayconrod@google.com>
2021-02-25_content/doc: fix typos, broken links, and text formattingFrederik Zipp
For golang/go#44241 Change-Id: Ie23c99c6e36c618d0a3135167cf780f02ea3e3ea Reviewed-on: https://go-review.googlesource.com/c/website/+/293229 Run-TryBot: Steve Traut <straut@google.com> TryBot-Result: Go Bot <gobot@golang.org> Reviewed-by: Steve Traut <straut@google.com> Trust: Dmitri Shuralyov <dmitshur@golang.org>
2021-02-17_content/doc/modules: fix typo in gomod-ref.mdAndrea Simonini
Fix typo in the description of the sample replace directive. Change-Id: Ifce15609e096253c07137bf6727568bde58982c3 GitHub-Last-Rev: 54973c41cf0cf7272e4940c597bb1ee814f9ce29 GitHub-Pull-Request: golang/website#38 Reviewed-on: https://go-review.googlesource.com/c/website/+/292991 Reviewed-by: Steve Traut <straut@google.com> Trust: Dmitri Shuralyov <dmitshur@golang.org>
2021-02-16_content: move content/static/* to _content/*Russ Cox
The extra level of hierarchy here is unnecessary and confusing. The directory is now _content so that any Go source files in our docs are not considered by commands like "go mod tidy" and "go test all". Change-Id: Ib6d7cb12920193798ee825155a8f8b33f16e60d8 Reviewed-on: https://go-review.googlesource.com/c/website/+/291691 Trust: Russ Cox <rsc@golang.org> Run-TryBot: Russ Cox <rsc@golang.org> TryBot-Result: Go Bot <gobot@golang.org> Reviewed-by: Dmitri Shuralyov <dmitshur@golang.org>