Skip to content

Commit 035cde3

Browse files
devbwwdevbww
authored
doc: regenerate new environment-variables.dox files (#11387)
See #11381 for the new `environment-variables.dox` files, but now restore the blank line from the scaffolding I erroneously suggested we should remove. The regeneration will also: - add the `google::cloud::EndpointOption` reference to the "<service>-env-endpoint" section, and - correct the name of the "<service>-env-logging" section. And while we're there, use the `mdformat`-preferred syntax for top-level unordered lists in the quickstart README. There is no point in generating something that `mdformat` will overwrite.
1 parent 5dceee5 commit 035cde3

101 files changed

Lines changed: 399 additions & 306 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎generator/internal/scaffold_generator.cc‎

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -665,6 +665,7 @@ the library. There are also functions to configure this behavior in code. The
665665
environment variables are convenient when troubleshooting problems.
666666
667667
@section $library$-env-endpoint Endpoint Overrides
668+
668669
<!-- inject-endpoint-env-vars-start -->
669670
<!-- inject-endpoint-env-vars-end -->
670671
@@ -734,20 +735,20 @@ client library in your own project. These instructions assume that you have
734735
some experience as a C++ developer and that you have a working C++ toolchain
735736
(compiler, linker, etc.) installed on your platform.
736737
737-
* Packaging maintainers or developers who prefer to install the library in a
738+
- Packaging maintainers or developers who prefer to install the library in a
738739
fixed directory (such as `/usr/local` or `/opt`) should consult the
739740
[packaging guide](/doc/packaging.md).
740741
- Developers who prefer using a package manager such as
741742
[vcpkg](https://vcpkg.io), or [Conda](https://conda.io), should follow the
742743
instructions for their package manager.
743-
* Developers wanting to use the libraries as part of a larger CMake or Bazel
744+
- Developers wanting to use the libraries as part of a larger CMake or Bazel
744745
project should consult the current document. Note that there are similar
745746
documents for each library in their corresponding directories.
746-
* Developers wanting to compile the library just to run some examples or
747+
- Developers wanting to compile the library just to run some examples or
747748
tests should consult the
748749
[building and installing](/README.md#building-and-installing) section of the
749750
top-level README file.
750-
* Contributors and developers to `google-cloud-cpp` should consult the guide to
751+
- Contributors and developers to `google-cloud-cpp` should consult the guide to
751752
[set up a development workstation][howto-setup-dev-workstation].
752753
753754
[howto-setup-dev-workstation]: /doc/contributor/howto-guide-setup-development-workstation.md

‎google/cloud/accessapproval/doc/environment-variables.dox‎

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,12 +3,11 @@
33
@page accessapproval-env Environment Variables
44

55
A number of environment variables can be used to configure the behavior of
6-
the library. There are also functions to configure this behavior in code. The
6+
the library. There are also functions to configure this behavior in code. The
77
environment variables are convenient when troubleshooting problems.
88

99
@section accessapproval-env-endpoint Endpoint Overrides
1010

11-
1211
<!-- inject-endpoint-env-vars-start -->
1312

1413
- `GOOGLE_CLOUD_CPP_ACCESS_APPROVAL_ENDPOINT=...` overrides the
@@ -17,7 +16,9 @@ environment variables are convenient when troubleshooting problems.
1716

1817
<!-- inject-endpoint-env-vars-end -->
1918

20-
@section accessapproval-logging Logging
19+
@see google::cloud::EndpointOption
20+
21+
@section accessapproval-env-logging Logging
2122

2223
`GOOGLE_CLOUD_CPP_ENABLE_TRACING=rpc`: turns on tracing for most gRPC
2324
calls. The library injects an additional Stub decorator that prints each gRPC

‎google/cloud/accesscontextmanager/doc/environment-variables.dox‎

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,12 +3,11 @@
33
@page accesscontextmanager-env Environment Variables
44

55
A number of environment variables can be used to configure the behavior of
6-
the library. There are also functions to configure this behavior in code. The
6+
the library. There are also functions to configure this behavior in code. The
77
environment variables are convenient when troubleshooting problems.
88

99
@section accesscontextmanager-env-endpoint Endpoint Overrides
1010

11-
1211
<!-- inject-endpoint-env-vars-start -->
1312

1413
- `GOOGLE_CLOUD_CPP_ACCESS_CONTEXT_MANAGER_ENDPOINT=...` overrides the
@@ -17,7 +16,9 @@ environment variables are convenient when troubleshooting problems.
1716

1817
<!-- inject-endpoint-env-vars-end -->
1918

20-
@section accesscontextmanager-logging Logging
19+
@see google::cloud::EndpointOption
20+
21+
@section accesscontextmanager-env-logging Logging
2122

2223
`GOOGLE_CLOUD_CPP_ENABLE_TRACING=rpc`: turns on tracing for most gRPC
2324
calls. The library injects an additional Stub decorator that prints each gRPC

‎google/cloud/advisorynotifications/doc/environment-variables.dox‎

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,12 +3,11 @@
33
@page advisorynotifications-env Environment Variables
44

55
A number of environment variables can be used to configure the behavior of
6-
the library. There are also functions to configure this behavior in code. The
6+
the library. There are also functions to configure this behavior in code. The
77
environment variables are convenient when troubleshooting problems.
88

99
@section advisorynotifications-env-endpoint Endpoint Overrides
1010

11-
1211
<!-- inject-endpoint-env-vars-start -->
1312

1413
- `GOOGLE_CLOUD_CPP_ADVISORY_NOTIFICATIONS_SERVICE_ENDPOINT=...` overrides the
@@ -17,7 +16,9 @@ environment variables are convenient when troubleshooting problems.
1716

1817
<!-- inject-endpoint-env-vars-end -->
1918

20-
@section advisorynotifications-logging Logging
19+
@see google::cloud::EndpointOption
20+
21+
@section advisorynotifications-env-logging Logging
2122

2223
`GOOGLE_CLOUD_CPP_ENABLE_TRACING=rpc`: turns on tracing for most gRPC
2324
calls. The library injects an additional Stub decorator that prints each gRPC

‎google/cloud/alloydb/doc/environment-variables.dox‎

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,12 +3,11 @@
33
@page alloydb-env Environment Variables
44

55
A number of environment variables can be used to configure the behavior of
6-
the library. There are also functions to configure this behavior in code. The
6+
the library. There are also functions to configure this behavior in code. The
77
environment variables are convenient when troubleshooting problems.
88

99
@section alloydb-env-endpoint Endpoint Overrides
1010

11-
1211
<!-- inject-endpoint-env-vars-start -->
1312

1413
- `GOOGLE_CLOUD_CPP_ALLOY_DB_ADMIN_ENDPOINT=...` overrides the
@@ -17,7 +16,9 @@ environment variables are convenient when troubleshooting problems.
1716

1817
<!-- inject-endpoint-env-vars-end -->
1918

20-
@section alloydb-logging Logging
19+
@see google::cloud::EndpointOption
20+
21+
@section alloydb-env-logging Logging
2122

2223
`GOOGLE_CLOUD_CPP_ENABLE_TRACING=rpc`: turns on tracing for most gRPC
2324
calls. The library injects an additional Stub decorator that prints each gRPC

‎google/cloud/apigateway/doc/environment-variables.dox‎

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,12 +3,11 @@
33
@page apigateway-env Environment Variables
44

55
A number of environment variables can be used to configure the behavior of
6-
the library. There are also functions to configure this behavior in code. The
6+
the library. There are also functions to configure this behavior in code. The
77
environment variables are convenient when troubleshooting problems.
88

99
@section apigateway-env-endpoint Endpoint Overrides
1010

11-
1211
<!-- inject-endpoint-env-vars-start -->
1312

1413
- `GOOGLE_CLOUD_CPP_API_GATEWAY_SERVICE_ENDPOINT=...` overrides the
@@ -17,7 +16,9 @@ environment variables are convenient when troubleshooting problems.
1716

1817
<!-- inject-endpoint-env-vars-end -->
1918

20-
@section apigateway-logging Logging
19+
@see google::cloud::EndpointOption
20+
21+
@section apigateway-env-logging Logging
2122

2223
`GOOGLE_CLOUD_CPP_ENABLE_TRACING=rpc`: turns on tracing for most gRPC
2324
calls. The library injects an additional Stub decorator that prints each gRPC

‎google/cloud/apigeeconnect/doc/environment-variables.dox‎

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,12 +3,11 @@
33
@page apigeeconnect-env Environment Variables
44

55
A number of environment variables can be used to configure the behavior of
6-
the library. There are also functions to configure this behavior in code. The
6+
the library. There are also functions to configure this behavior in code. The
77
environment variables are convenient when troubleshooting problems.
88

99
@section apigeeconnect-env-endpoint Endpoint Overrides
1010

11-
1211
<!-- inject-endpoint-env-vars-start -->
1312

1413
- `GOOGLE_CLOUD_CPP_APIGEE_CONNECTION_SERVICE_ENDPOINT=...` overrides the
@@ -17,7 +16,9 @@ environment variables are convenient when troubleshooting problems.
1716

1817
<!-- inject-endpoint-env-vars-end -->
1918

20-
@section apigeeconnect-logging Logging
19+
@see google::cloud::EndpointOption
20+
21+
@section apigeeconnect-env-logging Logging
2122

2223
`GOOGLE_CLOUD_CPP_ENABLE_TRACING=rpc`: turns on tracing for most gRPC
2324
calls. The library injects an additional Stub decorator that prints each gRPC

‎google/cloud/apikeys/doc/environment-variables.dox‎

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,12 +3,11 @@
33
@page apikeys-env Environment Variables
44

55
A number of environment variables can be used to configure the behavior of
6-
the library. There are also functions to configure this behavior in code. The
6+
the library. There are also functions to configure this behavior in code. The
77
environment variables are convenient when troubleshooting problems.
88

99
@section apikeys-env-endpoint Endpoint Overrides
1010

11-
1211
<!-- inject-endpoint-env-vars-start -->
1312

1413
- `GOOGLE_CLOUD_CPP_API_KEYS_ENDPOINT=...` overrides the
@@ -17,7 +16,9 @@ environment variables are convenient when troubleshooting problems.
1716

1817
<!-- inject-endpoint-env-vars-end -->
1918

20-
@section apikeys-logging Logging
19+
@see google::cloud::EndpointOption
20+
21+
@section apikeys-env-logging Logging
2122

2223
`GOOGLE_CLOUD_CPP_ENABLE_TRACING=rpc`: turns on tracing for most gRPC
2324
calls. The library injects an additional Stub decorator that prints each gRPC

‎google/cloud/appengine/doc/environment-variables.dox‎

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,12 +3,11 @@
33
@page appengine-env Environment Variables
44

55
A number of environment variables can be used to configure the behavior of
6-
the library. There are also functions to configure this behavior in code. The
6+
the library. There are also functions to configure this behavior in code. The
77
environment variables are convenient when troubleshooting problems.
88

99
@section appengine-env-endpoint Endpoint Overrides
1010

11-
1211
<!-- inject-endpoint-env-vars-start -->
1312

1413
- `GOOGLE_CLOUD_CPP_APPLICATIONS_ENDPOINT=...` overrides the
@@ -45,7 +44,9 @@ environment variables are convenient when troubleshooting problems.
4544

4645
<!-- inject-endpoint-env-vars-end -->
4746

48-
@section appengine-logging Logging
47+
@see google::cloud::EndpointOption
48+
49+
@section appengine-env-logging Logging
4950

5051
`GOOGLE_CLOUD_CPP_ENABLE_TRACING=rpc`: turns on tracing for most gRPC
5152
calls. The library injects an additional Stub decorator that prints each gRPC

‎google/cloud/artifactregistry/doc/environment-variables.dox‎

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,12 +3,11 @@
33
@page artifactregistry-env Environment Variables
44

55
A number of environment variables can be used to configure the behavior of
6-
the library. There are also functions to configure this behavior in code. The
6+
the library. There are also functions to configure this behavior in code. The
77
environment variables are convenient when troubleshooting problems.
88

99
@section artifactregistry-env-endpoint Endpoint Overrides
1010

11-
1211
<!-- inject-endpoint-env-vars-start -->
1312

1413
- `GOOGLE_CLOUD_CPP_ARTIFACT_REGISTRY_ENDPOINT=...` overrides the
@@ -17,7 +16,9 @@ environment variables are convenient when troubleshooting problems.
1716

1817
<!-- inject-endpoint-env-vars-end -->
1918

20-
@section artifactregistry-logging Logging
19+
@see google::cloud::EndpointOption
20+
21+
@section artifactregistry-env-logging Logging
2122

2223
`GOOGLE_CLOUD_CPP_ENABLE_TRACING=rpc`: turns on tracing for most gRPC
2324
calls. The library injects an additional Stub decorator that prints each gRPC

0 commit comments

Comments
 (0)