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
60 lines
1.4 KiB
Plaintext
60 lines
1.4 KiB
Plaintext
= gerrit apropos
|
|
|
|
== NAME
|
|
gerrit apropos - Search Gerrit documentation index
|
|
|
|
== SYNOPSIS
|
|
--
|
|
'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
|
|
---------
|