docs: Mention that gazelle:prefix can be replaced by go.mod (#3577)

bazelbuild · Jun 1, 2023 · bd5b65e · bd5b65e
1 parent b8d560e
commit bd5b65e
Showing 1 changed file with 7 additions and 2 deletions.
diff --git a/docs/go/core/bzlmod.md b/docs/go/core/bzlmod.md
@@ -75,15 +75,20 @@ If you have a use case that would require this, please explain it in an issue.
 
 ## Generating BUILD files
 
-Add the following to your top-level BUILD file, including your Go module's path in a [Gazelle directive](https://github.com/bazelbuild/bazel-gazelle#directives):
+Add the following to your top-level BUILD file:
 
 ```starlark
 load("@gazelle//:def.bzl", "gazelle")
 
-# gazelle:prefix github.com/example/project
 gazelle(name = "gazelle")
 ```
 
+If there is no `go.mod` file in the same directory as your top-level BUILD file, also add the following [Gazelle directive](https://github.com/bazelbuild/bazel-gazelle#directives) to that BUILD file to supply Gazelle with your Go module's path:
+
+```starlark
+# gazelle:prefix github.com/example/project
+```
+
 Then, use `bazel run //:gazelle` to (re-)generate BUILD files.
 
 ## External dependencies