Skip to content

Commit 99d4587

Browse files
authored
Automate versions used in Reference_Manual.md (#1302)
Automated the version numbers used in the reference manual. The project version will be used. `Reference_Manual.md` is auto generated file now. Do not do manual modifications.
1 parent 9dda2df commit 99d4587

File tree

3 files changed

+3886
-8
lines changed

3 files changed

+3886
-8
lines changed

CMakeLists.txt

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,14 +17,23 @@
1717
cmake_minimum_required(VERSION 3.10)
1818

1919
project(hazelcast-cpp-client
20-
VERSION 5.3
20+
VERSION 5.4.0
2121
DESCRIPTION "Hazelcast C++ Client"
2222
LANGUAGES CXX)
2323

2424
# Set the C++ standard
2525
set(CMAKE_CXX_STANDARD 11)
2626
set(CMAKE_CXX_STANDARD_REQUIRED ON)
2727

28+
# Generate the Reference_Manual.md file using the latest project version.
29+
# If the project version changes, the generated Reference_Manual.md file needs to be
30+
# committed to the repository after generation.
31+
configure_file(Reference_Manual.md.in "${CMAKE_SOURCE_DIR}/Reference_Manual.md" @ONLY)
32+
33+
# Add a custom target to execute the copy command
34+
add_custom_target(copy_reference_manual ALL
35+
DEPENDS "${CMAKE_SOURCE_DIR}/Reference_Manual.md"
36+
)
2837
# Set the default build type for single-config generators if not given
2938
get_property(is_multi_config GLOBAL PROPERTY GENERATOR_IS_MULTI_CONFIG)
3039
if ((NOT is_multi_config) AND (NOT CMAKE_BUILD_TYPE))

Reference_Manual.md

Lines changed: 10 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,6 @@
1+
<!-- THIS FILE IS AUTO GENERATED FILE.
2+
MODIFY Reference_Manual.md.in TO MAKE CHANGES. -->
3+
14
# Hazelcast C++ Client Library
25
<!--ts-->
36
* [Hazelcast C++ Client Library](#hazelcast-c-client-library)
@@ -220,7 +223,7 @@ Please see [example instructions](https://docs.conan.io/en/latest/getting_starte
220223
- You need to put the following lines to your `conanfile.txt`:
221224
```
222225
[requires]
223-
hazelcast-cpp-client/5.2.0
226+
hazelcast-cpp-client/5.4.0
224227
225228
[generators]
226229
cmake
@@ -250,22 +253,22 @@ Follow the instructions for your platform:
250253
* [Windows](#1134-windows-users)
251254

252255
#### 1.1.3.3. Linux and MacOS Users
253-
Here is how you download and extract version 5.2.0 using the **curl** command:
256+
Here is how you download and extract version 5.4.0 using the **curl** command:
254257
```sh
255-
curl -Lo hazelcast-cpp-client-5.2.0.tar.gz https://github.com/hazelcast/hazelcast-cpp-client/archive/v5.2.0.tar.gz
256-
tar xzf hazelcast-cpp-client-5.2.0.tar.gz
258+
curl -Lo hazelcast-cpp-client-5.4.0.tar.gz https://github.com/hazelcast/hazelcast-cpp-client/archive/v5.4.0.tar.gz
259+
tar xzf hazelcast-cpp-client-5.4.0.tar.gz
257260
```
258261

259262
Alternatively, you may clone the repository and checkout a specific version:
260263
```sh
261264
git clone https://github.com/hazelcast/hazelcast-cpp-client.git
262265
cd hazelcast-cpp-client
263-
git checkout v5.2.0
266+
git checkout v5.4.0
264267
```
265268

266269
Once you are in the source directory of the Hazelcast C++ client library, create and change into a new directory:
267270
```sh
268-
cd hazelcast-cpp-client-5.2.0
271+
cd hazelcast-cpp-client-5.4.0
269272
mkdir build
270273
cd build
271274
```
@@ -292,7 +295,7 @@ Download and extract the release archive from the
292295

293296
Open a `cmd` window and change into the folder where you extracted the contents of the release archive. Then create and change into a new directory:
294297
```bat
295-
cd hazelcast-cpp-client-5.2.0
298+
cd hazelcast-cpp-client-5.4.0
296299
mkdir build
297300
cd build
298301
```

0 commit comments

Comments
 (0)