aboutsummaryrefslogtreecommitdiffhomepage
diff options
context:
space:
mode:
authorGravatar Mark D. Roth <roth@google.com>2016-09-27 13:16:18 -0700
committerGravatar Mark D. Roth <roth@google.com>2016-09-27 13:16:18 -0700
commite8b87865b268856d5510abb6ffd044224c079c13 (patch)
tree973f09c4cc406f9ecb6edb23b6749a69b8053bd7
parent94777240032e41dd0cfb56218a09912395aded05 (diff)
Add doc of pending API cleanups for C++.
-rw-r--r--doc/cpp/pending_api_cleanups.md15
1 files changed, 15 insertions, 0 deletions
diff --git a/doc/cpp/pending_api_cleanups.md b/doc/cpp/pending_api_cleanups.md
new file mode 100644
index 0000000000..3e77b657c6
--- /dev/null
+++ b/doc/cpp/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 major 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 major 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 major version
+number:
+
+- remove `ClientContext::set_fail_fast()` method from
+ `include/grpc++/impl/codegen/client_context.h` (commit `9477724`)