(incubator-celeborn) branch main updated: [MINOR] Fix typo of celeborn.network.bind.preferIpAddress doc

[nicholasjiang]

This is an automated email from the ASF dual-hosted git repository.

nicholasjiang pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/incubator-celeborn.git


The following commit(s) were added to refs/heads/main by this push:
     new d33ac2894 [MINOR] Fix typo of celeborn.network.bind.preferIpAddress doc
d33ac2894 is described below

commit d33ac2894509fc8892ebbf4af1863511646d3aa2
Author: SteNicholas <programg...@163.com>
AuthorDate: Thu Mar 14 17:12:33 2024 +0800

    [MINOR] Fix typo of celeborn.network.bind.preferIpAddress doc
    
    ### What changes were proposed in this pull request?
    
    Fix typo of `celeborn.network.bind.preferIpAddress` doc from `ture` to 
`true`.
    
    ### Why are the changes needed?
    
    `celeborn.network.bind.preferIpAddress` doc has typo for `ture`.
    
    ### Does this PR introduce _any_ user-facing change?
    
    No.
    
    ### How was this patch tested?
    
    No.
    
    Closes #2392 from SteNicholas/prefer-ip-address.
    
    Authored-by: SteNicholas <programg...@163.com>
    Signed-off-by: SteNicholas <programg...@163.com>
---
 common/src/main/scala/org/apache/celeborn/common/CelebornConf.scala | 2 +-
 docs/configuration/network.md                                       | 2 +-
 2 files changed, 2 insertions(+), 2 deletions(-)

diff --git 
a/common/src/main/scala/org/apache/celeborn/common/CelebornConf.scala 
b/common/src/main/scala/org/apache/celeborn/common/CelebornConf.scala
index 740683db7..036f3df1b 100644
--- a/common/src/main/scala/org/apache/celeborn/common/CelebornConf.scala
+++ b/common/src/main/scala/org/apache/celeborn/common/CelebornConf.scala
@@ -1378,7 +1378,7 @@ object CelebornConf extends Logging {
     buildConf("celeborn.network.bind.preferIpAddress")
       .categories("network")
       .version("0.3.0")
-      .doc("When `ture`, prefer to use IP address, otherwise FQDN. This 
configuration only " +
+      .doc("When `true`, prefer to use IP address, otherwise FQDN. This 
configuration only " +
         "takes effects when the bind hostname is not set explicitly, in such 
case, Celeborn " +
         "will find the first non-loopback address to bind.")
       .booleanConf
diff --git a/docs/configuration/network.md b/docs/configuration/network.md
index 3d05dc560..35e438b6b 100644
--- a/docs/configuration/network.md
+++ b/docs/configuration/network.md
@@ -41,7 +41,7 @@ license: |
 | celeborn.&lt;module&gt;.push.timeoutCheck.threads | 4 | false | Threads num 
for checking push data timeout. If setting <module> to `data`, it works for 
shuffle client push data. If setting <module> to `push`, it works for Flink 
shuffle client push data. If setting <module> to `replicate`, it works for 
replicate client of worker replicating data to peer worker. | 0.3.0 |  | 
 | celeborn.&lt;role&gt;.rpc.dispatcher.threads | &lt;value of 
celeborn.rpc.dispatcher.threads&gt; | false | Threads number of message 
dispatcher event loop for roles |  |  | 
 | celeborn.io.maxDefaultNettyThreads | 64 | false | Max default netty threads 
| 0.3.2 |  | 
-| celeborn.network.bind.preferIpAddress | true | false | When `ture`, prefer 
to use IP address, otherwise FQDN. This configuration only takes effects when 
the bind hostname is not set explicitly, in such case, Celeborn will find the 
first non-loopback address to bind. | 0.3.0 |  | 
+| celeborn.network.bind.preferIpAddress | true | false | When `true`, prefer 
to use IP address, otherwise FQDN. This configuration only takes effects when 
the bind hostname is not set explicitly, in such case, Celeborn will find the 
first non-loopback address to bind. | 0.3.0 |  | 
 | celeborn.network.connect.timeout | 10s | false | Default socket connect 
timeout. | 0.2.0 |  | 
 | celeborn.network.memory.allocator.numArenas | &lt;undefined&gt; | false | 
Number of arenas for pooled memory allocator. Default value is 
Runtime.getRuntime.availableProcessors, min value is 2. | 0.3.0 |  | 
 | celeborn.network.memory.allocator.verbose.metric | false | false | Whether 
to enable verbose metric for pooled allocator. | 0.3.0 |  |