Skip to content

ARROW-10933: [Rust] Update readme files in regard to nightly rust #8931

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.

Sign up for GitHub

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

Closed
alamb wants to merge 1 commit into from
Closed

ARROW-10933: [Rust] Update readme files in regard to nightly rust #8931

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 2 additions & 4 deletions rust/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -111,10 +111,8 @@ from here on, this is a pure Rust project and `cargo` can be used to run tests,

## Code Formatting

Our CI uses `rustfmt` to check code formatting. Although the project is
built and tested against nightly rust we use the stable version of
`rustfmt`. So before submitting a PR be sure to run the following
and check for lint issues:
Our CI uses `rustfmt` to check code formatting. Before submitting a
PR be sure to run the following and check for lint issues:

```bash
cargo +stable fmt --all -- --check
Copy link
Member

@andygrove andygrove Dec 16, 2020

Choose a reason for hiding this comment

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

do we still need the +stable flag?

Copy link
Member

@andygrove andygrove Dec 16, 2020

Choose a reason for hiding this comment

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

nm, I suppose people using simd will still be using nightly.

Expand Down
7 changes: 4 additions & 3 deletions rust/arrow/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@

[![Coverage Status](https://coveralls.io/repos/github/apache/arrow/badge.svg)](https://coveralls.io/github/apache/arrow)

This crate contains a native Rust implementation of the [Arrow columnar format](https://arrow.apache.org/docs/format/Columnar.html). It uses nightly Rust.
This crate contains a native Rust implementation of the [Arrow columnar format](https://arrow.apache.org/docs/format/Columnar.html).

## Developer's guide

Expand Down Expand Up @@ -88,8 +88,9 @@ The above script will run the `flatc` compiler and perform some adjustments to t
Arrow uses the following features:

* `simd` - Arrow uses the [packed_simd](https://crates.io/crates/packed_simd) crate to optimize many of the
implementations in the [compute](https://github.com/apache/arrow/tree/master/rust/arrow/src/compute) module using SIMD
intrinsics. These optimizations are turned *off* by default.
implementations in the [compute](https://github.com/apache/arrow/tree/master/rust/arrow/src/compute)
module using SIMD intrinsics. These optimizations are turned *off* by default.
If the `simd` feature is enabled, an unstable version of Rust is required (we test with `nightly-2020-11-24`)
* `flight` which contains useful functions to convert between the Flight wire format and Arrow data
* `prettyprint` which is a utility for printing record batches

Expand Down
4 changes: 0 additions & 4 deletions rust/parquet/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -68,10 +68,6 @@ version is available. Then simply update version of `parquet-format` crate in Ca
- [ ] Parquet format 2.5 support

## Requirements
- Rust nightly

See [Working with nightly Rust](https://github.com/rust-lang-nursery/rustup.rs/blob/master/README.md#working-with-nightly-rust)
to install nightly toolchain and set it as default.

Parquet requires LLVM. Our windows CI image includes LLVM but to build the libraries locally windows
users will have to install LLVM. Follow [this](https://github.com/appveyor/ci/issues/2651) link for info.
Expand Down