diff options
Diffstat (limited to 'docs/setup')
| -rw-r--r-- | docs/setup/common_build_errors.md | 34 | ||||
| -rw-r--r-- | docs/setup/index.rst | 1 | ||||
| -rw-r--r-- | docs/setup/macos_build.rst | 2 |
3 files changed, 36 insertions, 1 deletions
diff --git a/docs/setup/common_build_errors.md b/docs/setup/common_build_errors.md new file mode 100644 index 0000000000..3267c96937 --- /dev/null +++ b/docs/setup/common_build_errors.md @@ -0,0 +1,34 @@ +# Common Build Errors + +When setting up Firefox, you may encounter some other build errors or +warnings that are not fatal. This document is to help you determine +if the error you're running into is a fatal one or not. + +## Watchman unavailable + +This is a warning and can be ignored. +[Watchman is a file watching service](https://facebook.github.io/watchman/) +that can speed up some interactions with Git and Mercurial. + +## VSCode Java extension + +If you happen to have the Java extension installed in VSCode, there's +a chance that the "Problems" tab in the integrated terminal will +display an error about `Cannot run program [...]/mozilla-unified/mach`. +This is because the extension does not know how to parse the mozilla-central +repository and specifically the `mach` command runner. +This will not prevent you from building and running Firefox. + +## ERROR glean_core + +This is a non-fatal error and will not prevent you from building and +running Firefox. You might see this text in the console after running +`./mach run`. The specific text might appear as: +`Error setting metrics feature config: [...]`. + +## Region.sys.mjs + +This is a non-fatal error, this will not prevent you from building and +running Firefox. You might see this text in the console after running +`./mach run` and the specific text might look like: +`console.error: Region.sys.mjs: Error fetching region`. diff --git a/docs/setup/index.rst b/docs/setup/index.rst index eb0c68aa4e..3cd6d3f229 100644 --- a/docs/setup/index.rst +++ b/docs/setup/index.rst @@ -18,6 +18,7 @@ Don't hesitate to look at the :ref:`Firefox Contributors Quick Reference <Firefo macos_build linux_build linux_32bit_build_on_64bit_OS + common_build_errors .. toctree:: :caption: Getting Ready To Contribute diff --git a/docs/setup/macos_build.rst b/docs/setup/macos_build.rst index df3719e648..b4b940af68 100644 --- a/docs/setup/macos_build.rst +++ b/docs/setup/macos_build.rst @@ -127,7 +127,7 @@ To test your changes on another macOS system (or to keep that particular Firefox ./mach package -Copy the resulting ``.dmg`` file from ``obj-*/dist/`` to the target system, then double-click it as usual to find an ``.app`` bundle containing all dependencies. +Copy the resulting ``.dmg`` file from ``obj-*/dist/`` to the target system, then double-click it as usual to find an ``.app`` bundle containing all dependencies. In newer versions of MacOS you will need to sign the package for this to work using :ref:`Signing Local macOS Builds`. Now the fun starts ------------------ |