Mirrors/servo
1
0
Fork 0
mirror of https://github.com/servo/servo.git synced 2025-07-23 07:13:52 +01:00
Code Issues Projects Releases Packages Wiki Activity

update "Working on a Crate" in HACKING_QUICKSTART

Browse source
This commit is contained in:
Gregory Terzian 2016-12-23 18:48:08 +01:00 • committed by Gregory
parent dd2aa4195a
commit 44e808b5cf
1 changed files with 18 additions and 9 deletions
Download patch file Download diff file Expand all files Collapse all files

27
docs/HACKING_QUICKSTART.md
View file

@ -108,20 +108,29 @@ This is how my projects are laid out:
``` ```
~/my-projects/servo/ ~/my-projects/servo/
~/my-projects/cocoa-rs/ ~/my-projects/mozjs/
~/my-projects/glutin/ ```
Both folder are git repositories.
To make it so that servo uses `~/my-projects/mozjs/`, first ascertain which version of the crate Servo is using and whether it is a git dependency or one from crates.io.
Both information can be found using, in this example, `/mach cargo pkgid mozjs_sys`(`mozjs_sys` is the actual crate name, which doesn't necessarily match the repo folder name).
If the output is in the format `https://github.com/servo/mozjs#mozjs_sys:0.0.0`, you are dealing with a git dependency and you will have to edit the `~/my-projects/servo/Cargo.toml` file and add at the bottom:
``` toml
[replace]
"https://github.com/servo/mozjs#mozjs_sys:0.0.0" = { path = '../mozjs' }
``` ```
These are all git repositories. If the output is in the format `https://github.com/rust-lang/crates.io-index#mozjs_sys#0.0.0`, you are dealing with a crates.io dependency and you will have to edit the `~/my-projects/servo/Cargo.toml` in the following way:
To make it so that servo uses `~/my-projects/cocoa-rs/` and `~/my-projects/glutin/` , create a `~/my-projects/servo/.cargo/config` file: ``` toml
[replace]
``` shell "mozjs_sys:0.0.0" = { path = '../mozjs' }
$ cat ~/my-projects/servo/.cargo/config
paths = ['../glutin', '../cocoa-rs']
``` ```
This will tell any cargo project to not use the online version of the dependency, but your local clone. Both will tell any cargo project to not use the online version of the dependency, but your local clone.
For more details about overriding dependencies, see [Cargo's documentation](http://doc.crates.io/specifying-dependencies.html#overriding-dependencies). For more details about overriding dependencies, see [Cargo's documentation](http://doc.crates.io/specifying-dependencies.html#overriding-dependencies).