Skip to content
This repository was archived by the owner on Dec 26, 2022. It is now read-only.

Commit 5b9207b

Browse files
authored
Merge pull request #613 from afcidk/logger
doc: Add documentation for different build types
2 parents 15b3dbc + 2b6f54c commit 5b9207b

File tree

2 files changed

+14
-2
lines changed

2 files changed

+14
-2
lines changed

README.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -108,6 +108,18 @@ Tangle-accelerator supports several different build time options.
108108
* Docker images
109109
* MQTT connectivity
110110
* External database
111+
* Debug Mode
112+
113+
Debug mode enables tangle-accelerator to display extra `debug` logs.
114+
```
115+
bazel run --define build_type=debug //accelerator
116+
```
117+
* Profiling Mode
118+
119+
Profiling mode adds `-pg` flag when compiling tangle-accelerator. This allows tangle-accelerator to write profile information for the analysis program gprof.
120+
```
121+
bazel run --define build_type=profile //accelerator
122+
```
111123

112124
See [docs/build.md](docs/build.md) for more information.
113125

docs/build.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,7 @@ make && bazel run --define db=enable //accelerator
6161

6262
When enabling reattachment, every transaction issues from the `tangle-accelerator` API called `Send Transfer Message` will be stored in the specific ScyllaDB host and response a UUID string for each transfer message as the identifier. With a promoting process that monitors the status of storing transactions, persistent pending transactions will be reattached to the Tangle.
6363

64-
Transaction reattachment relies on ScyllDB, you need to install the dependency by following commands.
64+
Transaction reattachment relies on ScyllaDB, you need to install the dependency by following commands.
6565

6666
For Ubuntu Linux 16.04/x86_64:
6767

@@ -79,4 +79,4 @@ wget https://downloads.datastax.com/cpp-driver/ubuntu/18.04/cassandra/v2.14.1/ca
7979
wget https://downloads.datastax.com/cpp-driver/ubuntu/18.04/cassandra/v2.14.1/cassandra-cpp-driver-dev_2.14.1-1_amd64.deb
8080
sudo dpkg -i cassandra-cpp-driver_2.14.1-1_amd64.deb
8181
sudo dpkg -i cassandra-cpp-driver-dev_2.14.1-1_amd64.deb
82-
```
82+
```

0 commit comments

Comments
 (0)