Skip to content
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.

Commit 0f65846

Browse files
committedApr 17, 2025
readme: remove trailing whitespaces
Trailing whitespaces are never appreciated, so let's remove them all.
1 parent 246ca22 commit 0f65846

File tree

1 file changed

+15
-15
lines changed

1 file changed

+15
-15
lines changed
 

‎README.md

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# tntcxx — Tarantool C++ Connector
22

3-
This repository contains the tntcxx Tarantool C++ connector code. tntcxx is an
4-
open-source Tarantool C++ connector (compliant to C++17) designed with high
3+
This repository contains the tntcxx Tarantool C++ connector code. tntcxx is an
4+
open-source Tarantool C++ connector (compliant to C++17) designed with high
55
efficiency in mind.
66

77
## Building tntcxx
@@ -25,21 +25,21 @@ subdirectory of your project or as an embedded dependency.
2525

2626
1. Make tntcxx's source code available to the main build. This can be done a few
2727
different ways:
28-
* Download the tntcxx source code manually and place it at a known location.
28+
* Download the tntcxx source code manually and place it at a known location.
2929
This is the least flexible approach and can make it more difficult to use
3030
with continuous integration systems, etc.
3131
* Embed the tntcxx source code as a direct copy in the main project's source
32-
tree. This is often the simplest approach, but is also the hardest to keep
32+
tree. This is often the simplest approach, but is also the hardest to keep
3333
up to date. Some organizations may not permit this method.
3434
* Add tntcxx as a [git submodule](https://git-scm.com/docs/git-submodule) or
3535
equivalent. This may not always be possible or appropriate. Git submodules,
3636
for example, have their own set of advantages and drawbacks.
3737
* Use the CMake [`FetchContent`](https://cmake.org/cmake/help/latest/module/FetchContent.html)
38-
commands to download tntcxx as part of the build's configure step. This
38+
commands to download tntcxx as part of the build's configure step. This
3939
approach doesn't have the limitations of the other methods.
4040

41-
The last of the above methods is implemented with a small piece of CMake code
42-
that downloads and pulls the tntcxx code into the main build. Just add the
41+
The last of the above methods is implemented with a small piece of CMake code
42+
that downloads and pulls the tntcxx code into the main build. Just add the
4343
following snippet to your CMakeLists.txt:
4444
```cmake
4545
include(FetchContent)
@@ -50,7 +50,7 @@ FetchContent_Declare(
5050
FetchContent_MakeAvailable(tntcxx)
5151
```
5252

53-
After obtaining tntcxx sources using the rest of the methods, you can use the
53+
After obtaining tntcxx sources using the rest of the methods, you can use the
5454
following CMake command to incorporate tntcxx into your CMake project:
5555
```cmake
5656
add_subdirectory(${TNTCXX_SOURCE_DIR})
@@ -64,8 +64,8 @@ target_link_libraries(example tntcxx::tntcxx)
6464

6565
##### Running tntcxx Tests with CMake
6666

67-
Use the `-DTNTCXX_BUILD_TESTING=ON` option to run the tntcxx tests. This option
68-
is enabled by default if the tntcxx project is determined to be the top level
67+
Use the `-DTNTCXX_BUILD_TESTING=ON` option to run the tntcxx tests. This option
68+
is enabled by default if the tntcxx project is determined to be the top level
6969
project. Note that `BUILD_TESTING` must also be on (the default).
7070

7171
For example, to run the tntcxx tests, you could use this script:
@@ -80,8 +80,8 @@ ctest
8080

8181
### CMake Option Synopsis
8282

83-
- `-DTNTCXX_BUILD_TESTING=ON` must be set to enable testing. This option is
84-
enabled by default if the tntcxx project is determined to be the top level
83+
- `-DTNTCXX_BUILD_TESTING=ON` must be set to enable testing. This option is
84+
enabled by default if the tntcxx project is determined to be the top level
8585
project.
8686

8787
## Internals
@@ -139,7 +139,7 @@ Connection<Buf_t, Net_t> conn(client);
139139
140140
Now assume Tarantool instance is listening `3301` port on localhost. To connect
141141
to the server we should invoke `Connector::connect()` method of client object and
142-
pass three arguments: connection instance, address and port.
142+
pass three arguments: connection instance, address and port.
143143
```c++
144144
int rc = client.connect(conn, address, port);
145145
```
@@ -165,7 +165,7 @@ To execute simplest request (i.e. ping), one can invoke corresponding method of
165165
connection object:
166166
```c++
167167
rid_t ping = conn.ping();
168-
```
168+
```
169169
Each request method returns request id, which is sort of future. It can be used
170170
to get the result of request execution once it is ready (i.e. response). Requests
171171
are queued in the input buffer of connection until `Connector::wait()` is called.
@@ -204,7 +204,7 @@ msgpacks. See section below to understand how to decode tuples.
204204

205205
Now let's consider a bit more sophisticated requests.
206206
Assume we have space with `id = 512` and following format on the server:
207-
`CREATE TABLE t(id INT PRIMARY KEY, a TEXT, b DOUBLE);`
207+
`CREATE TABLE t(id INT PRIMARY KEY, a TEXT, b DOUBLE);`
208208
Preparing analogue of `t:replace(1, "111", 1.01);` request can be done this way:
209209

210210
```c++

0 commit comments

Comments
 (0)
Please sign in to comment.