Skip to content

Commit 7072042

Browse files
committed
chore: add missing READMEs and fix clippy warning
Add README files for common, jni-bridge, and shuffle crates. Add Default impl for Recorder to satisfy clippy.
1 parent 17ba839 commit 7072042

File tree

4 files changed

+81
-0
lines changed

4 files changed

+81
-0
lines changed

native/common/README.md

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
<!--
2+
Licensed to the Apache Software Foundation (ASF) under one
3+
or more contributor license agreements. See the NOTICE file
4+
distributed with this work for additional information
5+
regarding copyright ownership. The ASF licenses this file
6+
to you under the Apache License, Version 2.0 (the
7+
"License"); you may not use this file except in compliance
8+
with the License. You may obtain a copy of the License at
9+
10+
http://www.apache.org/licenses/LICENSE-2.0
11+
12+
Unless required by applicable law or agreed to in writing,
13+
software distributed under the License is distributed on an
14+
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15+
KIND, either express or implied. See the License for the
16+
specific language governing permissions and limitations
17+
under the License.
18+
-->
19+
20+
# datafusion-comet-common: Common Types
21+
22+
This crate provides common types shared across Apache DataFusion Comet crates and is maintained as part of the
23+
[Apache DataFusion Comet] subproject.
24+
25+
[Apache DataFusion Comet]: https://github.com/apache/datafusion-comet/

native/common/src/tracing.rs

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,12 @@ pub struct Recorder {
2929
writer: Arc<Mutex<BufWriter<File>>>,
3030
}
3131

32+
impl Default for Recorder {
33+
fn default() -> Self {
34+
Self::new()
35+
}
36+
}
37+
3238
impl Recorder {
3339
pub fn new() -> Self {
3440
let file = OpenOptions::new()

native/jni-bridge/README.md

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
<!--
2+
Licensed to the Apache Software Foundation (ASF) under one
3+
or more contributor license agreements. See the NOTICE file
4+
distributed with this work for additional information
5+
regarding copyright ownership. The ASF licenses this file
6+
to you under the Apache License, Version 2.0 (the
7+
"License"); you may not use this file except in compliance
8+
with the License. You may obtain a copy of the License at
9+
10+
http://www.apache.org/licenses/LICENSE-2.0
11+
12+
Unless required by applicable law or agreed to in writing,
13+
software distributed under the License is distributed on an
14+
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15+
KIND, either express or implied. See the License for the
16+
specific language governing permissions and limitations
17+
under the License.
18+
-->
19+
20+
# datafusion-comet-jni-bridge: JNI Bridge
21+
22+
This crate provides the JNI interaction layer for Apache DataFusion Comet and is maintained as part of the
23+
[Apache DataFusion Comet] subproject.
24+
25+
[Apache DataFusion Comet]: https://github.com/apache/datafusion-comet/

native/shuffle/README.md

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
<!--
2+
Licensed to the Apache Software Foundation (ASF) under one
3+
or more contributor license agreements. See the NOTICE file
4+
distributed with this work for additional information
5+
regarding copyright ownership. The ASF licenses this file
6+
to you under the Apache License, Version 2.0 (the
7+
"License"); you may not use this file except in compliance
8+
with the License. You may obtain a copy of the License at
9+
10+
http://www.apache.org/licenses/LICENSE-2.0
11+
12+
Unless required by applicable law or agreed to in writing,
13+
software distributed under the License is distributed on an
14+
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15+
KIND, either express or implied. See the License for the
16+
specific language governing permissions and limitations
17+
under the License.
18+
-->
19+
20+
# datafusion-comet-shuffle: Shuffle Writer and Reader
21+
22+
This crate provides the shuffle writer and reader implementation for Apache DataFusion Comet and is maintained as part
23+
of the [Apache DataFusion Comet] subproject.
24+
25+
[Apache DataFusion Comet]: https://github.com/apache/datafusion-comet/

0 commit comments

Comments
 (0)