You are viewing a plain text version of this content. The canonical link for it is here.
Posted to notifications@skywalking.apache.org by ha...@apache.org on 2022/11/06 07:24:58 UTC
[skywalking-banyandb] branch main updated: Fix build guidance for 0.2 (#206)
This is an automated email from the ASF dual-hosted git repository.
hanahmily pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/skywalking-banyandb.git
The following commit(s) were added to refs/heads/main by this push:
new 6ef1c65 Fix build guidance for 0.2 (#206)
6ef1c65 is described below
commit 6ef1c652ada3e7c65f3d0b6859bf47a149699ed1
Author: 吴晟 Wu Sheng <wu...@foxmail.com>
AuthorDate: Sun Nov 6 15:24:53 2022 +0800
Fix build guidance for 0.2 (#206)
* Update installation.md
Signed-off-by: Gao Hongtao <ha...@gmail.com>
Co-authored-by: Gao Hongtao <ha...@gmail.com>
---
CONTRIBUTING.md | 10 +++++-----
docs/installation.md | 38 +++++++++++++++++++++++++++++++-------
2 files changed, 36 insertions(+), 12 deletions(-)
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 706f444..f62cb2a 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -44,16 +44,16 @@ Users who want to build a binary from sources have to set up:
* Go 1.19
* Node 16.15
* Git >= 2.30
-* Linux, MacOS or Windows+WSL2
+* Linux, macOS or Windows+WSL2
* GNU make
### Windows
-BanyanDB is built on Linux and MacOS that introduced several platform-specific characters to the building system. Therefore, we highly recommend you to use [WSL2+Ubuntu](https://ubuntu.com/wsl) to execute tasks of the Makefile.
+BanyanDB is built on Linux and macOS that introduced several platform-specific characters to the building system. Therefore, we highly recommend you use [WSL2+Ubuntu](https://ubuntu.com/wsl) to execute tasks of the Makefile.
#### End of line sequence
-BanyanDB ALWAYS use `LF`(`\n`) as the line endings, even on a Windows. So we need your development tool and IDEs to generate new files with `LF` as its end of lines.
+BanyanDB ALWAYS uses `LF`(`\n`) as the line endings, even on Windows. So we need your development tool and IDEs to generate new files with `LF` as its end of lines.
## Building and Testing
@@ -75,7 +75,7 @@ Finally, run `make build` in the source directory, which will build the default
make build
```
-Please refer to [installation](./docs/installation.md) for more details.
+Please refer to the [installation](./docs/installation.md) for more details.
Test your changes before submitting them by
@@ -91,7 +91,7 @@ We have some rules for the code style and please lint your codes locally before
make lint
```
-If you found some errors in the output of the above command, try `make format` to fix some obvious style issues. As for the complicated errors, please correct them manually.
+If you found some errors in the output of the above command, try to `make format` to fix some obvious style issues. As for the complicated errors, please correct them manually.
## Update licenses
diff --git a/docs/installation.md b/docs/installation.md
index 4e0a545..edc82e8 100644
--- a/docs/installation.md
+++ b/docs/installation.md
@@ -3,11 +3,11 @@
`Banyand` is the daemon server of the BanyanDB database. This section will show several paths installing it in your environment.
-## Get Banyand
+## Get Binaries
### Released binaries
-Get binaries from [download](https://skywalking.apache.org/downloads/).
+Get binaries from the [download](https://skywalking.apache.org/downloads/).
### Build From Source
@@ -15,18 +15,38 @@ Get binaries from [download](https://skywalking.apache.org/downloads/).
Users who want to build a binary from sources have to set up:
-* Go >= 1.19
-* Linux or MacOS
+* Go 1.19
+* Node 16.15
+* Git >= 2.30
+* Linux, macOS or Windows+WSL2
* GNU make
-#### Build Banyand
+#### Windows
-To issue the below command to get a basic binary.
+BanyanDB is built on Linux and macOS that introduced several platform-specific characters to the building system. Therefore, we highly recommend you use [WSL2+Ubuntu](https://ubuntu.com/wsl) to execute tasks of the Makefile.
+
+#### Build Binaries
+
+To issue the below command to get basic binaries of banyand and bydbctl.
```shell
+$ make generate
+...
$ make build
+...
+--- banyand: all ---
+make[1]: Entering directory '<path_to_project_root>/banyand'
+...
chmod +x build/bin/banyand-server
Done building banyand server
+make[1]: Leaving directory '<path_to_project_root>/banyand'
+...
+--- bydbctl: all ---
+make[1]: Entering directory '<path_to_project_root>/bydbctl'
+...
+chmod +x build/bin/bydbctl
+Done building bydbctl
+make[1]: Leaving directory '<path_to_project_root>/bydbctl'
```
The build system provides a series of binary options as well.
@@ -35,6 +55,7 @@ The build system provides a series of binary options as well.
* `make -C banyand release` builds out a static binary for releasing.
* `make -C banyand debug` gives a binary for debugging without the complier's optimizations.
* `make -C banyand debug-static` is a static binary for debugging.
+* `make -C bydbctl release` cross-builds several binaries for multi-platforms.
Then users get binaries as below
@@ -44,6 +65,9 @@ banyand-server
banyand-server-debug
banyand-server-debug-static
banyand-server-static
+
+$ ls banyand/build/bin
+bydbctl
```
## Setup Banyand
@@ -95,7 +119,7 @@ $ ./banyand-server standalone
The banyand-server would be listening on the `0.0.0.0:17912` if no errors occurred.
-To discovery more options to configure the banyand by
+To discover more options to configure the banyand by
```shell
$ ./banyand-server standalone -h