opendev/gerrit
Code Issues Proposed changes

documentation: Fix rulec documentation entry

Browse Source 
Change-Id: Ia6261a67d1ca67c01420c823e825ba226e0c7733
This commit is contained in:
Shawn O. Pearce
2011-06-20 18:43:56 -07:00
parent 02630e708c
commit 82ad96a766
2 changed files with 19 additions and 13 deletions
Download Patch File Download Diff File Expand all files Collapse all files

30
Documentation/pgm-rulec.txt
View File

@@ -3,31 +3,34 @@ rulec
NAME
----
rulec - Compiles prolog rules into jar files
rulec - Compile project-specific Prolog rules to JARs
SYNOPSIS
--------
[verse]
'java' -jar gerrit.war 'rulec' -d <SITE_PATH> --name <PROJECT_NAME>
'java' -jar gerrit.war 'rulec' -d <SITE_PATH> [--all | <PROJECT>...]
DESCRIPTION
-----------
Looks for a prolog rule file named rules.pl in the repository in the
refs/meta/config branch. If it exists, creates a jar file named
rules-`$sha1_of_rules.pl`.jar in `$site_path`/cache/rules. Caching needs
to be enabled on the server.
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 libaries and log files.
--name::
Number of threads to perform the scan work with. Defaults to
twice the number of CPUs available.
--all::
Compile rules for all projects.
--quiet::
Suppress non-error output messages.
<PROJECT>:
Compile rules for the specified project.
CONTEXT
-------
@@ -35,12 +38,15 @@ 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 create a jar file for test/project:
To compile a rule JAR file for test/project:
====
$ java -jar gerrit.war rulec -d site_path --name test/project
$ java -jar gerrit.war rulec -d site_path test/project
====
GERRIT