build/docs/cppeclipse.rst

Tue, 06 Jan 2015 21:39:09 +0100

author
Michael Schloh von Bennewitz <michael@schloh.com>
date
Tue, 06 Jan 2015 21:39:09 +0100
branch
TOR_BUG_9701
changeset 8
97036ab72558
permissions
-rw-r--r--

Conditionally force memory storage according to privacy.thirdparty.isolate;
This solves Tor bug #9701, complying with disk avoidance documented in
https://www.torproject.org/projects/torbrowser/design/#disk-avoidance.

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

mercurial