aboutsummaryrefslogtreecommitdiffhomepage
path: root/doc/core/pending_api_cleanups.md
diff options
context:
space:
mode:
authorGravatar Mark D. Roth <roth@google.com>2016-09-15 08:40:21 -0700
committerGravatar Mark D. Roth <roth@google.com>2016-09-15 08:40:21 -0700
commit6751ac6ffe77c32fe2e4f4873f25ae4e5019bb18 (patch)
tree6bcb1eb7694b277e39f8048315edb39d55745a8a /doc/core/pending_api_cleanups.md
parentf5afcd9f65900b8aa6003d6c7b7c43e44b34a623 (diff)
Add doc listing API changes to clean up for the next minor-version release.
Diffstat (limited to 'doc/core/pending_api_cleanups.md')
-rw-r--r--doc/core/pending_api_cleanups.md15
1 files changed, 15 insertions, 0 deletions
diff --git a/doc/core/pending_api_cleanups.md b/doc/core/pending_api_cleanups.md
new file mode 100644
index 0000000000..a16d3bf778
--- /dev/null
+++ b/doc/core/pending_api_cleanups.md
@@ -0,0 +1,15 @@
+There are times when we make changes that include a temporary shim for
+backward-compatibility (e.g., a macro or some other function to preserve
+the original API) to avoid having to bump the minor version number in
+the next release. However, when we do eventually want to release a
+feature that does change the API in a non-backward-compatible way, we
+will wind up bumping the minor version number anyway, at which point we
+can take the opportunity to clean up any pending backward-compatibility
+shims.
+
+This file lists all pending backward-compatibility changes that should
+be cleaned up the next time we are going to bump the minor version
+number:
+
+- remove `GRPC_ARG_MAX_MESSAGE_LENGTH` channel arg from
+ `include/grpc/impl/codegen/grpc_types.h` (commit `af00d8b`)