Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[MINOR] Fix the comment about usage of build.sh #6254

Merged
merged 3 commits into from
Jul 18, 2021

Conversation

caneGuy
Copy link
Contributor

@caneGuy caneGuy commented Jul 16, 2021

Proposed changes

The usage of build.sh in the current comment is misleading. For example, if we execute with 'sh build.sh -clean', we will get the following error.

Python 2.7.5
Apache Maven 3.6.3 (cecedd343002696d0abb50b32b541b8a6ba2883f)
Maven home: /usr/share/maven
Java version: 1.8.0_202, vendor: Oracle Corporation, runtime: /usr/java/jdk/jre
Default locale: en_US, platform encoding: ANSI_X3.4-1968
OS name: "linux", version: "4.19.76-linuxkit", arch: "amd64", family: "unix"
cmake version 3.12.3

CMake suite maintained and supported by Kitware (kitware.com/cmake).
build.sh: invalid option -- 'c'
build.sh: invalid option -- 'l'
build.sh: invalid option -- 'e'
build.sh: invalid option -- 'a'
build.sh: invalid option -- 'n'

Types of changes

What types of changes does your code introduce to Doris?
Put an x in the boxes that apply

  • Bugfix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • Documentation Update (if none of the other choices apply)
  • Code refactor (Modify the code structure, format the code, etc...)
  • Optimization. Including functional usability improvements and performance improvements.
  • Dependency. Such as changes related to third-party components.
  • Other.

Checklist

Put an x in the boxes that apply. You can also fill these out after creating the PR. If you're unsure about any of them, don't hesitate to ask. We're here to help! This is simply a reminder of what we are going to look for before merging your code.

  • I have created an issue on (Fix #ISSUE) and described the bug/feature there in detail
  • Compiling and unit tests pass locally with my changes
  • I have added tests that prove my fix is effective or that my feature works
  • If these changes need document changes, I have updated the document
  • Any dependent changes have been merged

Further comments

@caneGuy
Copy link
Contributor Author

caneGuy commented Jul 16, 2021

cc @caiconghui

@caneGuy caneGuy changed the title [MINOR] Fix comment about usage of build.sh [MINOR] Fix the comment about usage of build.sh Jul 16, 2021
Copy link
Contributor

@morningman morningman left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you for your PR.

build.sh Outdated
# Eg:
# sh build.sh build all
# sh build.sh --be build Backend without clean
# sh build.sh --fe --clean clean and build Frontend and Spark Dpp application
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
# sh build.sh --fe --clean clean and build Frontend and Spark Dpp application
# sh build.sh --fe --clean clean and build Frontend and Spark Dpp application, without web UI.

build.sh Outdated
# Eg:
# sh build.sh build all
# sh build.sh --be build Backend without clean
# sh build.sh --fe --clean clean and build Frontend and Spark Dpp application
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
# sh build.sh --fe --clean clean and build Frontend and Spark Dpp application
# sh build.sh --fe --clean clean and build Frontend and Spark Dpp application, without web UI.

build.sh Outdated
# sh build.sh build all
# sh build.sh --be build Backend without clean
# sh build.sh --fe --clean clean and build Frontend and Spark Dpp application
# sh build.sh --fe --be --clean clean and build Frontend, Spark Dpp application and Backend
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
# sh build.sh --fe --be --clean clean and build Frontend, Spark Dpp application and Backend
# sh build.sh --fe --be --clean clean and build Frontend, Spark Dpp application and Backend, without web UI.

build.sh Outdated
# sh build.sh --fe --clean clean and build Frontend and Spark Dpp application
# sh build.sh --fe --be --clean clean and build Frontend, Spark Dpp application and Backend
# sh build.sh --spark-dpp build Spark DPP application alone
# sh build.sh --fe --ui build Frontend web ui with npm
Copy link
Contributor

@morningman morningman Jul 16, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please add a new entry:
# sh build.sh --fe --be --ui --clean clean and build Frontend, Spark Dpp application, Backend and web UI

@caneGuy
Copy link
Contributor Author

caneGuy commented Jul 16, 2021

Thanks for your time @morningman PTAL

Copy link
Contributor

@caiconghui caiconghui left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@caiconghui caiconghui added the approved Indicates a PR has been approved by one committer. label Jul 17, 2021
@caiconghui caiconghui merged commit c6e442e into apache:master Jul 18, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
approved Indicates a PR has been approved by one committer. area/script
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants