diff options
| author | Rob Mohr <mohrr@google.com> | 2022-04-01 10:05:13 -0700 |
|---|---|---|
| committer | CQ Bot Account <pigweed-scoped@luci-project-accounts.iam.gserviceaccount.com> | 2022-04-01 17:47:21 +0000 |
| commit | eba38dc0801b3f09ac642a3c2a5712d5f869c744 (patch) | |
| tree | 07238c4b6a57354a2c8863fe02c3b62db9c83b55 | |
| parent | 6c03473f824bd8d665f832670f592e0f90d6a71c (diff) | |
| download | pigweed-eba38dc0801b3f09ac642a3c2a5712d5f869c744.tar.gz | |
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>
| -rw-r--r-- | pw_package/docs.rst | 7 |
1 files changed, 7 insertions, 0 deletions
diff --git a/pw_package/docs.rst b/pw_package/docs.rst index 24037e55a..78d99b8f4 100644 --- a/pw_package/docs.rst +++ b/pw_package/docs.rst @@ -16,6 +16,13 @@ this module instead are listed below. * 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 ----- |