diff options
| author | David Benjamin <davidben@google.com> | 2023-02-10 13:25:14 -0500 |
|---|---|---|
| committer | Boringssl LUCI CQ <boringssl-scoped@luci-project-accounts.iam.gserviceaccount.com> | 2023-02-10 18:50:34 +0000 |
| commit | ace33161544814ed6dc9e9d17cfde0422881b9d2 (patch) | |
| tree | 70aec8d572029449c7d90f6c3f4d52e7daa76f36 /INCORPORATING.md | |
| parent | bd7e4197cdb889f13ce01cf1a029eaa7b6cd6da9 (diff) | |
| download | boringssl-ace33161544814ed6dc9e9d17cfde0422881b9d2.zip boringssl-ace33161544814ed6dc9e9d17cfde0422881b9d2.tar.gz boringssl-ace33161544814ed6dc9e9d17cfde0422881b9d2.tar.bz2 | |
Add a note in INCORPORATING about which branch to use
Especially when they were named "2214" instead of "chromium-2214", I've
seen papers and other projects treat them as releases. Add a note to
make it clear they are not releases.
Change-Id: Ie820b800de3d25a31d3083d4ceff75e1d7f74a06
Reviewed-on: https://boringssl-review.googlesource.com/c/boringssl/+/57145
Reviewed-by: Bob Beck <bbe@google.com>
Auto-Submit: David Benjamin <davidben@google.com>
Commit-Queue: Bob Beck <bbe@google.com>
Diffstat (limited to 'INCORPORATING.md')
| -rw-r--r-- | INCORPORATING.md | 16 |
1 files changed, 16 insertions, 0 deletions
diff --git a/INCORPORATING.md b/INCORPORATING.md index 96bf908..f793e88 100644 --- a/INCORPORATING.md +++ b/INCORPORATING.md @@ -3,6 +3,22 @@ **Note**: if your target project is not a Google project then first read the [main README](/README.md) about the purpose of BoringSSL. +## Which branch to use + +BoringSSL usage typically follows a +["live at head"](https://abseil.io/about/philosophy#we-recommend-that-you-choose-to-live-at-head) +model. Projects pin to whatever the current latest of BoringSSL is at the time +of update, and regularly update it to pick up new changes. + +While the BoringSSL repository may contain project-specific branches, e.g. +`chromium-2214`, those are _not_ supported release branches and must not as +such. In rare cases, BoringSSL will temporarily maintain a short-lived branch on +behalf of a project. Most such branches are no longer updated, because the +corresponding project no longer needs them, and we do not create new ones to +replace the ones that are no longer updated. E.g., not every Chromium release +branch has a corresponding BoringSSL `chromium-*` branch. Even while active, the +branch may not contain all changes relevant to a general BoringSSL consumer. + ## Bazel If you are using [Bazel](https://bazel.build) then you can incorporate |