Skip to content

Update README.md to reflect the current situation #366

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

Merged
merged 1 commit into from
Dec 28, 2016

Conversation

upsuper
Copy link
Contributor

@upsuper upsuper commented Dec 28, 2016

There are several changes:

  • Announce that Clang 3.9 is the new default
  • Update the install steps for 3.9
  • Add installing steps for Windows
  • Update stylo's usage of bindgen

Copy link
Contributor

@wafflespeanut wafflespeanut left a comment

Choose a reason for hiding this comment

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

Some nits 😄

The current generator runs on with clang 3.8, but can also run with clang 3.9
with more features (such as detection of inlined functions).
It is recommended to use clang 3.9 with the current generator. It can run with
clang 3.8 with some features unavailable.
Copy link
Contributor

Choose a reason for hiding this comment

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

Nit: "It can run with clang-3.8 with some features disabled"

# Library usage with `build.rs`

See [the Stylo build script][stylo-script] to see how is it used inside the
Copy link
Contributor

Choose a reason for hiding this comment

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

Nit: "... how it is ..."

```

To build with Clang 3.8, you need to append `--feature llvm_stable` in addition
Copy link
Contributor

Choose a reason for hiding this comment

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

--features?

options might exist (see [the SpiderMonkey script][sm-script] and [the Stylo
scripts][stylo-scripts] to see how is it used inside the Servo organisation.
options might exist (see [the SpiderMonkey script][sm-script] to see how is
it used inside the Servo organisation.
Copy link
Contributor

Choose a reason for hiding this comment

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

Nit: "... how it is ..."

$ LIBCLANG_PATH=path/to/clang-3.9/build/lib \
LD_LIBRARY_PATH=path/to/clang-3.9/build/lib \
cargo build
$ export LIBCLANG_PATH=path/to/clang-3.9/lib
Copy link
Contributor

Choose a reason for hiding this comment

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

Not sure whether leaving LD_LIBRARY_PATH will have an effect (cc @emilio)

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Hmm, per description in clang-sys's README, it seems we would still need LD_LIBRARY_PATH.

```

#### From source
Copy link
Contributor

Choose a reason for hiding this comment

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

Wouldn't hurt to have a note saying that people can also build it from source.

Copy link
Contributor

@emilio emilio left a comment

Choose a reason for hiding this comment

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

The rest looks fine to me. r=me with that addressed :)

```

To build with Clang 3.8, you need to append `--feature llvm_stable` in addition
Copy link
Contributor

Choose a reason for hiding this comment

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

This is not needed anymore, it's the same for any version of clang since we load it dinamically and check for symbols.

This feature is only needed for testing now, so feel free to remove this section.

@emilio
Copy link
Contributor

emilio commented Dec 28, 2016

@bors-servo delegate+

@bors-servo
Copy link

✌️ @upsuper can now approve this pull request

There are several changes:
* Announce that Clang 3.9 is the new default
* Update the install steps for 3.9
* Add installing steps for Windows
* Update stylo's usage of bindgen
@upsuper
Copy link
Contributor Author

upsuper commented Dec 28, 2016

@bors-servo r=emilio

@bors-servo
Copy link

📌 Commit a65e825 has been approved by emilio

@bors-servo
Copy link

⌛ Testing commit a65e825 with merge d49bae2...

bors-servo pushed a commit that referenced this pull request Dec 28, 2016
Update README.md to reflect the current situation

There are several changes:
* Announce that Clang 3.9 is the new default
* Update the install steps for 3.9
* Add installing steps for Windows
* Update stylo's usage of bindgen
@bors-servo
Copy link

☀️ Test successful - status-travis

@bors-servo bors-servo merged commit a65e825 into rust-lang:master Dec 28, 2016
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants