build/docs/cppeclipse.rst

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