87 Commits

Author SHA1 Message Date
David Pursehouse
4655c8eb12 Merge branch 'stable-3.1'
* stable-3.1:
  Update git submodules
  Update git submodules
  gr-rest-api-interface.js: Remove unnecesary Promise resolution
  LuceneQueryChangesTest: Remove unneeded override of visible()
  e2e-tests: Rename the now reused json filename constant
  e2e-tests: Refactor documentation about functional
  RevisionActions: Do not alter server response
  e2e-tests: Move core json files into scala package
  e2e-tests: Support adding/running non-core scenarios
  e2e-tests: Add create/delete project to CloneUsingBothProtocols
  ChangeQueryBuilder: Throw error on ambiguous visibleto by display name

Change-Id: Idbb499461ecad11da49b3bcbe5d5bf14e90bfe31
2020-03-24 08:38:25 +09:00
Marco Miller
0ca836a583 e2e-tests: Refactor documentation about functional
Add functional e2e testing information to the documentation, alongside
the previous load-only text. Clarify the Gerrit test scopes along the
way, thus how to cover them in this newly emerging e2e test framework
context. Refactor the related documentation paragraphs to support this.

Change-Id: Ic20c5c8f96d0aaa3fb568c282b1d5ef77167627f
2020-03-20 11:52:52 -04:00
David Pursehouse
8d9c8a8e9d Merge branch 'stable-3.1'
* stable-3.1:
  Improve log if VersionedMetaData fails to update
  Documentation: Fix e2e tests Input section's nits
  Documentation: Fix e2e tests Setup link and typos
  Documentation: Un-hardcode the Scala version used
  Documentation: Add e2e tests link from dev-readme

Change-Id: Ibd7ed96b611f95a1b54e7bc692c123ec43255d9d
2020-01-30 15:11:45 +09:00
Marco Miller
8364d8d9f3 Documentation: Add e2e tests link from dev-readme
Change-Id: Ibaf8023c31b472c3ade4ea0bb0d3df5a74eab356
2020-01-29 14:27:30 -05:00
David Pursehouse
bfe2d146e1 Merge branch 'stable-3.1'
* stable-3.1:
  Replace documentation of gerrit.ui with gerrit.enableGwtUi
  Use the environment variables provided by the GerritCodeReview-plugin
  DeleteZombieCommentsRefsTest: Open RevWalk in try-with-resource
  Documentation: Mention unused_deps with buildifier
  Bazel: Remove bazel version check
  Documentation: Recommend Bazelisk to launch bazel
  Add a pgm to delete dead draft comments refs

Change-Id: I78758c7168b7374b491413dcc7f130df3d9dfd58
2020-01-29 18:12:11 +09:00
David Pursehouse
68668101c4 Merge branch 'stable-3.0' into stable-3.1
* stable-3.0:
  Replace documentation of gerrit.ui with gerrit.enableGwtUi
  Use the environment variables provided by the GerritCodeReview-plugin
  DeleteZombieCommentsRefsTest: Open RevWalk in try-with-resource
  Documentation: Mention unused_deps with buildifier
  Bazel: Remove bazel version check
  Documentation: Recommend Bazelisk to launch bazel
  Add a pgm to delete dead draft comments refs

Change-Id: Id41fb58c7ccb95c152d6af28bbd84ba26a594610
2020-01-29 16:02:49 +09:00
David Pursehouse
3947bc5b81 Merge branch 'stable-2.16' into stable-3.0
* stable-2.16:
  Use the environment variables provided by the GerritCodeReview-plugin
  DeleteZombieCommentsRefsTest: Open RevWalk in try-with-resource
  Documentation: Mention unused_deps with buildifier
  Bazel: Remove bazel version check
  Documentation: Recommend Bazelisk to launch bazel
  Add a pgm to delete dead draft comments refs

Change-Id: I7ce0b91695a99cbfc630ba5fd69ba1cf20e84f7a
2020-01-29 08:19:37 +09:00
Marco Miller
9bede91ce3 Documentation: Recommend Bazelisk to launch bazel
Change-Id: Ic9dfd80fe7eadd1c52f3c0cac0d78e61654dd34c
2020-01-27 17:38:45 -05:00
Marian Harbach
ebeb15460c Enabling linkattrs explicitly on doc pages having external links
Asciidoc may fail to render link attributes for external links
supposed to open in a new window correctly. This change adds
:linkattrs: to the beginning of such files to force parsing link
attributes correctly.

