Give some more guidance around import-w3c-tests #27
Conversation
Make it clearer how to checkout web-platform-tests/wpt locally and how to use -s.
|
Still no description in the pull request 🥺. The comment looks better 😀. |
|
Oh sorry, I updated the commit message. I didn't realize we use the PR OP for something. Made that match the commit message body now. |
| @@ -19,3 +19,5 @@ If you have the upstream WPT repository locally you can skip redownloading it by | |||
| ``` | |||
| Tools/Scripts/import-w3c-tests web-platorm-tests/folder_to_import_here -l -s path_to_web_platform_tests | |||
| ``` | |||
|
|
|||
| Important: your checkout of WPT needs to be in a directory named `web-platform-tests` and the path passed to `-s` should not include that directory. I.e., if your checkout is at `~/web-platform-tests` you pass `-s ~`. `import-w3c-tests` will unfortunately not complain if you got this wrong. | |||
There was a problem hiding this comment.
Maybe:
| Important: your checkout of WPT needs to be in a directory named `web-platform-tests` and the path passed to `-s` should not include that directory. I.e., if your checkout is at `~/web-platform-tests` you pass `-s ~`. `import-w3c-tests` will unfortunately not complain if you got this wrong. | |
| **Important**: your checkout of WPT needs to be in a directory named `web-platform-tests` and the path passed to `-s` should not include that directory. I.e., if your checkout is at `~/web-platform-tests` you pass `-s ~`. `import-w3c-tests`. Unfortunately `import-w3c-tests` does not currently report an error if it can't find the path. |
We should file a bug on WebKit itself to fix this... like, locally my folder is "~/dev/wpt" and I really would prefer not to rename it to "web-platform-tests".
There was a problem hiding this comment.
You Only to do it once, and can get it to that name when you first clone. Maybe that should be in the instructions on how to clone instead
There was a problem hiding this comment.
I get that, but when you clone directly from WPT it's also called "wpt" unless you explicitly alias it (i.e., this a webkit-ism... and not so great if you are just doing general "web work" or standards stuff)... maybe we should be asking for to create a symlink?
There was a problem hiding this comment.
I support filing a bug on that to get that changed. It's indeed annoying.
|
Here is the old doc with info related to this https://trac.webkit.org/wiki/WebKitW3CTesting but not sure if is still 100% up-to-date. Maybe there is some info from there that is worth adding here |
Make it clearer how to checkout web-platform-tests/wpt locally and how to use -s.