Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

doc(debugger): announce deprecation #9552

Merged
merged 2 commits into from
Jul 22, 2022
Merged

doc(debugger): announce deprecation #9552

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
37e6934
doc(debugger): announce deprecation
coryan Jul 22, 2022
ac89cca
Fix some links
coryan Jul 22, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
93 changes: 57 additions & 36 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,54 +8,59 @@
<summary>2022-10-01: retiring legacy Spanner admin APIs</summary>
<br>

* On 2022-10-01 (or shortly after) we are planning to remove the hand-written
versions of the Spanner admin APIs. These have been superseded by versions
generated automatically from the service definitions. The new APIs can be
found in the [`google/cloud/spanner/admin`](https://github.com/googleapis/google-cloud-cpp/tree/main/google/cloud/spanner/admin)
tree and within the `google::cloud::spanner_admin` namespace. Starting with
the v1.32.0 release, and depending on your compiler settings, using the old
classes/functions may elicit a deprecation warning. See
[#7356](https://github.com/googleapis/google-cloud-cpp/issues/7356) for more
details.
On 2022-10-01 (or shortly after) we are planning to remove the hand-written
versions of the Spanner admin APIs. These have been superseded by versions
generated automatically from the service definitions. The new APIs can be
found in the [`google/cloud/spanner/admin`](https://github.com/googleapis/google-cloud-cpp/tree/main/google/cloud/spanner/admin)
tree and within the `google::cloud::spanner_admin` namespace. Starting with
the v1.32.0 release, and depending on your compiler settings, using the old
classes/functions may elicit a deprecation warning. See [#7356] for more
details.

[#7356]: https://github.com/googleapis/google-cloud-cpp/issues/7356
</details>

<details>
<summary>2022-11-01: remove `v1` and `gcpcxxV1` backward compatibility aliases</summary>
<br>

* On 2022-11-01 (or shortly after) we will remove the inline namespace aliases
of `v1` and `gcpcxxV1` that are declared in `google/cloud/version.h`. These
aliases exist because we changed the format of our inline namespace name to
include the major, minor, and patch numbers for each release, and we didn't
want to break users. Our Doxygen documentation was mistakenly recommending
that users include the inline namespace names in their code, but this was
also fixed to now recommend against doing so. Users should generally omit the
name of our versioned inline namespace name because that will tightly couple
their code to a specific release, and will make upgrading to newer versions
more difficult. Instead, users should simply omit the inline namespace name,
for example, instead of ~`google::cloud::v1::Status`~ use
`google::cloud::Status`. Please update your code to avoid naming the `v1` and
`gcpcxxV1` inline namespace names before 2022-11-01. For more info, see
https://github.com/googleapis/google-cloud-cpp/issues/7463 and
https://github.com/googleapis/google-cloud-cpp/issues/5976.
On 2022-11-01 (or shortly after) we will remove the inline namespace aliases
of `v1` and `gcpcxxV1` that are declared in `google/cloud/version.h`. These
aliases exist because we changed the format of our inline namespace name to
include the major, minor, and patch numbers for each release, and we didn't
want to break users. Our Doxygen documentation was mistakenly recommending
that users include the inline namespace names in their code, but this was
also fixed to now recommend against doing so. Users should generally omit the
name of our versioned inline namespace name because that will tightly couple
their code to a specific release, and will make upgrading to newer versions
more difficult. Instead, users should simply omit the inline namespace name,
for example, instead of ~`google::cloud::v1::Status`~ use
`google::cloud::Status`. Please update your code to avoid naming the `v1` and
`gcpcxxV1` inline namespace names before 2022-11-01. For more info, see
[#7463] and [#5976].

[#7463]: https://github.com/googleapis/google-cloud-cpp/issues/7463
[#5976]: https://github.com/googleapis/google-cloud-cpp/issues/5976
</details>

<details>
<summary>2023-02-01: remove `BigQueryReadReadRowsStreamingUpdater` from
`google::cloud::bigquery` namespace</summary>
<br>

* On 2023-02-01 (or shortly after) we will remove
On 2023-02-01 (or shortly after) we will remove
`BigQueryReadReadRowsStreamingUpdater` from its declaration in
`google/cloud/bigquery/read_connection.h` and from the `google::cloud::bigquery`
namespace. The function continues to exist but in an internal file and
namespace. For status on this see
https://github.com/googleapis/google-cloud-cpp/issues/8234.
namespace. For status on this see [#8234].

[#8234]: https://github.com/googleapis/google-cloud-cpp/issues/8234
</details>

<details>
<summary>2023-05-01: mark `bigtable::DataClient` as `final`</summary>
<br>

On 2023-05-01 (or shortly after) we will mark `bigtable::DataClient` as `final`
and remove the following member functions:
* `DataClient::Channel()`
Expand All @@ -65,34 +70,50 @@ and remove the following member functions:
Application developers should not need to interact with this class directly.
Please use `google::cloud::bigtable::MakeDataClient(...)` with the options from
`google::cloud::GrpcOptionList<>` if you need to configure the gRPC channel or
background threads.
background threads. More details can be found in [#8800].

For status on this, see https://github.com/googleapis/google-cloud-cpp/issues/8800
[#8800]: https://github.com/googleapis/google-cloud-cpp/issues/8800
</details>

<details>
<summary>2023-05-01: remove `bigtable::RowReader` constructors</summary>
<br>

On 2023-05-01 (or shortly after) we will remove `bigtable::RowReader`
constructors which accept `DataClient` as an argument.

Application developers that read rows by directly constructing a `RowReader`
object should instead construct a `Table` object and call `Table::ReadRows(...)`
on it.

For status on this, see https://github.com/googleapis/google-cloud-cpp/issues/8854
For status on this, see [#8854].

[#8854]: https://github.com/googleapis/google-cloud-cpp/issues/8854
</details>

<details>
<summary>2023-06-01: remove the Cloud Debugger Library</summary>
<br>

Sometime after 2023-05-31 the Cloud Debugger service (aka Stackdriver Debugger
API) will be [shutdown][cloud-debugger-deprecated]. Once the service is shutdown
the corresponding [library][cloud-debugger-library] cannot be of any use, and we
plan to remove it without changing the major version number.

[cloud-debugger-library]: https://github.com/googleapis/google-cloud-cpp/blob/main/google/cloud/debugger/README.md
[cloud-debugger-deprecated]: https://cloud.google.com/debugger/docs/deprecations
</details>

<details>
<summary>2023-06-01: remove `spanner::MakeTestRow()`</summary>
<br>

* On 2023-06-01 (or shortly after) we will remove `spanner::MakeTestRow()`,
which has been replaced by `spanner_mocks::MakeRow()`. Starting with the
v1.41.0 release, and depending on your compiler settings, using
`spanner::MakeTestRow()` may elicit a deprecation warning. See
[#9086](https://github.com/googleapis/google-cloud-cpp/issues/9086) for more
details.
On 2023-06-01 (or shortly after) we will remove `spanner::MakeTestRow()`, which
has been replaced by `spanner_mocks::MakeRow()`. Starting with the v1.41.0
release, and depending on your compiler settings, using `spanner::MakeTestRow()`
may elicit a deprecation warning. See [#9086] for more details.

[#9086]: https://github.com/googleapis/google-cloud-cpp/issues/9086
</details>

## v2.1.0 - TBD
Expand Down
7 changes: 5 additions & 2 deletions google/cloud/debugger/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,11 @@ This directory contains an idiomatic C++ client library for the [Stackdriver
Debugger API][cloud-service-docs], a service to examine the call stack and
variables of a running application without stopping or slowing it down.

While this library is **GA**, please note that the Google Cloud C++ client libraries do **not** follow
[Semantic Versioning](https://semver.org/).
:warning: The [Stackdriver Debugger API][cloud-service-docs] has been
[deprecated]. The library will continue to be supported until the service is
shutdown, at which time we will remove the library.

[deprecated]: https://cloud.google.com/debugger/docs/deprecations

## Supported Platforms

Expand Down