Skip to content

Commit

Permalink
docs: add bectl chapter
Browse files Browse the repository at this point in the history
  • Loading branch information
Johannes Wünsche committed Nov 23, 2022
1 parent ca2fa37 commit 6b382c7
Show file tree
Hide file tree
Showing 4 changed files with 30 additions and 2 deletions.
4 changes: 2 additions & 2 deletions docs/src/SUMMARY.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,8 @@
- [Design Overview](./betree/design.md)
- [Known Bugs](./betree/bugs.md)
- [bectl](./bectl.md)
- [Build & Test]()
- [Basic Usage]()
- [Build & Test](./bectl/build.md)
- [Basic Usage](./bectl/usage.md)
- [julea-betree](./julea-betree.md)
- [Build]()
- [Usage in JULEA]()
Expand Down
6 changes: 6 additions & 0 deletions docs/src/bectl.md
Original file line number Diff line number Diff line change
@@ -1 +1,7 @@
# bectl

This application allows for usage with an CLI albeit suboptimally as the
complete stack has to be reinitialized on each access. It is best fit for
debugging at the moment and demonstration purposes.

We shortly demonstrate how to build it and how to configure and use it.
20 changes: 20 additions & 0 deletions docs/src/bectl/build.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
# Build & Test


Building `bectl` is relatively simple but does require all dependencies of
`betree_storage_stack` to be available. If you have not done this yet refer to
the [Building chapter](../build.md).

Given all prerequisites are fulfilled simply run

```sh
$ cargo build
```

from the `bectl` directory to build bectl on its own.

---

There are not yet any tests provided for the `bectl` as the functionality is a
rather simple mapping to `betree_storage_stack` functions. If we want to expand
this in the future we might want to ensure that.
2 changes: 2 additions & 0 deletions docs/src/bectl/usage.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
# Basic Usage

0 comments on commit 6b382c7

Please sign in to comment.