Skip to content

Commit 9aa7388

Browse files
authored
Another pass fixing nits. (#2630)
1 parent 5a9a9ab commit 9aa7388

1 file changed

Lines changed: 17 additions & 39 deletions

File tree

google/cloud/storage/doc/storage-main.dox

Lines changed: 17 additions & 39 deletions
Original file line numberDiff line numberDiff line change
@@ -49,44 +49,22 @@ The source code for the Cloud Storage C++ Client Library can be found on
4949
git clone https://github.com/googleapis/google-cloud-cpp.git
5050
```
5151

52-
The top-level README file in this repository includes detailed instructions on
53-
how to compile the library. The examples used in this guide should be
54-
automatically compiled when you follow said instructions.
52+
The top-level [README][github-readme] file in this repository includes detailed
53+
instructions on how to compile the library. The examples used in this guide
54+
should be automatically compiled when you follow said instructions.
5555

5656
### Configuring authentication for the C++ Client Library
5757

5858
This library uses the `GOOGLE_APPLICATION_CREDENTIALS` environment variable to
5959
find the credentials file. For example:
6060

61-
#### Linux/macOS with Bash/zsh/ksh/etc.
62-
63-
@code
64-
export GOOGLE_APPLICATION_CREDENTIALS=[PATH]
65-
@endcode
66-
67-
#### Linux/macOS with sh
68-
69-
@code
70-
GOOGLE_APPLICATION_CREDENTIALS=[PATH]; export GOOGLE_APPLICATION_CREDENTIALS
71-
@endcode
72-
73-
#### Linux/macOS with csh/tcsh
74-
75-
@code
76-
setenv GOOGLE_APPLICATION_CREDENTIALS [PATH]
77-
@endcode
78-
79-
#### Windows Powershell
80-
81-
@code
82-
$env:GOOGLE_APPLICATION_CREDENTIALS=[PATH]
83-
@endcode
84-
85-
#### Windows with Command Prompt
86-
87-
@code
88-
set GOOGLE_APPLICATION_CREDENTIALS=[PATH]
89-
@endcode
61+
| Shell | Command |
62+
| :----------------- | ---------------------------------------------- |
63+
| Bash/zsh/ksh/etc. | `export GOOGLE_APPLICATION_CREDENTIALS=[PATH]` |
64+
| sh | `GOOGLE_APPLICATION_CREDENTIALS=[PATH];` `export GOOGLE_APPLICATION_CREDENTIALS` |
65+
| csh/tsch | `setenv GOOGLE_APPLICATION_CREDENTIALS [PATH]` |
66+
| Windows Powershell | `$env:GOOGLE_APPLICATION_CREDENTIALS=[PATH]` |
67+
| Windows cmd.exe | `set GOOGLE_APPLICATION_CREDENTIALS=[PATH]` |
9068

9169
This is the recommended way to configure the
9270
authentication preferences, though if the environment variable is not set, the
@@ -143,8 +121,8 @@ and install the library, for example:
143121
# Change the version and SHA256 hash as needed.
144122
http_archive(
145123
name = "com_github_googleapis_google_cloud_cpp",
146-
url = "http://github.com/googleapis/google-cloud-cpp/archive/v0.5.0.tar.gz",
147-
sha256 = "886bcba3616d5f362838a2d86ae0198dd3670a84a84c82291cda6c30e14779fc"
124+
url = "http://github.com/googleapis/google-cloud-cpp/archive/v0.8.1.tar.gz",
125+
sha256 = "f5600fdf3efd28e3142a60c20574e349511104fc6f658faf7974f6ae2def245a"
148126
)
149127
@endcode
150128

@@ -286,15 +264,15 @@ to follow a more conservative approach:
286264

287265
@snippet storage_object_samples.cc insert object strict idempotency
288266

289-
@see [`LimitedTimeRetryPolicy`](@ref google::cloud::storage::v1::LimitedTimeRetryPolicy]
290-
and [`LimitedErrorCountRetryPolicy`](@ref google::cloud::storage::v1::LimitedErrorCountRetryPolicy)
267+
@see [LimitedTimeRetryPolicy](@ref google::cloud::storage::v1::LimitedTimeRetryPolicy)
268+
and [LimitedErrorCountRetryPolicy](@ref google::cloud::storage::v1::LimitedErrorCountRetryPolicy)
291269
for alternative retry policies.
292270

293-
@see [`ExponentialBackoffPolicy`](@ref google::cloud::storage::v1::ExponentialBackoffPolicy)
271+
@see [ExponentialBackoffPolicy](@ref google::cloud::storage::v1::ExponentialBackoffPolicy)
294272
to configure different parameters for the exponential backoff policy.
295273

296-
@see [`AlwaysRetryIdempotencyPolicy`](@ref google::cloud::storage::v1::AlwaysRetryIdempotencyPolicy)
297-
and [`StrictIdempotencyPolicy`](@ref google::cloud::storage::v1::StrictIdempotencyPolicy)
274+
@see [AlwaysRetryIdempotencyPolicy](@ref google::cloud::storage::v1::AlwaysRetryIdempotencyPolicy)
275+
and [StrictIdempotencyPolicy](@ref google::cloud::storage::v1::StrictIdempotencyPolicy)
298276
for alternative idempotency policies.
299277

300278
### Next Steps

0 commit comments

Comments
 (0)