Bug: Issue 12068
Change-Id: If18be60de646ff78f672239dd4fa435fd4fd92ab
2019-12-13 10:59:57 +00:00
Marian Harbach
34253376e6 Make all external links in the documentation open in a new window
To make it easier to stay on track when reading documentation, I
added ",role=external,window=_blank" to all links in the
documentation directory that were not pointing at another piece of documentation.

Change-Id: I94bf254c90f8ebce067c765be0a2932b755a045a
2019-12-10 22:54:40 +01:00
Edwin Kempin
ef1b811d6d Start a separate documentation page for core plugins
Core plugins are described as part of the plugin config documentation.
The purpose of the plugin config documentation is to give an overview of
all plugins and which functionality they provide. Defining what core
plugins are doesn't really fit into this page. A separate documentation
page for core plugins makes sense since we intend to expand this
documentation. We want to define more clearly what a core plugin is,
what criteria a plugin must fulfill to become a core plugin and
processes around core plugins. All this newly planned documentation
around core plugins is surely out of scope for the plugin config
documentation, hence we want to have a new page for this.

Signed-off-by: Edwin Kempin <ekempin@google.com>
Change-Id: If6f1867cd4ec0a5843080e094cb397c30af99db8
2019-10-29 12:49:09 +01:00
Joerg Zieren
937d5451a7 Describe HTTP access to local server
Change-Id: Ie5888b58fdf2de48cef35434ab39ce7f66f2eab2
2019-05-17 17:00:48 +02:00
Alice Kober-Sotzek
79290dc0a0 More closely link docs for frontend/backend developer setup
There's no reason to enforce a strong separation of the developer docs
for frontend and backend developers. On the contrary, there are some
steps for both of them which are always mandatory. Hence, move one step
in the direction of removing a strong separation between them.

Change-Id: Iefafec0d6d3cb7e2ee1606322f7e73a95a6731cf
2019-05-09 12:22:14 +02:00
Alice Kober-Sotzek
a8029b6a07 Improve structure of docs about developer setup
There didn't seem to be an apparent reason why the setup instructions
were arranged in the way they were. Hence, logically group them (e.g.
put instructions about the test site together) and arrange them in a way
that a new developer (no matter whether focused on frontend or backend)
can follow them from top to bottom.

The instructions for Bazel also included a formatting issue. Instead of
headlines, anchors were created out of context. Fix this while touching
that part of the docs.

Change-Id: Iea8251c858e01697d24f01f138459c8e6fb64579
2019-05-09 12:22:14 +02:00
Ben Rohlfs
b65406ba11 Use $GERRIT_SITE var for referencing to gerrit_testsite
Change 222679 tried to make this consistent by changing "sometimes ~/
and sometimes ../" to "always ~/", but ../ is the preferred way for
developers and ~/ for the quick start. So let's use the $GERRIT_SITE
variable everywhere instead and define it to ~/. The variable can
easily be changed to ../.

Change-Id: I2fc4ac8aa4374f25ed2679b85dcb17b80e8cffc4
2019-05-06 09:32:50 +00:00
Joerg Zieren
ed45a28dd9 Fix typo in developer docs
Change-Id: I9d58ba8b52296395dee3db92afbbda39df6dec5f
2019-05-03 11:54:53 +02:00
Ben Rohlfs
0f007177fa Update frontend developer documentation
Change-Id: I1d8c36b5150605fc82bf466a52e3a727e3c8385b
2019-05-02 12:03:58 +02:00
Sam Saccone
fa20a3ef41 Update instructions to mirror quickstart location.
This aligns the delta betwe ../ and ~/ in the documentation to ensure
the location is consistent in the READMEs

