Go Build Tags: Difference between revisions
Line 24: | Line 24: | ||
When the tags are separated by spaces in the declaration, is sufficient that any of them is present for the file to be compiled. The following declaration: | When the tags are separated by spaces in the declaration, is sufficient that any of them is present for the file to be compiled. The following declaration: | ||
<syntaxhighlight lang='go'> | <syntaxhighlight lang='go'> | ||
// | //go:build tag_a tag_b tag_c | ||
package somepkg | package somepkg |
Revision as of 22:28, 7 March 2024
Internal
Overview
A build tag is an identifier added to a piece of code that determines when the file should be including in a package during the build process.
Build tags provide conditional compilation in Go. Go does not have a preprocessor, a macro system, or a #define declaration to control the inclusion of platform-specific code, it uses build tags instead.
Build tags are implemented as comments which must appear at the top of the file in any source file (not just go files). To differentiate between the package and build tags, there must be a blank line between them:
//go:build tag_a tag_b
package somepkg
Providing Tags on Command Line
go build|test -tags=tag_a [...]
Combining Tags
Multiple tags are supported, and they can be combined using an OR, AND or NOT logic.
File will be Included if Either Tags are Present During Compilation
When the tags are separated by spaces in the declaration, is sufficient that any of them is present for the file to be compiled. The following declaration:
//go:build tag_a tag_b tag_c
package somepkg
has the semantics:
tag_a OR tag_b OR tag_c
File will be Included if All Tags are Present During Compilation
When the tags are separated by a comma in the declaration, all of them must be present . The following declaration:
// +build tag_a,tag_b,tag_c
package somepkg
has the semantics:
tag_a AND tag_b AND tag_c
File will Not Be Included if the Tag Is Present During Compilation
A negated tag means that the file will not be compiled if the tag is provided at compilation:
// +build !tag_a
package somepkg