8129eced3a
There were several different notations used for NOTE and IMPORTANT sections that sometimes didn't even render correctly. Change-Id: I744cb0922f4bb4c99282984a487761f2c1bd6d4a Signed-off-by: Michael Ochmann <michael.ochmann@sap.com>
63 lines
1.4 KiB
Plaintext
63 lines
1.4 KiB
Plaintext
= gerrit apropos
|
|
|
|
== NAME
|
|
gerrit apropos - Search Gerrit documentation index
|
|
|
|
== SYNOPSIS
|
|
[verse]
|
|
--
|
|
_ssh_ -p <port> <host> _gerrit apropos_
|
|
<query>
|
|
--
|
|
|
|
== DESCRIPTION
|
|
Queries the documentation index and returns results with the title and URL
|
|
from the matched documents.
|
|
|
|
== ACCESS
|
|
Any user who has configured an SSH key.
|
|
|
|
== SCRIPTING
|
|
This command is intended to be used in scripts.
|
|
|
|
[NOTE]
|
|
This feature is only available if documentation index was built.
|
|
|
|
== EXAMPLES
|
|
|
|
----
|
|
$ ssh -p 29418 review.example.com gerrit apropos capabilities
|
|
|
|
Gerrit Code Review - /config/ REST API:
|
|
http://localhost:8080/Documentation/rest-api-config.html
|
|
|
|
Gerrit Code Review - /accounts/ REST API:
|
|
http://localhost:8080/Documentation/rest-api-accounts.html
|
|
|
|
Gerrit Code Review - Project Configuration File Format:
|
|
http://localhost:8080/Documentation/config-project-config.html
|
|
|
|
Gerrit Code Review - Access Controls:
|
|
http://localhost:8080/Documentation/access-control.html
|
|
|
|
Gerrit Code Review - Plugin Development:
|
|
http://localhost:8080/Documentation/dev-plugins.html
|
|
|
|
Gerrit Code Review - REST API:
|
|
http://localhost:8080/Documentation/rest-api.html
|
|
|
|
Gerrit Code Review - /access/ REST API:
|
|
http://localhost:8080/Documentation/rest-api-access.html
|
|
----
|
|
|
|
== SEE ALSO
|
|
|
|
* link:access-control.html[Access Controls]
|
|
|
|
GERRIT
|
|
------
|
|
Part of link:index.html[Gerrit Code Review]
|
|
|
|
SEARCHBOX
|
|
---------
|