Change-Id: I23f7cf5da7290eee11c5612cfe9160a0a17855e4
2019-04-30 10:08:52 -07:00
brohlfs
bdcea6d31f Add a note to developer docs about adding the SSH key
Change-Id: I2950f5023688f30877e4dbb3280e00f4b80218fd
2019-01-22 17:32:02 +01:00
Edwin Kempin
0f595f671d Remove gsql SSH command and program
ReviewDb is gone, hence gsql is no longer needed.

Change-Id: I580b9ec9943fdedac4814d3f66c030ba4534fc30
Signed-off-by: Edwin Kempin <ekempin@google.com>
2018-12-10 10:42:14 -08:00
David Pursehouse
b964ac1fba Update documentation to use --recurse-submodules instead of --recursive
The --recursive option is an alias of --recurse-submodules, and
git's autocompletion will select --recurse-submodules rather than
--recursive.

Change-Id: I5aab184cbcdeffb14bf3e82363936299daddde27
2018-10-12 14:08:45 +09:00
Janet Davies
0c1a621540 Copy edits to dev-readme.txt, install.txt, and linux-quickstart.txt
Change-Id: Ifdd4cee178a70f216bfae5106d1ef92fad7d32d1
2018-05-31 19:49:48 +00:00
David Pursehouse
7845019dbf Replace links to code.google.com/p/gerrit
Google Code was shut down nearly 2 years ago [1] and the links
don't work any more. Replace them with the new locations.

[1] https://opensource.googleblog.com/2015/03/farewell-to-google-code.html

Change-Id: I53e791d04eb243483d69254a296c30e59a7de479
2018-02-02 10:13:45 +09:00
Alice Kober-Sotzek
485a5ffa9d Add description for debugging a remote Gerrit server
Change-Id: I46cbeea6ac768c16ea629c46ae5f40c08b2e9e1d
2017-03-03 10:12:14 +01:00
David Ostrovsky
fdbfcad77d Remove Buck based build
Bug: Issue 5302
Change-Id: I6e860446ef30ff0ad1c7c49fc0e39d39d921820b
2017-01-23 12:44:58 +00:00
Han-Wen Nienhuys
0c93bc8335 dev-readme.txt: Suggest to use --console-log
Change-Id: Id691aa1fe0845eb3878bedb2be065e8eb575102c
2017-01-19 15:26:42 +01:00
Alice Kober-Sotzek
d9da89f527 Provide detailed documentation for using IntelliJ
Change-Id: I4a37a270d9a10694daad6a26756dd0e81d591c54
2016-11-25 12:02:18 +01:00
Alice Kober-Sotzek
4b92e0410e Integrate the Bazel documentation
Change-Id: I670adee676e5adfae7d4400b3d5789f6e17ae0af
2016-11-25 11:28:53 +01:00
Aaron Gable
5eab720da3 Add more detail to the dev-readme doc
Most of this comes from my discussion with andybons while
trying to get set up for the first time. I figured it should
be written down somewhere helpful.

Change-Id: I0e400c61581ea1001ada33711291a154abc01b87
2016-10-12 11:24:06 -07:00
David Ostrovsky
f377aa96de Update buck to the latest version
This version includes a lot of new features and improvements,
including:

* Switched to top-down-building, which should generally make builds
  faster. The old behavior can be bypassed by passing --deep on the
  command line [1]

* New query command was added (inspired by Bazel) [2]

* Performance improvement in file globbing

Extend tools/eclipse/project.py to pass the --deep option to ask Buck
to execute bottom-up build when generating the Eclipse project. This is
needed otherwise after using the buck clean command only the gerrit.war
file would be fetched from the cache and the buck-out/gen/lib folder
would remain empty.

With [3] genrule output is now namespaced with the genrule name. Adapt
documentation and references in the code to the new location of Buck
artifacts. Because of this change, `buck clean` must be issued after
Buck upgrade, otherwise the build would fail. The same prolem exists
when switching between branches: `buck clean` must be issued, otherwise
the build would fail.

Test plan:

* buck build release
* buck build api_install
* buck test
* install and verify new gerrit site
* upgrade and verify existing gerrit site
* reindex existing gerrit site
* verify that tools/eclipse/project.py produces sane Eclipse project
* verify that unit test execution from Eclipse works
* verify that daemon started from Eclipse works
* verify that GWT SDM debug session started from Eclipe works

