aboutsummaryrefslogtreecommitdiffhomepage
path: root/doc
diff options
context:
space:
mode:
authorGravatar Mark D. Roth <roth@google.com>2016-10-07 13:06:59 -0700
committerGravatar GitHub <noreply@github.com>2016-10-07 13:06:59 -0700
commit70c0b32c0fc5db15c764a2e22c2491d19d7cff7b (patch)
tree28d60496da8d7b4b47c8ad4f1206590ac4863ec9 /doc
parent9fee24f3a6a5360098cf76b5ef3707d6c3758779 (diff)
parent8bc8a83656eaf1bb3b1362edbb590013bd62a4a7 (diff)
Merge pull request #8219 from markdroth/fail_fast
Change C++ API to expose wait_for_ready instead of fail_fast.
Diffstat (limited to 'doc')
-rw-r--r--doc/core/pending_api_cleanups.md2
-rw-r--r--doc/cpp/pending_api_cleanups.md15
2 files changed, 17 insertions, 0 deletions
diff --git a/doc/core/pending_api_cleanups.md b/doc/core/pending_api_cleanups.md
index a12e8a9dfb..a0a960e5e2 100644
--- a/doc/core/pending_api_cleanups.md
+++ b/doc/core/pending_api_cleanups.md
@@ -15,3 +15,5 @@ number:
`include/grpc/impl/codegen/grpc_types.h` (commit `af00d8b`)
- remove `ServerBuilder::SetMaxMessageSize()` method from
`include/grpc++/server_builder.h` (commit `6980362`)
+- remove `GRPC_INITIAL_METADATA_IGNORE_CONNECTIVITY` macro from
+ `include/grpc/impl/codegen/grpc_types.h` (commit `59c9f90`)
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`)