Document behaviour of extra_args with bazel run (#1112)

* Document behaviour of extra_args with bazel run Fixes #536
bazelbuild · Nov 12, 2021 · dd75850 · dd75850
1 parent ed095a3
commit dd75850
Showing 1 changed file with 4 additions and 1 deletion.
diff --git a/README.rst b/README.rst
@@ -302,7 +302,10 @@ The following attributes are available on the ``gazelle`` rule.
 +----------------------+---------------------+--------------------------------------+
 | :param:`extra_args`  | :type:`string_list` | :value:`[]`                          |
 +----------------------+---------------------+--------------------------------------+
-| A list of extra command line arguments passed to Gazelle.                         |
+| A list of extra command line arguments passed to Gazelle.  Note that              |
+| ``extra_args`` are suppressed by extra command line args (e.g.                    |
+| ``bazel run //:gazelle -- subdir``).                                              |  
+| See https://github.com/bazelbuild/bazel-gazelle/issues/536 for explanation.       |
 +----------------------+---------------------+--------------------------------------+
 | :param:`command`     | :type:`string`      | :value:`update`                      |
 +----------------------+---------------------+--------------------------------------+