61698b14e0
We previous use the section title style like: Section level 1 =============== Section level 2 --------------- Which have a problem in Asciidoctor that the number of "="s or "-"s must match the number of characters in the header exactly, as a result it's easy to make mistakes while changing the titles. Asciidoctor provides a better style like: = Section level 1 == Section level 2 So we switched to this style. Also fixed a bug in replace_macros.py, which will not cause any problem in the old style. Change-Id: I811dd7238735d98f662767c17086152cd69aea02
101 lines
3.0 KiB
Plaintext
101 lines
3.0 KiB
Plaintext
= Gerrit Code Review - Eclipse Setup
|
|
|
|
This document is about configuring Gerrit Code Review into an
|
|
Eclipse workspace for development and debugging with GWT.
|
|
|
|
Java 6 or later SDK is also required to run GWT's compiler and
|
|
runtime debugging environment.
|
|
|
|
|
|
[[Formatting]]
|
|
== Code Formatter Settings
|
|
|
|
Import `tools/GoogleFormat.xml` using Window -> Preferences ->
|
|
Java -> Code Style -> Formatter -> Import...
|
|
|
|
This will define the 'Google Format' profile, which the project
|
|
settings prefer when formatting source code.
|
|
|
|
|
|
== Site Initialization
|
|
|
|
Build once on the command line with
|
|
link:dev-buck.html#build[Buck] and then follow
|
|
link:dev-readme.html#init[Site Initialization] in the
|
|
Developer Setup guide to configure a local site for testing.
|
|
|
|
|
|
== Testing
|
|
|
|
=== Running the Daemon
|
|
|
|
Duplicate the existing launch configuration:
|
|
|
|
* Run -> Debug Configurations ...
|
|
* Java Application -> `gerrit_daemon`
|
|
* Right click, Duplicate
|
|
|
|
* Modify the name to be unique.
|
|
|
|
* Switch to Arguments tab.
|
|
* Edit the `-d` program argument flag to match the path used during
|
|
'init'. The template launch configuration resolves to ../gerrit_testsite
|
|
since that is what the documentation recommends.
|
|
|
|
* Switch to Common tab.
|
|
* Change Save as to be Local file.
|
|
* Close the Debug Configurations dialog and save the changes when prompted.
|
|
|
|
|
|
=== Running Hosted Mode
|
|
|
|
Duplicate the existing launch configuration:
|
|
|
|
* Run -> Debug Configurations ...
|
|
* Java Application -> `buck_gwt_debug`
|
|
* Right click, Duplicate
|
|
|
|
* Modify the name to be unique.
|
|
|
|
* Switch to Arguments tab.
|
|
* Edit the `-Dgerrit.site_path=` VM argument to match the path
|
|
used during 'init'. The template launch configuration resolves
|
|
to ../gerrit_testsite since that is what the documentation recommends.
|
|
|
|
* Switch to Common tab.
|
|
* Change Save as to be Local file.
|
|
* Close the Debug Configurations dialog and save the changes when prompted.
|
|
|
|
|
|
[[known-problems]]
|
|
== Known problems
|
|
|
|
* OpenID authentication won't work in hosted mode, so you need to change
|
|
the link:config-gerrit.html#auth.type[auth.type] configuration parameter
|
|
to `DEVELOPMENT_BECOME_ANY_ACCOUNT` to disable OpenID and allow you to
|
|
impersonate whatever account you otherwise would've used.
|
|
|
|
* Error "Cannot create ReviewDb" occurs if the test site is already running.
|
|
Stop the test site with `gerrit.sh stop` before attempting to run hosted mode
|
|
debugging.
|
|
|
|
* Gerrit site doesn't appear, only directory listing is shown. Web toolkit
|
|
developer browser plugin is missing. If there is no warning, that browser
|
|
plugin is missing with the suggestion to install it, you can install the
|
|
right extension for your browser from the following locations:
|
|
+
|
|
https://dl.google.com/dl/gwt/plugins/chrome/gwt-dev-plugin.crx[Chrome]
|
|
+
|
|
link:https://dl.google.com/dl/gwt/plugins/firefox/gwt-dev-plugin.xpi[Firefox]
|
|
+
|
|
link:http://dl.google.com/dl/gwt/plugins/ie/1.0.7263.20091208111100/gwt-dev-plugin.msi[IE]
|
|
+
|
|
https://dl.google.com/dl/gwt/plugins/safari/gwt-dev-plugin.dmg[Safari]
|
|
|
|
GERRIT
|
|
------
|
|
Part of link:index.html[Gerrit Code Review]
|
|
|
|
SEARCHBOX
|
|
---------
|