diff options
Diffstat (limited to 'devtools/shared/platform/README.md')
| -rw-r--r-- | devtools/shared/platform/README.md | 13 |
1 files changed, 13 insertions, 0 deletions
diff --git a/devtools/shared/platform/README.md b/devtools/shared/platform/README.md new file mode 100644 index 0000000000..84accd4954 --- /dev/null +++ b/devtools/shared/platform/README.md @@ -0,0 +1,13 @@ +This directory is treated specially by the loaders. + +In particular, when running in chrome, a resource like +"devtools/shared/platform/mumble" will be found in the chrome +subdirectory; and when running in content, it will be found in the +content subdirectory. + +Outside of tests, it's not ok to require a specific version of a file; +and there is an eslint test to check for that. That is, +require("devtools/shared/platform/client/mumble") is an error. + +When adding a new file, you must add two copies, one to chrome and one +to content. Otherwise, one case or the other will fail to work. |