tizen_src/README.md

   1 ## Introduction
   2
   3 chromium-efl is a Chromium/Blink engine port to tizen/efl platform. The port
   4 implements Chromium/Blink platform APIs.
   5
   6 It also exposes a webview API implementation based on chromium-efl port. It is
   7 supposed to be completely source and binary compatible with EFL-WebKit2.
   8
   9 ## Details
  10
  11 1. gclient pulls chromium-efl into "src/tizen_src".
  12 2. The it runs 2 hooks in order to get the rest of the source:
  13
  14 ```
  15 * generate-gclient-efl: .gclient-efl is created by running
  16   src/tizen_src/scripts/generate_gclient-efl.py (this is a fork
  17   of the same script in crosswalk repository).
  18 * fetch-deps: It actually fetches all depedencies based on .gclient-efl.
  19 ```
  20
  21 ## Procedure
  22
  23 1. Auto-generate gclient's configuration file (.gclient):
  24
  25 ```
  26 gclient config --name=src/tizen_src ssh://165.213.202.130:29418/webplatform/chromium-efl@beta/m42_2214_t
  27 ```
  28
  29 2. gclient sync
  30
  31 ## Building
  32
  33 * For Desktop build
  34
  35     $ ./build/build_desktop.sh [-h|--help] [--skip-gyp] [--skip-ninja] [--ccache] [--debug]
  36
  37 * For Mobile build
  38
  39     $ build/build_mobile.sh [--clean] [--debug] [--skip-gyp] [--skip-ninja] [--define 'nodebug 1']
  40                             [--rpmlint] [--ccache] [--gbs-debug]
  41
  42       [--define '_debug_mode 1'] or [--debug]       perform debug build (default : release)
  43       [--define '_skip_gyp 1'] or [--skip-gyp]      skip gyp generation (default : gyp generate)
  44       [--define '_skip_ninja 1'] or [--skip-ninja]  skip ninja execution (default : ninja executes)
  45       [--define 'nodebug 1']                        omit creation of debug packages
  46                                                     (default: build debug packages too)
  47                                                     Note: To let binaries to be recreated without debug symbols,
  48                                                     this should be preceded by removing build directory.
  49       [--rpmlint]                                   Enabling rpmlint on tizen v3.0
  50                                                     Note: By default, it is disabled.
  51       [--ccache]                                    see ### Using ccache inside gbs
  52       [--gbs-debug]                                 Run gbs in debug mode
  53
  54 * For TV build
  55
  56     $ build/build_tv.sh [--clean] [--debug] [--skip-gyp] [--skip-ninja] [--define 'nodebug 1']
  57                         [--rpmlint] [--ccache] [--gbs-debug]
  58
  59       [--define '_debug_mode 1'] or [--debug]       perform debug build (default : release)
  60       [--define '_skip_gyp 1'] or [--skip-gyp]      skip gyp generation  (default : gyp generate)
  61       [--define '_skip_ninja 1'] or [--skip-ninja]  skip ninja execution (default : ninja executes)
  62       [--define 'nodebug 1']                        omit creation of debug packages
  63                                                     (default: build debug packages too)
  64                                                     Note: To let binaries to be recreated without debug symbols,
  65                                                     this should be preceded by removing build directory.
  66       [--rpmlint]                                   Enabling rpmlint on tizen v3.0
  67                                                     Note: By default, it is disabled.
  68       [--ccache]                                    see ### Using ccache inside gbs
  69       [--gbs-debug]                                 Run gbs in debug mode
  70
  71
  72 * For Emulator build
  73
  74     $ build/build_emulator.sh mobile/tv [--clean] [--debug] [--skip-gyp] [--skip-ninja]
  75                                         [--define 'nodebug 1'] [--ccache] [--gbs-debug]
  76
  77       [--define '_debug_mode 1'] or [--debug]       perform debug build (default : release)
  78       [--define '_skip_gyp 1'] or [--skip-gyp]      skip gyp generation  (default : gyp generate)
  79       [--define '_skip_ninja 1'] or [--skip-ninja]  skip ninja execution (default : ninja executes)
  80       [--define 'nodebug 1']                        omit creation of debug packages
  81                                                     (default: build debug packages too)
  82                                                     Note: To let binaries to be recreated without debug symbols,
  83                                                     this should be preceded by removing build directory.
  84       [--ccache]                                    see ### Using ccache inside gbs
  85       [--gbs-debug]                                 Run gbs in debug mode
  86
  87 ## Using ccache inside gbs
  88
  89 To use ccache for faster full builds use --ccache parameter:
  90 gbs build --ccache ...
  91
  92 Prerequisites:
  93 * 10GB free space
  94
  95 ccache directory will be created with profile and architecture prefix e.g:
  96 out.mobile.arm.ccache
  97
  98 ## Coding style
  99
 100 Internally we use the chromium coding style: http://www.chromium.org/developers/coding-style.
 101 For public headers we follow efl style.
 102
 103 ## License
 104
 105 Chromium-efl's code uses the BSD license, see our `LICENSE` file.