[1] 217cec33bc
[2] https://buckbuild.com/command/query.html
[3] c92ef212b5

Change-Id: Ib3f22e70b7cb9eb9349618f2bcc018bf799c40f8
2015-10-09 08:51:35 +02:00
Marco Miller
e7790b297b Add doc for directories to likely mark so that IDEA project can compile
Using IntelliJ IDEA shows that one needs to mark some buck-out/
annotation directories as Generated Sources Root, in order for the
Gerrit project to compile. That can be done through the Project view
contextual menu, upon selecting each directory. Directories to mark are
listed by this changed developer doc.

Change-Id: I03fe7cb21fa251656130a5a90079ed77703f60cb
2015-03-17 01:50:46 +00:00
David Pursehouse
0bb63c0e56 Remove paragraph about GWT DETAILED from developer documentation
The DETAILED style was supported in the Maven build, which was
removed a couple of releases ago.

Remove it from the documentation.

Change-Id: Ide0955e10a517d9f58cecbb3c6495de2e701d350
2014-12-19 14:33:35 +09:00
David Pursehouse
9bdeb8ccd1 Remove obsolete "Release Builds" section from dev-readme.txt
The release.sh script has been removed, so this section is no longer
relevant.  Remove it.

Change-Id: I8e687b4f173530a7271eba4a02ea6e03c8ebb410
2014-12-19 14:33:35 +09:00
Urs Wolfer
c0948bda6c Add hint how to use IntelliJ IDEA for Gerrit development
Change-Id: I4a8b6fbf432d253189c0ca5c5d7b8730871e2712
2014-04-27 21:16:25 +02:00
Khai Do
ea9e4b7916 update doc for MAC OS X to use the required Java version
Gerrit installation doc says required java version is 1.7, making
this doc consistant with the installation doc.

Change-Id: I82ae0177c0fb779cb5ef858e22f30e39f755c819
2014-04-07 08:31:41 -07:00
Yuxuan 'fishy' Wang
61698b14e0 Use the new section title style in Asciidoctor.
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
2013-12-20 12:55:51 -08:00
David Pursehouse
9db23781da Use consistent test site locations in documentation and debug configs
The naming of the test site is inconsistent in the documentation.  Some
parts refer to `gerrit_testsite` while other parts, and the default
debug configurations, refer to `test_site`.

Update the documentation and debug configs to use `gerrit_testsite`.

Change-Id: I5b1fb5c9dcc6c9a39e7d95e88d4e0ea9df384b09
2013-12-17 19:36:24 +09:00
David Pursehouse
d106c8eda3 Document that submodules must be updated after switching branches
Switching between master and stable-2.8 with `git checkout` will
break the build if the submodules are not also updated.

Mention this in the documentation.

Change-Id: Id850172b9e23c9c7b9d4d73aea82daf136679166
2013-12-13 15:03:02 +09:00
David Pursehouse
28e5237c19 Merge branch 'stable-2.8'
* stable-2.8:
  Replace "\--" with "--" in documentation.
  Warn in 2.8 rel. notes that ChangeScreen2 needs download-commands plugin
  Add warning about removal of `approve` alias to 2.8 release notes
  Add one more fix in the 2.8 release notes
  Update 2.8 release notes with changes from stable-2.6 and stable-2.7
  Update 2.8.1 release notes with recently merged changes
  Fix ArrayIndexOutOfBoundsException on initial commits
  SideBySide2: Map .py files to text/x-python
  SideBySide2: Map *.cxx and *.hxx to clike CodeMirror mode
  Enable syntax coloring for Go, BUCK and .gitmodules

Conflicts:
	Documentation/pgm-daemon.txt
	Documentation/pgm-init.txt
	gerrit-server/src/main/java/com/google/gerrit/server/DefaultFileExtensionRegistry.java

Change-Id: I05c5d47c72d2a5fb524a0622b57ba607fed3bfe3
2013-12-10 17:57:46 +09:00
Yuxuan 'fishy' Wang
77e1508a0d Replace "\--" with "--" in documentation.
"\--" in the documentation was for asciidoc, in which "--"s won't work.
Asciidoctor doesn't have such a problem and will output "\--" verbatim.

