Skip to content

Commit

Permalink
misc
Browse files Browse the repository at this point in the history
  • Loading branch information
xyjixyjixyji committed Jun 10, 2023
1 parent 04cb6b0 commit 6fb7d94
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 24 deletions.
30 changes: 8 additions & 22 deletions bindings/c/CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,11 @@
# Contributing
- [Contributing](#contributing)
- [Setup](#setup)
- [Using a dev container environment](#using-a-dev-container-environment)
- [Bring your own toolbox](#bring-your-own-toolbox)
- [Build](#build)
- [Test](#test)
- [Docs](#docs)
- [Misc](#misc)
1. [Contributing](#contributing)
1. [Setup](#setup)
1. [Using a dev container environment](#using-a-dev-container-environment)
2. [Bring your own toolbox](#bring-your-own-toolbox)
2. [Build](#build)
3. [Test](#test)
4. [Documentation](#documentation)

## Setup

Expand Down Expand Up @@ -60,24 +59,11 @@ make clean
```

## Test
To build and run the tests. (Note that you need to install GTest)
To build and run the tests. (Note that you need to install GTest to build the test)
```shell
make tests
```

```text
[==========] Running 1 test from 1 test suite.
[----------] Global test environment set-up.
[----------] 1 test from OpendalBddTest
[ RUN ] OpendalBddTest.FeatureTest
[ OK ] OpendalBddTest.FeatureTest (0 ms)
[----------] 1 test from OpendalBddTest (0 ms total)
[----------] Global test environment tear-down
[==========] 1 test from 1 test suite ran. (0 ms total)
[ PASSED ] 1 test.
```

## Documentation
The documentation index page source is under `./docs/doxygen/html/index.html`.
If you want to build the documentations yourself, you could use
Expand Down
4 changes: 2 additions & 2 deletions bindings/c/tests/list.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -100,10 +100,10 @@ TEST_F(OpendalListTest, ListDirTest) {
opendal_lister_free(&lister);
}

// Try list an empty directory
// todo: Try list an empty directory
TEST_F(OpendalListTest, ListEmptyDirTest) {}

// Try list a directory that does not exist
// todo: Try list a directory that does not exist
TEST_F(OpendalListTest, ListNotExistDirTest) {}

int main(int argc, char **argv) {
Expand Down

0 comments on commit 6fb7d94

Please sign in to comment.