gerrit/Documentation/pgm-rulec.txt
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

52 lines
1.1 KiB
Plaintext

= rulec
== NAME
rulec - Compile project-specific Prolog rules to JARs
== SYNOPSIS
--
'java' -jar gerrit.war 'rulec' -d <SITE_PATH> [--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
---------