Skip to content

Commit 4ee53d8

Browse files
committed
Post-donation doc updates
patch by Bret McGuire; reviewed by Bret McGuire and Yifan Cai reference: #581
1 parent 85ddfa9 commit 4ee53d8

File tree

5 files changed

+38
-101
lines changed

5 files changed

+38
-101
lines changed

CONTRIBUTING.md

Lines changed: 10 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -4,34 +4,28 @@ This is a guide to help you get started contributing to the DataStax C/C++ Drive
44

55
## Forking and Branching
66

7-
Fork the driver on [GitHub](https://github.com/datastax/cpp-driver/) and clone
7+
Fork the driver on [GitHub](https://github.com/apache/cassandra-cpp-driver) and clone
88
your fork locally.
99

1010
```bash
11-
$ git clone https://github.com/username/cpp-driver.git
12-
$ cd cpp-driver
13-
$ git remote add upstream https://github.com/datastax/cpp-driver.git
11+
$ git clone https://github.com/username/cassandra-cpp-driver.git
12+
$ cd cassandra-cpp-driver
13+
$ git remote add upstream https://github.com/apache/cassandra-cpp-driver
1414
```
1515

16-
Bug fixes should be applied directly to the stable version branch and
17-
features should go to the unstable branch (this will likely be 'master' going
18-
forward).
19-
2016
Features that require breaking API or ABI changes should be reserved for major
2117
releases and will probably not be considered for minor or patch releases.
2218
For features and big changes consider using a feature branch.
2319

2420
```bash
25-
$ git checkout -b awesome-new-feature -t origin/1.0
21+
$ git checkout -b awesome-new-feature
2622
```
2723

28-
(where '1.0' is the latest stable branch)
29-
3024
Make sure to `git rebase` to keep your branch up-to-date.
3125

3226
```bash
3327
$ git fetch upstream
34-
$ git rebase upstream/1.0
28+
$ git rebase upstream
3529
```
3630

3731
To avoid duplication of work it's important to check [JIRA] to see if a bug
@@ -122,15 +116,15 @@ your branch and create a pull request.
122116
$ git push origin awesome-new-feature
123117
```
124118

125-
Go to your fork (http://github.com/username/cpp-driver), select the branch with
119+
Go to your fork (https://github.com/username/cassandra-cpp-driver), select the branch with
126120
your changes and click 'Pull Request'. Fill out the pull request and submit.
127121

128122
Your changes should usually be reviewed within a few days, otherwise we'll try
129123
to give you a timeline. If your pull request requires fixes or changes please
130-
submit them in a new commit. These commits will be squashed before inclusion
131-
into the stable or unstable branches.
124+
submit them in a new commit. These commits will be squashed before your pull request
125+
is merged.
132126

133-
[JIRA]: https://datastax-oss.atlassian.net/browse/CPP/?selectedTab=com.atlassian.jira.jira-projects-plugin:summary-panel
127+
[JIRA]: https://issues.apache.org/jira/issues/?jql=project%20%3D%20CASSCPP%20ORDER%20BY%20key%20DESC
134128
[Google C++ Style Guide]: https://google.github.io/styleguide/cppguide.html
135129
[early exits]: http://llvm.org/docs/CodingStandards.html#use-early-exits-and-continue-to-simplify-code
136130
[testing guide]: https://docs.datastax.com/en/developer/cpp-driver/latest/topics/testing

README.md

Lines changed: 13 additions & 39 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ A modern, feature-rich and highly tunable C/C++ client library for
55
Cassandra Query Language v3. This driver can also be used with other DataStax
66
products:
77

8-
* [DataStax Enterprise]
8+
* DataStax Enterprise (DSE)
99
* [DataStax Astra]
1010

1111
## Getting the Driver
@@ -15,7 +15,6 @@ the driver (for multiple operating systems and multiple architectures) can be
1515
obtained from our [Artifactory server]. Binaries are available for the following
1616
operating systems:
1717

18-
* CentOS 7
1918
* Rocky Linux 8.8
2019
* Rocky Linux 9.2
2120
* Ubuntu 20.04
@@ -29,27 +28,8 @@ The driver depends on the following libraries:
2928
* zlib
3029

3130
The version of OpenSSL and zlib provided with each Linux distribution above can be used
32-
to build the driver. A version of libuv > 1.x is provided for CentOS 7 and Rocky
33-
Linux; this can be found under the `dependencies` directory for each platform.
34-
Packages for all three dependencies are provided for Windows distributions.
35-
36-
## Upgrading for DSE
37-
38-
Starting with Apache Cassandra C/C++ Driver v2.15.0, DataStax
39-
Enterprise (DSE) support is now available; using the DSE driver exclusively is no
40-
longer required for DSE customers.
41-
42-
### For DSE driver users
43-
44-
Linking changes will be required when migrating to this driver. Replace `-ldse` with `-lcassandra`.
45-
46-
### For Cassandra driver users
47-
48-
No changes will be required when upgrading to this driver. There will be new
49-
driver dependencies when using any of the binary versions obtained from our
50-
[Artifactory server] as [Kerberos] is utilized in the [DSE features] of this
51-
driver. See the [installation] section for more information on obtaining the
52-
dependencies for a specific platform.
31+
to build the driver. A version of libuv > 1.x is provided for Rocky Linux under the
32+
`dependencies` directory. Packages for all three dependencies are provided for Windows distributions.
5333

5434
## Features
5535

@@ -101,7 +81,6 @@ Both 32-bit (x86) and 64-bit (x64) architectures are supported
10181

10282
We build and test the driver on the following platforms:
10383

104-
* CentOS 7 w/ gcc 4.8.5
10584
* Rocky Linux 8.8 w/ gcc 8.5.0
10685
* Rocky Linux 9.2 w/ gcc 11.3.1
10786
* Ubuntu 20.04 w/ gcc 9.4.0
@@ -122,8 +101,8 @@ __Disclaimer__: DataStax products do not support big-endian systems.
122101

123102
## Getting Help
124103

125-
* JIRA: [jira]
126-
* Mailing List: [mailing list]
104+
* Quality bug reports are welcome at the [CASSCPP project] of the ASF JIRA
105+
* You can talk about the driver, ask questions and get help in the #cassandra-drivers channel on [ASF Slack]
127106

128107
## Examples
129108

@@ -206,22 +185,18 @@ int main(int argc, char* argv[]) {
206185
}
207186
```
208187
209-
## Links
210-
188+
[API]: http://docs.datastax.com/en/developer/cpp-driver/latest/api
189+
[ASF Slack]: https://the-asf.slack.com/
211190
[Apache Cassandra®]: http://cassandra.apache.org
212-
[DataStax Enterprise]: http://www.datastax.com/products/datastax-enterprise
213-
[Examples]: examples/
214191
[Artifactory server]: https://datastax.jfrog.io/artifactory/cpp-php-drivers/cpp-driver/builds
215-
[GitHub]: https://github.com/datastax/cpp-driver
216-
[cpp-driver-compatability-matrix]: https://docs.datastax.com/en/driver-matrix/docs/cpp-drivers.html
217-
[Home]: http://docs.datastax.com/en/developer/cpp-driver/latest
218-
[API]: http://docs.datastax.com/en/developer/cpp-driver/latest/api
219-
[Getting Started]: http://docs.datastax.com/en/developer/cpp-driver/latest/topics
220192
[Building]: http://docs.datastax.com/en/developer/cpp-driver/latest/topics/building
221-
[jira]: https://datastax-oss.atlassian.net/browse/CPP
222-
[mailing list]: https://groups.google.com/a/lists.datastax.com/forum/#!forum/cpp-driver-user
193+
[CASSCPP project]: https://issues.apache.org/jira/issues/?jql=project%20%3D%20CASSCPP%20ORDER%20BY%20key%20DESC
194+
[cpp-driver-compatability-matrix]: https://docs.datastax.com/en/driver-matrix/docs/cpp-drivers.html
223195
[DataStax Astra]: https://astra.datastax.com
224-
[Kerberos]: https://web.mit.edu/kerberos
196+
[Examples]: examples/
197+
[Getting Started]: http://docs.datastax.com/en/developer/cpp-driver/latest/topics
198+
[GitHub]: https://github.com/apache/cassandra-cpp-driver
199+
[Home]: http://docs.datastax.com/en/developer/cpp-driver/latest
225200
226201
[Asynchronous API]: https://docs.datastax.com/en/developer/cpp-driver/latest/topics/#futures
227202
[Simple]: https://docs.datastax.com/en/developer/cpp-driver/latest/topics/#executing-queries
@@ -252,4 +227,3 @@ int main(int argc, char* argv[]) {
252227
[DSE Proxy Authentication]: http://docs.datastax.com/en/developer/cpp-driver/latest/dse_features/authentication/#proxy-authentication
253228
[DSE Proxy Execution]: http://docs.datastax.com/en/developer/cpp-driver/latest/dse_features/authentication/#proxy-execution
254229
[DSE DateRange]: https://github.com/datastax/cpp-driver/blob/master/examples/dse/date_range/date_range.c
255-
[DSE features]: http://docs.datastax.com/en/developer/cpp-driver/latest/dse_features

topics/README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,6 @@ All packages referenced below can be found on our [Artifactory server].
88

99
Packages are available for the following platforms:
1010

11-
* CentOS 7
1211
* Rocky Linux 8.8
1312
* Rocky Linux 9.2
1413
* Ubuntu 20.04
@@ -246,7 +245,8 @@ without incurring extra allocations.
246245
## TODO
247246
248247
Here are some features that are missing from the C/C++ driver, but are included
249-
with other drivers. The schedule for these features can be found on [JIRA].
248+
with other drivers. The schedule for these features can be found on the
249+
[CASSCPP project] of the ASF JIRA.
250250
251251
- Compression
252252
- Schema event registration and notification
@@ -264,4 +264,4 @@ with other drivers. The schedule for these features can be found on [JIRA].
264264
[`CassIterator`]: https://docs.datastax.com/en/developer/cpp-driver/latest/api/struct.CassIterator/
265265
[`CassSession`]: https://docs.datastax.com/en/developer/cpp-driver/latest/api/struct.CassSession/
266266
[post]: http://www.datastax.com/dev/blog/4-simple-rules-when-using-the-datastax-drivers-for-cassandra
267-
[JIRA]: https://datastax-oss.atlassian.net/browse/CPP
267+
[CASSCPP project]: https://issues.apache.org/jira/issues/?jql=project%20%3D%20CASSCPP%20ORDER%20BY%20key%20DESC

topics/building/README.md

Lines changed: 10 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,6 @@ The DataStax C/C++ Driver for Apache Cassandra and DataStax Products will build
44
on most standard Unix-like and Microsoft Windows platforms. Packages are
55
available for the following platforms:
66

7-
* CentOS 7
87
* Rocky Linux 8.8
98
* Rocky Linux 9.2
109
* Ubuntu 20.04
@@ -51,9 +50,9 @@ OpenSSL 3.x by default and the unit and integration tests all pass on these plat
5150

5251
## Linux/Mac OS
5352

54-
The driver is known to build on CentOS/RHEL 6/7/8, Mac OS X 10.10/10.11 (Yosemite
53+
The driver is known to build on Rocky Linux 8/9, Mac OS X 10.10/10.11 (Yosemite
5554
and El Capitan), Mac OS 10.12/10.13 (Sierra and High Sierra), and Ubuntu
56-
14.04/16.04/18.04 LTS.
55+
20.04/22.04 LTS.
5756

5857
__NOTE__: The driver will also build on most standard Unix-like systems using
5958
GCC 4.1.2+ or Clang 3.4+.
@@ -62,7 +61,7 @@ __NOTE__: The driver will also build on most standard Unix-like systems using
6261

6362
#### Initial environment setup
6463

65-
##### CentOS/RHEL (Yum)
64+
##### Rocky/RHEL (Yum)
6665

6766
```bash
6867
yum install automake cmake gcc-c++ git libtool
@@ -89,7 +88,7 @@ brew install autoconf automake cmake libtool
8988

9089
#### Kerberos
9190

92-
##### CentOS/RHEL (Yum)
91+
##### Rocky/RHEL (Yum)
9392

9493
```bash
9594
yum install krb5-devel
@@ -105,14 +104,14 @@ apt-get install libkrb5-dev
105104

106105
libuv v1.x should be used in order to ensure all features of the C/C++ driver
107106
are available. When using a package manager for your operating system make sure
108-
you install v1.x; if available.
107+
you install v1.x.
109108

110-
##### CentOS, Rocky and Ubuntu packages
109+
##### Rocky and Ubuntu packages
111110

112111
Packages are available from our [Artifactory server]. Select the driver version,
113112
build and platform and then look for the `dependencies` directory. Note that the
114-
version of libuv available on Ubuntu can be used when building the driver. As a
115-
result we only provide packages for CentOS and Rocky.
113+
version of libuv available on supported versions of Ubuntu can be used when
114+
building the driver. As a result we only provide packages for Rocky Linux only.
116115

117116
##### Mac OS (Brew)
118117

@@ -139,7 +138,7 @@ popd
139138

140139
#### OpenSSL
141140

142-
##### CentOS (Yum)
141+
##### Rocky (Yum)
143142

144143
```bash
145144
yum install openssl-devel
@@ -180,7 +179,7 @@ popd
180179

181180
#### zlib
182181

183-
##### CentOS (Yum)
182+
##### Rocky (Yum)
184183

185184
```bash
186185
yum install zlib-devel

topics/installation/README.md

Lines changed: 2 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -2,38 +2,8 @@
22

33
## Packages
44

5-
Pre-built packages are available for CentOS 7, Ubuntu 20.04/22.04,
6-
Rocky Linux 8 and 9 and Windows. All packages are available from our
7-
[Artifactory server].
8-
9-
### CentOS
10-
11-
CentOS doesn't have up-to-date versions of libuv so we provide current packages.
12-
These packages can be found in the `dependencies` directory under each driver
13-
version in Artifactory.
14-
15-
First install dependencies:
16-
17-
```bash
18-
yum install openssl krb5 zlib
19-
rpm -Uvh libuv-<version>.rpm
20-
```
21-
22-
Note: Replace `<version>` with the release version of the package.
23-
24-
Then install the runtime library:
25-
26-
```bash
27-
rpm -Uvh cassandra-cpp-driver-<version>.rpm
28-
```
29-
30-
When developing against the driver you'll also want to install the development
31-
package and the debug symbols.
32-
33-
```bash
34-
rpm -Uvh cassandra-cpp-driver-devel-<version>.rpm
35-
rpm -Uvh cassandra-cpp-driver-debuginfo-<version>.rpm
36-
```
5+
Pre-built packages are available for Ubuntu 20.04/22.04, Rocky Linux 8 and 9 and Windows.
6+
All packages are available from our [Artifactory server].
377

388
### Rocky Linux
399

0 commit comments

Comments
 (0)