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

ORC-1189: Update README.md and help command message in benchmark module and .gitignore #1142

Closed
wants to merge 1 commit into from

Conversation

mwlon
Copy link
Contributor

@mwlon mwlon commented May 26, 2022

What changes were proposed in this pull request?

Make docs and gitignore a bit more helpful for benchmark suite

Why are the changes needed?

  • Benchmark generate command should not refer to itself as convert:
usage: convert <root>
 -c,--compress <arg>   List of compression
 -d,--data <arg>       List of data sets
 -f,--format <arg>     List of formats
 -h,--help             Provide help
 -s,--sales <arg>      Number of records for sales
  • README command for packaging the benchmark suite currently runs all tests; usually this is not necessary
  • benchmark generated data should be in .gitignore so that they are not accidentally added to git history

How was this patch tested?

No functionality or tests were modified

@mwlon
Copy link
Contributor Author

mwlon commented May 26, 2022

@dongjoon-hyun

@mwlon mwlon changed the title minor documentation updates Minor Benchmark Documentation Updates May 26, 2022
@mwlon mwlon changed the title Minor Benchmark Documentation Updates ORC-1189 Minor Benchmark Documentation Updates May 26, 2022
@dongjoon-hyun dongjoon-hyun changed the title ORC-1189 Minor Benchmark Documentation Updates ORC-1189: Update README.md and help command message in benchmark module and .gitignore May 26, 2022
Copy link
Member

@dongjoon-hyun dongjoon-hyun left a comment

Choose a reason for hiding this comment

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

+1, LGTM. (Pending CIs).
Thank you, @mwlon .

dongjoon-hyun pushed a commit that referenced this pull request May 26, 2022
…` module and `.gitignore`

### What changes were proposed in this pull request?
Make docs and gitignore a bit more helpful for benchmark suite

### Why are the changes needed?
* Benchmark `generate` command should not refer to itself as `convert`:
```$ java -jar core/target/orc-benchmarks-core-*-uber.jar generate data --help
usage: convert <root>
 -c,--compress <arg>   List of compression
 -d,--data <arg>       List of data sets
 -f,--format <arg>     List of formats
 -h,--help             Provide help
 -s,--sales <arg>      Number of records for sales
```
 * README command for packaging the benchmark suite currently runs all tests; usually this is not necessary
 * benchmark generated data should be in .gitignore so that they are not accidentally added to git history

### How was this patch tested?
No functionality or tests were modified

Closes #1142 from mwlon/ORC-1189-docs.

Authored-by: mwlon <m.w.loncaric@gmail.com>
Signed-off-by: Dongjoon Hyun <dongjoon@apache.org>
(cherry picked from commit dc2d864)
Signed-off-by: Dongjoon Hyun <dongjoon@apache.org>
dongjoon-hyun pushed a commit that referenced this pull request May 26, 2022
…` module and `.gitignore`

### What changes were proposed in this pull request?
Make docs and gitignore a bit more helpful for benchmark suite

### Why are the changes needed?
* Benchmark `generate` command should not refer to itself as `convert`:
```$ java -jar core/target/orc-benchmarks-core-*-uber.jar generate data --help
usage: convert <root>
 -c,--compress <arg>   List of compression
 -d,--data <arg>       List of data sets
 -f,--format <arg>     List of formats
 -h,--help             Provide help
 -s,--sales <arg>      Number of records for sales
```
 * README command for packaging the benchmark suite currently runs all tests; usually this is not necessary
 * benchmark generated data should be in .gitignore so that they are not accidentally added to git history

### How was this patch tested?
No functionality or tests were modified

Closes #1142 from mwlon/ORC-1189-docs.

Authored-by: mwlon <m.w.loncaric@gmail.com>
Signed-off-by: Dongjoon Hyun <dongjoon@apache.org>
(cherry picked from commit dc2d864)
Signed-off-by: Dongjoon Hyun <dongjoon@apache.org>
@dongjoon-hyun
Copy link
Member

Merged to main/1.8/1.7.

@dongjoon-hyun dongjoon-hyun added this to the 1.7.5 milestone May 26, 2022
@dongjoon-hyun
Copy link
Member

I added you to the Apache ORC contributor group and assign ORC-1189 to you. Thank you again, @mwlon .

@mwlon
Copy link
Contributor Author

mwlon commented May 26, 2022

Thanks for the review, @dongjoon-hyun

cxzl25 pushed a commit to cxzl25/orc that referenced this pull request Jan 11, 2024
…` module and `.gitignore`

### What changes were proposed in this pull request?
Make docs and gitignore a bit more helpful for benchmark suite

### Why are the changes needed?
* Benchmark `generate` command should not refer to itself as `convert`:
```$ java -jar core/target/orc-benchmarks-core-*-uber.jar generate data --help
usage: convert <root>
 -c,--compress <arg>   List of compression
 -d,--data <arg>       List of data sets
 -f,--format <arg>     List of formats
 -h,--help             Provide help
 -s,--sales <arg>      Number of records for sales
```
 * README command for packaging the benchmark suite currently runs all tests; usually this is not necessary
 * benchmark generated data should be in .gitignore so that they are not accidentally added to git history

### How was this patch tested?
No functionality or tests were modified

Closes apache#1142 from mwlon/ORC-1189-docs.

Authored-by: mwlon <m.w.loncaric@gmail.com>
Signed-off-by: Dongjoon Hyun <dongjoon@apache.org>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants