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

Links to deprecated Rust documentation in HACKING_QUICKSTART.md #23088

Closed
tdelacour opened this issue Mar 24, 2019 · 3 comments
Closed

Links to deprecated Rust documentation in HACKING_QUICKSTART.md #23088

tdelacour opened this issue Mar 24, 2019 · 3 comments

Comments

@tdelacour
Copy link
Contributor

@tdelacour tdelacour commented Mar 24, 2019

I was reading through HACKING_QUICKSTART.md today while trying to get my dev environment set up. I noticed in this section, the links to "match" and "pattern" both link to the deprecated "first edition" Rust book.

Not sure if this ought to be another issue, but I also spent some time stuck getting servo to build for the first time before discovering that I needed to run this: export PKG_CONFIG_PATH="/usr/local/opt/libffi/lib/pkgconfig", which isn't mentioned in the README.md. I'm not sure how particular that is to my experience, but it does seem like pkg-config on OSX does not know how to find libffi by default, and the servo build script requires this to work in order to check the version of gstreamer.

I'd actually really appreciate it if this issue was assigned to me, if that's alright, as I am just starting here and I think it would be a solid way to get acquainted with the PR process for servo. Thanks!

@paulrouget
Copy link
Contributor

@paulrouget paulrouget commented Mar 25, 2019

Go ahead and submit a PR to fix the link in HACKING_QUICKSTART.

Not sure if this ought to be another issue, but I also spent some time stuck getting servo to build for the first time before discovering that I needed to run this: export PKG_CONFIG_PATH="/usr/local/opt/libffi/lib/pkgconfig"

Probably better to file another issue to investigate why you have to do that.

@paulrouget
Copy link
Contributor

@paulrouget paulrouget commented Mar 25, 2019

@tdelacour
Copy link
Contributor Author

@tdelacour tdelacour commented Mar 25, 2019

@paulrouget aha ok yeah those issues do seem to be the same. Must've not searched very well first...

Will address the links later today. Thanks!

bors-servo added a commit that referenced this issue Mar 25, 2019
ISSUE-23088: updated deprecated links in HACKING_QUICKSTART

Replaced two links in `HACKING_QUICKSTART.md`: "match" now points to the rust-by-example match page and "patterns" points to the rust book 2.0 overview of structural pattern matching.

---
<!-- Thank you for contributing to Servo! Please replace each `[ ]` by `[X]` when the step is complete, and replace `___` with appropriate data: -->
- [x] `./mach build -d` does not report any errors
- [X] `./mach test-tidy` does not report any errors
- [X] These changes fix #23088

<!-- Either: -->
- [ ] There are tests for these changes OR
- [X] These changes do not require tests because they represent docs changes only

<!-- Also, please make sure that "Allow edits from maintainers" checkbox is checked, so that we can help you if you get stuck somewhere along the way.-->

<!-- Pull requests that do not address these steps are welcome, but they will require additional verification as part of the review process. -->

<!-- Reviewable:start -->
---
This change is [<img src="https://reviewable.io/review_button.svg" height="34" align="absmiddle" alt="Reviewable"/>](https://reviewable.io/reviews/servo/servo/23092)
<!-- Reviewable:end -->
bors-servo added a commit that referenced this issue Mar 26, 2019
ISSUE-23088: updated deprecated links in HACKING_QUICKSTART

Replaced two links in `HACKING_QUICKSTART.md`: "match" now points to the rust-by-example match page and "patterns" points to the rust book 2.0 overview of structural pattern matching.

---
<!-- Thank you for contributing to Servo! Please replace each `[ ]` by `[X]` when the step is complete, and replace `___` with appropriate data: -->
- [x] `./mach build -d` does not report any errors
- [X] `./mach test-tidy` does not report any errors
- [X] These changes fix #23088

<!-- Either: -->
- [ ] There are tests for these changes OR
- [X] These changes do not require tests because they represent docs changes only

<!-- Also, please make sure that "Allow edits from maintainers" checkbox is checked, so that we can help you if you get stuck somewhere along the way.-->

<!-- Pull requests that do not address these steps are welcome, but they will require additional verification as part of the review process. -->

<!-- Reviewable:start -->
---
This change is [<img src="https://reviewable.io/review_button.svg" height="34" align="absmiddle" alt="Reviewable"/>](https://reviewable.io/reviews/servo/servo/23092)
<!-- Reviewable:end -->
bors-servo added a commit that referenced this issue Mar 27, 2019
ISSUE-23088: updated deprecated links in HACKING_QUICKSTART

Replaced two links in `HACKING_QUICKSTART.md`: "match" now points to the rust-by-example match page and "patterns" points to the rust book 2.0 overview of structural pattern matching.

---
<!-- Thank you for contributing to Servo! Please replace each `[ ]` by `[X]` when the step is complete, and replace `___` with appropriate data: -->
- [x] `./mach build -d` does not report any errors
- [X] `./mach test-tidy` does not report any errors
- [X] These changes fix #23088

<!-- Either: -->
- [ ] There are tests for these changes OR
- [X] These changes do not require tests because they represent docs changes only

<!-- Also, please make sure that "Allow edits from maintainers" checkbox is checked, so that we can help you if you get stuck somewhere along the way.-->

<!-- Pull requests that do not address these steps are welcome, but they will require additional verification as part of the review process. -->

<!-- Reviewable:start -->
---
This change is [<img src="https://reviewable.io/review_button.svg" height="34" align="absmiddle" alt="Reviewable"/>](https://reviewable.io/reviews/servo/servo/23092)
<!-- Reviewable:end -->
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Linked pull requests

Successfully merging a pull request may close this issue.

2 participants
You can’t perform that action at this time.