This is an automated email from the ASF dual-hosted git repository.
rui pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/incubator-gluten.git
The following commit(s) were added to refs/heads/main by this push:
new c448ea55ba [DOC] Fix typos in documentation (#8155)
c448ea55ba is described below
commit c448ea55ba7582e94760151d50e7973b071161f1
Author: Rui Mo <[email protected]>
AuthorDate: Thu Dec 5 15:49:54 2024 +0800
[DOC] Fix typos in documentation (#8155)
---
docs/developers/CppCodingStyle.md | 10 +++++-----
docs/developers/MicroBenchmarks.md | 2 +-
docs/developers/NewToGluten.md | 4 ++--
docs/developers/VeloxUDF.md | 4 ++--
docs/get-started/ClickHouse.md | 2 +-
docs/get-started/Velox.md | 2 +-
docs/get-started/VeloxGCS.md | 4 ++--
docs/velox-backend-limitations.md | 2 +-
8 files changed, 15 insertions(+), 15 deletions(-)
diff --git a/docs/developers/CppCodingStyle.md
b/docs/developers/CppCodingStyle.md
index 42101882a9..2cea8fe8fe 100644
--- a/docs/developers/CppCodingStyle.md
+++ b/docs/developers/CppCodingStyle.md
@@ -73,7 +73,7 @@ cmake-format --first-comment-is-literal True --in-place
cpp/velox/CMakeLists.txt
* Obvious exception: files used for defining various misc functions.
* If a header file has a corresponding source file, they should have the same
file
name with different suffix, such as `a.h vs a.cc`.
-* If a function is declared in the file `a.h`, ensure it's defined in the
corrosponding
+* If a function is declared in the file `a.h`, ensure it's defined in the
corresponding
source file `a.cc`, do not define it in other files.
* No deep source directory for CPP files, not do it as JAVA.
* Include header files should satisfy the following rules.
@@ -95,7 +95,7 @@ cmake-format --first-comment-is-literal True --in-place
cpp/velox/CMakeLists.txt
* Ensure that public inheritance represent the relation of `is-a`.
* Ensure that private inheritance represent the relation of
`implements-with`.
* Don't make a function `virtual` without reason.
-* Ensure the polymorphic base class has a `virtual` deconstructor.
+* Ensure the polymorphic base class has a `virtual` destructor.
* Use `override` to make overriding explicit and to make the compiler work.
* Use `const` to mark the member function read-only as far as possible.
* When you try to define a `copy constructor` or a `operator=` for a class,
remember
@@ -113,8 +113,8 @@ cmake-format --first-comment-is-literal True --in-place
cpp/velox/CMakeLists.txt
the function name. such as. use `get(size_t index)` instead of
`getByIndex`.
* A function should focus on a single logic operation.
* A function should do as the name meaning.
- * do everything converd by the function name
- * don't do anything not convered by the function name
+ * do everything covered by the function name
+ * don't do anything not covered by the function name
## Variable
@@ -158,7 +158,7 @@ cmake-format --first-comment-is-literal True --in-place
cpp/velox/CMakeLists.txt
* `unique_ptr` represents ownership, but not share ownership.
`unique_ptr` is
equivalent to RAII, release the resource when the object is
destructed.
* `shared_ptr` represents shared ownership by use-count. It is more
expensive
- that `unqiue_ptr`.
+ that `unique_ptr`.
* `weak_ptr` models temporary ownership. It is useful in breaking
reference cycles
formed by objects managed by `shared_ptr`.
* Use `unique_ptr` or `shared_ptr` to represent ownership.
diff --git a/docs/developers/MicroBenchmarks.md
b/docs/developers/MicroBenchmarks.md
index 1483dc2cba..c59d6be3a6 100644
--- a/docs/developers/MicroBenchmarks.md
+++ b/docs/developers/MicroBenchmarks.md
@@ -15,7 +15,7 @@ comparing with directly debugging in a Spark job. Developers
can use it to creat
workloads, debug in native process, profile the hotspot and do optimizations.
To simulate a first stage, you need to dump the Substrait plan and input split
info into two JSON
-files. The input URIs of the splits should be exising file locations, which
can be either local or
+files. The input URIs of the splits should be existing file locations, which
can be either local or
HDFS paths.
To simulate a middle stage, in addition to the JSON file, you also need to
save the input data of
diff --git a/docs/developers/NewToGluten.md b/docs/developers/NewToGluten.md
index 347213a418..b790d8740a 100644
--- a/docs/developers/NewToGluten.md
+++ b/docs/developers/NewToGluten.md
@@ -55,7 +55,7 @@
spark.executor.extraJavaOptions=-Dio.netty.tryReflectionSetAccessible=true
## Maven 3.6.3 or above
-[Maven Dowload Page](https://maven.apache.org/docs/history.html)
+[Maven Download Page](https://maven.apache.org/docs/history.html)
And then set the environment setting.
## GCC 11 or above
@@ -247,7 +247,7 @@ Then you can create breakpoint and debug in `Run and Debug`
section.
### Velox debug
For some velox tests such as `ParquetReaderTest`, tests need to read the
parquet file in `<velox_home>/velox/dwio/parquet/tests/examples`,
-you should let the screen on `ParquetReaderTest.cpp`, then click `Start
Debuging`, otherwise `No such file or directory` exception will be raised.
+you should let the screen on `ParquetReaderTest.cpp`, then click `Start
Debugging`, otherwise `No such file or directory` exception will be raised.
## Useful notes
diff --git a/docs/developers/VeloxUDF.md b/docs/developers/VeloxUDF.md
index 4cbdcfa992..a8b6a86aeb 100644
--- a/docs/developers/VeloxUDF.md
+++ b/docs/developers/VeloxUDF.md
@@ -38,7 +38,7 @@ The following steps demonstrate how to set up a UDF library
project:
- `registerUdf()`:
This function is called to register the UDF to Velox function registry.
- This is where users should register functions by calling
`facebook::velox::exec::registerVecotorFunction` or other Velox APIs.
+ This is where users should register functions by calling
`facebook::velox::exec::registerVectorFunction` or other Velox APIs.
- The interface functions are mapped to marcos in
[Udf.h](../../cpp/velox/udf/Udf.h).
@@ -215,7 +215,7 @@ pip3 install pyspark==$SPARK_VERSION cython
pip3 install pandas pyarrow
```
-Gluten provides a config to control enable `ColumnarArrowEvalPython` or not,
with `true` as defalt.
+Gluten provides a config to control enable `ColumnarArrowEvalPython` or not,
with `true` as default.
```
spark.gluten.sql.columnar.arrowUdf
diff --git a/docs/get-started/ClickHouse.md b/docs/get-started/ClickHouse.md
index 2f6a912f43..2877474182 100644
--- a/docs/get-started/ClickHouse.md
+++ b/docs/get-started/ClickHouse.md
@@ -118,7 +118,7 @@ cd $gluten_root/cpp-ch/local-engine/docker
`build_directory` is a directory used as to store the intermediate files from
compiling. It will use `current_dir>`/build as the default value if you don't
provide it.
-`output_directory` is used as to store the finaly output `libch.so`. The
default value is `current_dir`/output if you don't provide it.
+`output_directory` is used as to store the finally output `libch.so`. The
default value is `current_dir`/output if you don't provide it.
3. (Option 1) Use CLion
diff --git a/docs/get-started/Velox.md b/docs/get-started/Velox.md
index bfaa0200c7..3b3ab07a8d 100644
--- a/docs/get-started/Velox.md
+++ b/docs/get-started/Velox.md
@@ -217,7 +217,7 @@ cd /path/to/gluten
./dev/buildbundle-veloxbe.sh --enable_s3=ON
```
-Currently there are several ways to asscess S3 in Spark. Please refer [Velox
S3](VeloxS3.md) part for more detailed configurations
+Currently there are several ways to access S3 in Spark. Please refer [Velox
S3](VeloxS3.md) part for more detailed configurations
## Celeborn support
diff --git a/docs/get-started/VeloxGCS.md b/docs/get-started/VeloxGCS.md
index 453bee117c..09e0a927ca 100644
--- a/docs/get-started/VeloxGCS.md
+++ b/docs/get-started/VeloxGCS.md
@@ -24,7 +24,7 @@ After these steps, no specific configuration is required for
Gluten, since the a
For workloads that need to be fully automated, manually authorizing can be
problematic. For such cases it is better to use a json file with the
credentials.
This is described in the [instructions to configure a service
account]https://cloud.google.com/sdk/docs/authorizing#service-account.
-Such json file with the credetials can be passed to Gluten:
+Such json file with the credentials can be passed to Gluten:
```sh
spark.hadoop.fs.gs.auth.type
SERVICE_ACCOUNT_JSON_KEYFILE
@@ -49,5 +49,5 @@ spark.hadoop.fs.gs.http.max.retry // number of times to keep
retrying unless a n
For cases when a transient server error is detected, GCS can be configured to
keep retrying until the retry loop exceeds a prescribed duration.
```sh
-spark.hadoop.fs.gs.http.max.retry-time // a string representing the time keep
retring (10s, 1m, etc).
+spark.hadoop.fs.gs.http.max.retry-time // a string representing the time keep
retrying (10s, 1m, etc).
```
\ No newline at end of file
diff --git a/docs/velox-backend-limitations.md
b/docs/velox-backend-limitations.md
index e05b589524..161b1bfc71 100644
--- a/docs/velox-backend-limitations.md
+++ b/docs/velox-backend-limitations.md
@@ -147,7 +147,7 @@ Gluten's.
### Spill
-`OutOfMemoryExcetpion` may still be triggered within current implementation of
spill-to-disk feature, when shuffle partitions is set to a large number. When
this case happens, please try to reduce the partition number to get rid of the
OOM.
+`OutOfMemoryException` may still be triggered within current implementation of
spill-to-disk feature, when shuffle partitions is set to a large number. When
this case happens, please try to reduce the partition number to get rid of the
OOM.
### Unsupported Data type support in ParquetScan
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
