* 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
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
* 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
* 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
* 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
* 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
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
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
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
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
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
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
This aligns the delta betwe ../ and ~/ in the documentation to ensure
the location is consistent in the READMEs
Change-Id: I23f7cf5da7290eee11c5612cfe9160a0a17855e4
ReviewDb is gone, hence gsql is no longer needed.
Change-Id: I580b9ec9943fdedac4814d3f66c030ba4534fc30
Signed-off-by: Edwin Kempin <ekempin@google.com>
The --recursive option is an alias of --recurse-submodules, and
git's autocompletion will select --recurse-submodules rather than
--recursive.
Change-Id: I5aab184cbcdeffb14bf3e82363936299daddde27
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
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
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
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
Gerrit installation doc says required java version is 1.7, making
this doc consistant with the installation doc.
Change-Id: I82ae0177c0fb779cb5ef858e22f30e39f755c819
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
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
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
* 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
"\--" 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
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
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>
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
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