1.. _build_cppeclipse:
2
3=====================
4Cpp Eclipse Projects
5=====================
6
7For additional information on using Eclipse CDT see
8`the MDN page
9<https://developer.mozilla.org/en-US/docs/Eclipse_CDT>`_.
10
11The build system contains alpha support for generating C++ Eclipse
12project files to aid with development.
13
14Please report bugs to bugzilla and make them depend on bug 973770.
15
16To generate a C++ Eclipse project files, you'll need to have a fully
17built tree::
18
19   mach build
20
21Then, simply generate the C++ Eclipse build backend::
22
23   mach build-backend -b CppEclipse
24
25If all goes well, the path to the generated workspace should be
26printed.
27
28To use the generated C++ Eclipse project files, you'll need to
29have a Eclipse CDT 8.3 (We plan to follow the latest Eclipse release)
30`Eclipse CDT plugin
31<https://www.eclipse.org/cdt/>`_
32installed. You can then import all the projects into Eclipse using
33*File > Import ... > General > Existing Projects into Workspace*
34-only- if you have not ran the background indexer.
35
36Updating Project Files
37======================
38
39As you pull and update the source tree, your C++ Eclipse files may
40fall out of sync with the build configuration. The tree should still
41build fine from within Eclipse, but source files may be missing and in
42rare circumstances Eclipse's index may not have the proper build
43configuration.
44
45To account for this, you'll want to periodically regenerate the
46C++ Eclipse project files. You can do this by running ``mach build
47&& mach build-backend -b CppEclipse`` from the
48command line.
49
50Currently, regeneration rewrites the original project files. **If
51you've made any customizations to the projects, they will likely get
52overwritten.** We would like to improve this user experience in the
53future.
54
55