pw_package: Add note about preferring submodules
Change-Id: I6087b51aa3e20657974f52a0295e0d3f31f371fa
Reviewed-on: https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/89560
Pigweed-Auto-Submit: Rob Mohr <mohrr@google.com>
Reviewed-by: Keir Mierle <keir@google.com>
Commit-Queue: Auto-Submit <auto-submit@pigweed.google.com.iam.gserviceaccount.com>
diff --git a/pw_package/docs.rst b/pw_package/docs.rst
index 24037e5..78d99b8 100644
--- a/pw_package/docs.rst
+++ b/pw_package/docs.rst
@@ -16,6 +16,13 @@
* The dependency needs to be "installed" into the system in some manner beyond
just extraction and thus isn't a good match for distribution with CIPD.
+Pigweed itself includes a number of packages that simply clone git repositories.
+In general, these should not be used by projects using Pigweed. Pigweed uses
+these packages to avoid using submodules so downstream projects don't have
+multiple copies of a given repository in their source tree. Projects using
+Pigweed should use submodules instead of packages because submodules are
+supported by much more mature tooling: git.
+
-----
Usage
-----
