diff options
| author | Chris Blume <cblume@chromium.org> | 2018-02-06 19:33:29 +0000 |
|---|---|---|
| committer | Commit Bot <commit-bot@chromium.org> | 2018-02-06 19:33:29 +0000 |
| commit | 0ef6628e3fbedd342e491941fe3f7f1e67b4fda3 (patch) | |
| tree | de212f17927b504e11e01be9301a7841262d6008 /patches | |
| parent | bb1fbeac41146ae250ff0198b7a749d9832f8fe7 (diff) | |
| download | zlib-0ef6628e3fbedd342e491941fe3f7f1e67b4fda3.tar.gz | |
Clarify when a .patch file must be generated
The current README is unclear about when a .patch file must be generated
and how we intend to isolate our changes from upstream changes.
This patch clarifies how someone can contribute to third_party/zlib
while minimizing risk of conflicts with upstream changes.
BUG=807488
Change-Id: Iaa503b94f110cb83febbdd8d57527d606d3eb779
Reviewed-on: https://chromium-review.googlesource.com/894856
Reviewed-by: Adenilson Cavalcanti <cavalcantii@chromium.org>
Reviewed-by: Mike Klein <mtklein@chromium.org>
Commit-Queue: Chris Blume <cblume@chromium.org>
Cr-Original-Commit-Position: refs/heads/master@{#534751}
Cr-Mirrored-From: https://chromium.googlesource.com/chromium/src
Cr-Mirrored-Commit: 1511a018f9fecad9c4c873b19156ad74d6c64eee
Diffstat (limited to 'patches')
| -rw-r--r-- | patches/README | 19 |
1 files changed, 17 insertions, 2 deletions
diff --git a/patches/README b/patches/README index 687842c..4cf06b8 100644 --- a/patches/README +++ b/patches/README @@ -19,8 +19,23 @@ the need to append this file with a description of what the patch does. This should help to solve frequent conflicts in pending new patches on Chromium's zlib. - The plan for the near future is to insulate better the platform specific -changes to easy updates with new releases of zlib. + The plan for the near future is to better insulate the platform specific +changes to ease update adoption with new releases of zlib. This insulation +happens by making changes inside contrib/ rather than the root directory +(where conflicts can happen). + + If a change modifies enough things inside the root directory that the +intention is not immediately clear, generate a .patch file to go with your +change. If the change's modifications in the root directory are small, like: + +#ifdef FEATURE_FLAG +use_special_feature(); +#elif +use_default_behavior(); +#endif + + then the intent is clear and a .patch file doesn't need to be generated (since +it would not provide much value). Ideally local changes should have a merge request featured in either: - canonical zlib: https://github.com/madler/zlib/ |