Date: Thu, 05 Mar 2026 21:11:23 +0000 From: Adam Weinberger <adamw@FreeBSD.org> To: ports-committers@FreeBSD.org, dev-commits-ports-all@FreeBSD.org, dev-commits-ports-main@FreeBSD.org Subject: git: 5640cefb03ff - main - Mk/Uses/go.mk: Minor documentation improvements Message-ID: <69a9f17b.275ac.40dad2c8@gitrepo.freebsd.org>
index | next in thread | raw e-mail
The branch main has been updated by adamw: URL: https://cgit.FreeBSD.org/ports/commit/?id=5640cefb03ffdc19a7e8989509c66059236209ec commit 5640cefb03ffdc19a7e8989509c66059236209ec Author: Adam Weinberger <adamw@FreeBSD.org> AuthorDate: 2026-03-05 21:06:05 +0000 Commit: Adam Weinberger <adamw@FreeBSD.org> CommitDate: 2026-03-05 21:06:05 +0000 Mk/Uses/go.mk: Minor documentation improvements - Add links to PHB sections on porting Go apps - Reword the descriptions of most args to put the verb first (my theory is that this makes it easier to comprehend at a glance?) - Use "set up" for verb form and "setup" for noun form (my own pet peeve) - Consistently use tabs for leading whitespace --- Mk/Uses/go.mk | 53 +++++++++++++++++++++++++++++++++++------------------ 1 file changed, 35 insertions(+), 18 deletions(-) diff --git a/Mk/Uses/go.mk b/Mk/Uses/go.mk index 4693d55f44c4..6286aa15add0 100644 --- a/Mk/Uses/go.mk +++ b/Mk/Uses/go.mk @@ -2,20 +2,19 @@ # `go` command. # # Feature: go -# Usage: USES=go +# Usage: USES=go or USES=go:<arg1>[,<arg2>,...] # Valid ARGS: (none), N.NN+, N.NN, modules, no_targets, run # -# (none) Setup GOPATH and build in GOPATH mode using default Go version. +# (none) Build in GOPATH mode using default Go version. # N.NN+ Specify minimum Go version # N.NN Specify exact Go version (should be avoided) -# modules If the upstream uses Go modules, this can be set to build -# in modules-aware mode. -# no_targets Indicates that Go is needed at build time as a part of -# make/CMake build. This will setup build environment like -# GO_ENV, GO_BUILDFLAGS but will not create post-extract and -# do-{build,install,test} targets. -# run Indicates that Go is needed at run time and adds it to -# RUN_DEPENDS. +# modules Build in native, modules-aware mode (most Go ports use this) +# no_targets Use this when an app has its own make/cmake files that call Go. +# Sets up the build environment (GO_ENV, GO_BUILDFLAGS, etc.) but +# does not create make(1) targets (post-extract, do-build, +# do-install, do-test, etc.). +# run Adds the Go compiler to RUN_DEPENDS. Rarely needed; Go-based +# applications are compiled and only need Go at build time. # # Note about Go version specifiers (i.e. USES=go:1.20+): # Try to use a range (USES=go:1.20+) rather than a single-version pin @@ -29,6 +28,24 @@ # # When go.mod says "go 1.20", it's usually fine to say USES=go:1.20+. # +# === RESOURCES === +# Further documentation about porting Go-based applications: +# - https://docs.freebsd.org/en/books/porters-handbook/special/#using-go +# - https://docs.freebsd.org/en/books/porters-handbook/uses/#uses-go +# An explanation of why we accept ports only for Go-based applications, not +# libraries: +# - https://docs.freebsd.org/en/books/porters-handbook/special/#go-libs +# +# === REACHING OUT === +# For questions or assistance, reach out on mailing lists. The Go team +# monitors the FreeBSD-Go mailing list, but the FreeBSD-Ports list is far +# more active. +# - For help with porting, including Go apps (freebsd-ports@FreeBSD.org): +# https://lists.freebsd.org/subscription/freebsd-ports +# - For questions about the Go framework itself (freebsd-go@FreeBSD.org): +# https://lists.freebsd.org/subscription/freebsd-go +# +# === DOCUMENTATION ON USES=go === # You can set the following variables to control the process. # # GO_MODULE @@ -37,14 +54,14 @@ # use Go modules. # # GO_MOD_DIST -# The location to download the go.mod file if GO_MODULE is used. -# The default is empty, so it is loaded from GO_PROXY. -# Set it to "gitlab" and make sure GL_PROJECT is defined to download -# the "go.mod" from gitlab. -# Set it to "github" and make sure GH_PROJECT is defined to download -# the "go.mod" from github. -# You can also set it completely manually a URI without go.mod in it, -# is attached automatically to the URI. +# The location to download the go.mod file if GO_MODULE is used. +# The default is empty, so it is loaded from GO_PROXY. +# Set it to "gitlab" and make sure GL_PROJECT is defined to download +# the "go.mod" from gitlab. +# Set it to "github" and make sure GH_PROJECT is defined to download +# the "go.mod" from github. +# You can also set it completely manually a URI without go.mod in it, +# is attached automatically to the URI. # # GO_PKGNAME # The name of the package when building in GOPATH mode. Thishome | help
Want to link to this message? Use this
URL: <https://mail-archive.FreeBSD.org/cgi/mid.cgi?69a9f17b.275ac.40dad2c8>