You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@carbondata.apache.org by ch...@apache.org on 2024/03/22 20:06:08 UTC

(carbondata) branch master updated: Minor refactor the build/README.md (#4349)

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

chenliang613 pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/carbondata.git


The following commit(s) were added to refs/heads/master by this push:
     new 74e6e93b8c Minor refactor the build/README.md (#4349)
74e6e93b8c is described below

commit 74e6e93b8cc97106a3e329375fed6bb3166612dc
Author: hulk <hu...@gmail.com>
AuthorDate: Sat Mar 23 04:06:02 2024 +0800

    Minor refactor the build/README.md (#4349)
    
    * Minor refactor the build docs
    
    * Fix review comments
    
    * Update build/README.md
---
 build/README.md | 23 ++++++++++++++---------
 1 file changed, 14 insertions(+), 9 deletions(-)

diff --git a/build/README.md b/build/README.md
index 6b2d70be59..90f07f0478 100644
--- a/build/README.md
+++ b/build/README.md
@@ -15,31 +15,36 @@
     limitations under the License.
 -->
 
-# Building CarbonData
+# Build from source
 
 ## Prerequisites
+
 * Unix-like environment (Linux, Mac OS X)
 * Git
 * [Apache Maven (Recommend version 3.3 or later)](https://maven.apache.org/download.cgi)
 * [Oracle Java 8](http://www.oracle.com/technetwork/java/javase/downloads/index.html)
 * [Apache Thrift 0.9.3](http://archive.apache.org/dist/thrift/0.9.3/)
 
-## Build command
 Build with different supported versions of Spark, by default using Spark 2.4.5
-```
-mvn -DskipTests -Pspark-2.4 clean package
-```
 
-Note:
+To be noticed:
  - If you are working in Windows environment, remember to add `-Pwindows` while building the project.
  - The mv feature is not compiled by default. If you want to use this feature, remember to add `-Pmv` while building the project.
 
-## For contributors : To build the format code after any changes, please follow the below command.
-Note:Need install Apache Thrift 0.9.3
-```
+## Development
+
+To build the format code after any changes, please follow the below command:
+
+```shell
 mvn clean -DskipTests -Pbuild-with-format -Pspark-2.4 package
 ```
 
+And you can skip the build-with-format stage if you're building an assemble jar:
+
+```shell
+mvn -DskipTests -Pspark-2.4 clean package
+```
+
 # Building CarbonData notebook images
 [How to build carbondata notebook docker image by dockerfile](#How-to-build-carbondata-notebook-docker-image-by-dockerfile.md)  
 [How to build carbondata notebook docker image by manual](#How-to-build-carbondata-notebook-docker-image-by-manual.md)