Skip to content

Commit 8ae2222

Browse files
coryancoryan
authored
doc: better guidance around package managers (googleapis#9818)
1 parent 0b67afc commit 8ae2222

File tree

186 files changed

+704
-292
lines changed

Some content is hidden

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

186 files changed

+704
-292
lines changed

‎README.md‎

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -300,13 +300,17 @@ run the examples included with the libraries.
300300
- Packaging maintainers or developers who prefer to install the library in a
301301
fixed directory (such as `/usr/local` or `/opt`) should consult the
302302
[packaging guide](/doc/packaging.md).
303+
- Developers that prefer using a package manager such as
304+
[vcpkg](https://vcpkg.io), [Conda](https://conda.io),
305+
or [Conan](https://conan.io) should follow the instructions for their package
306+
manager.
303307
- Developers wanting to use the libraries as part of a larger CMake or Bazel
304308
project should consult the [quickstart guides](#quickstart) for the library
305309
or libraries they want to use.
306-
- Developers wanting to compile the library just to run some of the examples or
310+
- Developers wanting to compile the library just to run some examples or
307311
tests should read the current document.
308312
- Contributors and developers to `google-cloud-cpp` should consult the guide to
309-
[setup a development workstation][howto-setup-dev-workstation].
313+
[set up a development workstation][howto-setup-dev-workstation].
310314

311315
### Building with Bazel
312316

‎ci/generate-markdown/generate-packaging.sh‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,10 @@ directory.
3333
- Packaging maintainers or developers who prefer to install the library in a
3434
fixed directory (such as `/usr/local` or `/opt`) should consult the current
3535
document.
36+
- Developers that prefer using a package manager such as
37+
[vcpkg](https://vcpkg.io), [Conda](https://conda.io),
38+
or [Conan](https://conan.io) should follow the instructions for their package
39+
manager.
3640
- Developers wanting to use the libraries as part of a larger CMake or Bazel
3741
project should consult the [quickstart guides](/README.md#quickstart) for the
3842
library or libraries they want to use.

‎doc/contributor/howto-guide-setup-cmake-environment.md‎

Lines changed: 9 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,21 @@
1-
# How-to Guide: Setup for CMake-based builds
1+
# How-to Guide: Set Up for CMake-based builds
22

3-
This document describes how to setup your workstation to build the Google Cloud
3+
This document describes how to set up your workstation to build the Google Cloud
44
C++ client libraries using CMake. The intended audience is developers of the
55
client libraries that want to verify their changes will work with CMake and/or
66
prefer to use CMake for whatever reason.
77

88
- Packaging maintainers or developers who prefer to install the library in a
99
fixed directory (such as `/usr/local` or `/opt`) should consult the
1010
[packaging guide](/doc/packaging.md).
11+
- Developers that prefer using a package manager such as
12+
[vcpkg](https://vcpkg.io), [Conda](https://conda.io),
13+
or [Conan](https://conan.io) should follow the instructions for their package
14+
manager.
1115
- Developers wanting to use the libraries as part of a larger CMake or Bazel
12-
project should consult the [quickstart guides](/README.md#quickstart) for the library
13-
or libraries they want to use.
14-
- Developers wanting to compile the library just to run some of the examples or
16+
project should consult the [quickstart guides](/README.md#quickstart) for the
17+
library or libraries they want to use.
18+
- Developers wanting to compile the library just to run some examples or
1519
tests should read the [build and install](/README.md#building-and-installing)
1620
section from the top-level README.
1721
- Contributors and developers to `google-cloud-cpp` wanting to work with CMake

‎doc/contributor/howto-guide-setup-development-workstation.md‎

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,26 @@
1-
# How-to Guide: Setup your Development Environment
1+
# How-to Guide: Set Up your Development Environment
22

33
This guide is intended for contributors to the `google-cloud-cpp` libraries.
4-
This will walk you through the steps necessary to setup your development
4+
This will walk you through the steps necessary to set up your development
55
workstation to compile the code, run the unit and integration tests, and send
66
contributions to the project.
77

88
- Packaging maintainers or developers who prefer to install the library in a
99
fixed directory (such as `/usr/local` or `/opt`) should consult the
1010
[packaging guide](/doc/packaging.md).
11+
- Developers that prefer using a package manager such as
12+
[vcpkg](https://vcpkg.io), [Conda](https://conda.io),
13+
or [Conan](https://conan.io) should follow the instructions for their package
14+
manager.
1115
- Developers wanting to use the libraries as part of a larger CMake or Bazel
1216
project should consult the [quickstart guides](/README.md#quickstart) for the
1317
library or libraries they want to use.
14-
- Developers wanting to compile the library just to run some of the examples or
18+
- Developers wanting to compile the library just to run some examples or
1519
tests should consult the
1620
[building and installing](/README.md#building-and-installing) section of the
1721
top-level README file.
1822
- Contributors and developers **to** `google-cloud-cpp`, this is the right
19-
document
23+
document.
2024

2125
## Table of Contents
2226

‎doc/packaging.md‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,10 @@ directory.
1111
- Packaging maintainers or developers who prefer to install the library in a
1212
fixed directory (such as `/usr/local` or `/opt`) should consult the current
1313
document.
14+
- Developers that prefer using a package manager such as
15+
[vcpkg](https://vcpkg.io), [Conda](https://conda.io),
16+
or [Conan](https://conan.io) should follow the instructions for their package
17+
manager.
1418
- Developers wanting to use the libraries as part of a larger CMake or Bazel
1519
project should consult the [quickstart guides](/README.md#quickstart) for the
1620
library or libraries they want to use.

‎generator/internal/scaffold_generator.cc‎

Lines changed: 12 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -205,13 +205,17 @@ this library.
205205
* Packaging maintainers or developers who prefer to install the library in a
206206
fixed directory (such as `/usr/local` or `/opt`) should consult the
207207
[packaging guide](/doc/packaging.md).
208+
- Developers that prefer using a package manager such as
209+
[vcpkg](https://vcpkg.io), [Conda](https://conda.io),
210+
or [Conan](https://conan.io) should follow the instructions for their package
211+
manager.
208212
* Developers wanting to use the libraries as part of a larger CMake or Bazel
209213
project should consult the [quickstart guides](#quickstart) for the library
210214
or libraries they want to use.
211-
* Developers wanting to compile the library just to run some of the examples or
215+
* Developers wanting to compile the library just to run some examples or
212216
tests should read the current document.
213217
* Contributors and developers to `google-cloud-cpp` should consult the guide to
214-
[setup a development workstation][howto-setup-dev-workstation].
218+
[set up a development workstation][howto-setup-dev-workstation].
215219
216220
[howto-setup-dev-workstation]: /doc/contributor/howto-guide-setup-development-workstation.md
217221
@@ -606,15 +610,19 @@ some experience as a C++ developer and that you have a working C++ toolchain
606610
* Packaging maintainers or developers who prefer to install the library in a
607611
fixed directory (such as `/usr/local` or `/opt`) should consult the
608612
[packaging guide](/doc/packaging.md).
613+
- Developers that prefer using a package manager such as
614+
[vcpkg](https://vcpkg.io), [Conda](https://conda.io),
615+
or [Conan](https://conan.io) should follow the instructions for their package
616+
manager.
609617
* Developers wanting to use the libraries as part of a larger CMake or Bazel
610618
project should consult the current document. Note that there are similar
611619
documents for each library in their corresponding directories.
612-
* Developers wanting to compile the library just to run some of the examples or
620+
* Developers wanting to compile the library just to run some examples or
613621
tests should consult the
614622
[building and installing](/README.md#building-and-installing) section of the
615623
top-level README file.
616624
* Contributors and developers to `google-cloud-cpp` should consult the guide to
617-
[setup a development workstation][howto-setup-dev-workstation].
625+
[set up a development workstation][howto-setup-dev-workstation].
618626
619627
[howto-setup-dev-workstation]: /doc/contributor/howto-guide-setup-development-workstation.md
620628

‎google/cloud/accessapproval/README.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -67,7 +67,7 @@ int main(int argc, char* argv[]) try {
6767
- Developers wanting to use the libraries as part of a larger CMake or Bazel
6868
project should consult the [quickstart guides](#quickstart) for the library
6969
or libraries they want to use.
70-
- Developers wanting to compile the library just to run some of the examples or
70+
- Developers wanting to compile the library just to run some examples or
7171
tests should read the current document.
7272
- Contributors and developers to `google-cloud-cpp` should consult the guide to
7373
[setup a development workstation][howto-setup-dev-workstation].

‎google/cloud/accessapproval/quickstart/README.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ some experience as a C++ developer and that you have a working C++ toolchain
1111
- Developers wanting to use the libraries as part of a larger CMake or Bazel
1212
project should consult the current document. Note that there are similar
1313
documents for each library in their corresponding directories.
14-
- Developers wanting to compile the library just to run some of the examples or
14+
- Developers wanting to compile the library just to run some examples or
1515
tests should consult the
1616
[building and installing](/README.md#building-and-installing) section of the
1717
top-level README file.

‎google/cloud/accesscontextmanager/README.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -67,7 +67,7 @@ int main(int argc, char* argv[]) try {
6767
- Developers wanting to use the libraries as part of a larger CMake or Bazel
6868
project should consult the [quickstart guides](#quickstart) for the library
6969
or libraries they want to use.
70-
- Developers wanting to compile the library just to run some of the examples or
70+
- Developers wanting to compile the library just to run some examples or
7171
tests should read the current document.
7272
- Contributors and developers to `google-cloud-cpp` should consult the guide to
7373
[setup a development workstation][howto-setup-dev-workstation].

‎google/cloud/accesscontextmanager/quickstart/README.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ some experience as a C++ developer and that you have a working C++ toolchain
1111
- Developers wanting to use the libraries as part of a larger CMake or Bazel
1212
project should consult the current document. Note that there are similar
1313
documents for each library in their corresponding directories.
14-
- Developers wanting to compile the library just to run some of the examples or
14+
- Developers wanting to compile the library just to run some examples or
1515
tests should consult the
1616
[building and installing](/README.md#building-and-installing) section of the
1717
top-level README file.

0 commit comments

Comments
 (0)