gerrit/Documentation/pgm-rulec.txt
Michael Ochmann a843461b18 Some more broken synopsis formattings in documentation
Same exercise as in change 79311 but now for the pgm commands.
Fixed some syntax expressions that did not match the list of command
options and harmonized the indentation.

Change-Id: Ieec06ea87ecbc8cda467f58d514e2f29993ba46e
Signed-off-by: Michael Ochmann <michael.ochmann@sap.com>
2016-07-08 13:47:29 +02:00

56 lines
1.1 KiB
Plaintext

= rulec
== NAME
rulec - Compile project-specific Prolog rules to JARs
== SYNOPSIS
[verse]
--
_java_ -jar gerrit.war _rulec_
-d <SITE_PATH>
[--quiet]
[--all | <PROJECT>...]
--
== DESCRIPTION
Looks for a Prolog rule file named `rules.pl` on the repository's
`refs/meta/config` branch. If rules.pl exists, creates a JAR file
named `rules-'SHA1'.jar` in `'$site_path'/cache/rules`.
== OPTIONS
-d::
--site-path::
Location of the gerrit.config file, and all other per-site
configuration data, supporting libraries and log files.
--all::
Compile rules for all projects.
--quiet::
Suppress non-error output messages.
<PROJECT>:
Compile rules for the specified project.
== CONTEXT
This command can only be run on a server which has direct
connectivity to the metadata database, and local access to the
managed Git repositories.
Caching needs to be enabled. See
link:config-gerrit.html#cache.directory[cache.directory].
== EXAMPLES
To compile a rule JAR file for test/project:
----
$ java -jar gerrit.war rulec -d site_path test/project
----
GERRIT
------
Part of link:index.html[Gerrit Code Review]
SEARCHBOX
---------