Change-Id: I41419b037a10bd830f660d7295aea0d442504229
2013-12-10 16:40:50 +09:00
Yuxuan 'fishy' Wang
99cb68dec4 Added searchbox to documentation.
This provides the entry point of the documentation search feature.

Change-Id: Iea2b707995c0e042829db509927384dcec7aaf43
2013-11-05 12:49:43 -08:00
Marcin Cieślak
ed612fb44a Introduce Gerrit Inspector: interactive Jython shell
Adds "-s" option to com.google.gerrit.pgm.Daemon to start an interactive
Jython shell for inspection and troubleshooting of live data of the
Gerrit instance.

Gerrit Inspector is an interactive scriptable environment to inspect and
modify internal state of the system. This environment is available on
the system console after the system starts. Leaving the Inspector will
shutdown the Gerrit instance.

The environment allows interactive work as well as running of Python
scripts for troubleshooting. Accessing Java Virtual Machine objects
and calling Java methods is possible.

Gerrit Inspect can be started by adding -s option to the command used to
launch the daemon:

  java -jar buck-out/gen/gerrit.war daemon -d ../test_site -s

For more information on this facility please see:

  Documentation/dev-inspector.txt

Implementation remark:

Jython needs to examine available .jar files on startup. It does so
currently by reading contents of the WAR archive unpacked by GerritLauncher
in the temporary directory. Jython is able to store this information
persistently, but it does not currently work because we unpack WAR
file every time on startup.

Currently no attempt is made to introspect Guice bindings.

Change-Id: I47ffc8383fd50bc6ec12ba31edb6d7d614e97bd5
2013-10-17 18:07:33 -07:00
Edwin Kempin
8baa1be280 Fix path to gerrit war file in developer documentation
The examples in the documentation still contained the old path to the
gerrit war file as it was when the build was done with Maven. Adapt the
examples to the new location of the war file when the build is done
with BUCK.

Change-Id: I45a70c7b45b09706e2aaf8719292f643a96ed521
Signed-off-by: Edwin Kempin <edwin.kempin@sap.com>
2013-06-17 15:44:20 +02:00
David Pursehouse
5d9ef419aa Tidy up formatting in dev-readme
Change-Id: I609201926c1cd930dd1713fbbc2c1e9e3fa8fb41
2013-05-22 13:33:45 +09:00
David Ostrovsky
dcee57212f Delete Maven based build
The Maven build does not work since the introduction of CodeMirror.
Remove the build until to prevent people from trying to use a broken
build process.  If buck is rejected this commit will be reverted, and
we will attempt to fix the Maven build to include CodeMirror.  If buck
is accepted, we just saved time by avoiding a messy Maven change.

Change-Id: I147d8d1741d52f59de1d2ddce8e5e82583990c14
2013-05-21 20:28:56 -07:00
David Pursehouse
6de7ee2044 Add links from dev-{readme,eclipse} to buck compilation documentation
Change-Id: Ie8cfcf89241bfa8cffc8a990c10e12be7e50a61a
2013-05-20 11:08:54 +09:00
David Pursehouse
ed32132015 Move REST API test notes to a separate page
Create a new page "REST API Developers' Notes".  Move the REST API
test guide into it, and break it up into sections.

Later, the REST API design documentation can be added in this new
page.

Change-Id: I2bec508163b38ea36eef64c842ea708d3449faae
2013-05-17 13:53:32 +01:00
David Pursehouse
69d234085f Show how to verify response headers in REST API test documentation
Change-Id: I2405fe8bdcbc352276296dcaeb8ed1c20e8fece3
2013-05-17 18:05:20 +09:00
David Pursehouse
b27dd0ca07 Include example of DELETE request in REST API test documentation
Change-Id: Iffd681a8d0b71ff2fe35c1d6240ba0b1acf61675
2013-05-17 18:05:15 +09:00
David Pursehouse
493067439d Add missing /a/ in REST API testing example
In one of the examples of testing an authenticated REST API, the
URL did not include `/a/`.

Change-Id: I2ef3504fd9ca03155034910fc3892173a820e558
2013-05-17 18:05:15 +09:00