Sylvestre Ledru
df0583fb15
Convert build/docs/*.rst (top-level and mozbuild/) to MyST-flavored
Markdown.
- Keep build/docs/mozbuild-symbols.rst as RST. The mozbuildsymbols
custom directive emits nodes that confuse autosectionlabel when
wrapped in a MyST eval-rst block.
- Keep build/docs/supported-configurations.rst as RST so that
docs/contributing/build/supported.md can continue to use the MyST
{include} directive on the original source.
- Refresh allowed-warnings globs to match the .md filenames for
code-quality, contributing, crash-reporting, gtest, jsloader, js,
overview, setup, and js/build.
Differential Revision: https://phabricator.services.mozilla.com/D304226
53 lines
1.7 KiB
Markdown
53 lines
1.7 KiB
Markdown
(build-cppeclipse)=
|
|
|
|
# Cpp Eclipse Projects
|
|
|
|
For additional information on using Eclipse CDT see
|
|
[the MDN page](https://developer.mozilla.org/en-US/docs/Eclipse_CDT).
|
|
|
|
The build system contains alpha support for generating C++ Eclipse
|
|
project files to aid with development.
|
|
|
|
Please report bugs to bugzilla and make them depend on bug 973770.
|
|
|
|
To generate a C++ Eclipse project files, you'll need to have a fully
|
|
built tree:
|
|
|
|
```
|
|
mach build
|
|
```
|
|
|
|
Then, simply generate the C++ Eclipse build backend:
|
|
|
|
```
|
|
mach build-backend -b CppEclipse
|
|
```
|
|
|
|
If all goes well, the path to the generated workspace should be
|
|
printed.
|
|
|
|
To use the generated C++ Eclipse project files, you'll need to
|
|
have a Eclipse CDT 8.3 (We plan to follow the latest Eclipse release)
|
|
[Eclipse CDT plugin](https://www.eclipse.org/cdt/)
|
|
installed. You can then import all the projects into Eclipse using
|
|
*File > Import ... > General > Existing Projects into Workspace*
|
|
-only- if you have not ran the background indexer.
|
|
|
|
## Updating Project Files
|
|
|
|
As you pull and update the source tree, your C++ Eclipse files may
|
|
fall out of sync with the build configuration. The tree should still
|
|
build fine from within Eclipse, but source files may be missing and in
|
|
rare circumstances Eclipse's index may not have the proper build
|
|
configuration.
|
|
|
|
To account for this, you'll want to periodically regenerate the
|
|
C++ Eclipse project files. You can do this by running `mach build
|
|
&& mach build-backend -b CppEclipse` from the
|
|
command line.
|
|
|
|
Currently, regeneration rewrites the original project files. **If
|
|
you've made any customizations to the projects, they will likely get
|
|
overwritten.** We would like to improve this user experience in the
|
|
future.
|