Author: lewismc
Date: Wed Jan 28 17:56:08 2015
New Revision: 1655409
URL: http://svn.apache.org/r1655409
Log:
GORA-404 Missing doc page for some modules
Added:
gora/site/trunk/content/current/compiler-cli.md
- copied, changed from r1655403,
gora/site/trunk/content/current/compiler.md
Copied: gora/site/trunk/content/current/compiler-cli.md (from r1655403,
gora/site/trunk/content/current/compiler.md)
URL:
http://svn.apache.org/viewvc/gora/site/trunk/content/current/compiler-cli.md?p2=gora/site/trunk/content/current/compiler-cli.md&p1=gora/site/trunk/content/current/compiler.md&r1=1655403&r2=1655409&rev=1655409&view=diff
==============================================================================
--- gora/site/trunk/content/current/compiler.md (original)
+++ gora/site/trunk/content/current/compiler-cli.md Wed Jan 28 17:56:08 2015
@@ -1,54 +1,32 @@
-Title: Gora Compiler Overview
+Title: Gora Compiler-CLI Overview
# Introduction
-The Gora compiler converts JSON files (the schema(s)) into persistent Java
classes/data beans.
-You can then use those classes to interact with a variety of data storage
software e.g. the Gora datastore implementations.
+The Gora compiler-cli is a simple utility dependency which provides a command
line interface used to invoke the [Gora Compiler](./compiler.html)
+It exists separate from the Gora Compiler enabling us to distinguish between
usability and functionality. It does however depend upon the Gora Compiler.
-The compiler is very simple to run. But first you should add the Gora
installation directory to your path.
+The compiler-cli is trivial to invoke but also provides a useful usage
statement when invoked incorrectly
# Usage
- $ bin/gora goracompiler
+ $ Usage: GoraCompilerCLI
+ or
+ $ Uage: GoraCompilerCLI -h
results in:
- $ Usage: GoraCompiler <schema file> <output dir> [-license <id>]
- <schema file> - individual avsc file to be compiled or a directory
path containing avsc files
- <output dir> - output directory for generated Java files
- [-license <id>] - the preferred license header to add to the
- generated Java file. Current options include;
- ASLv2 (Apache Software License v2.0)
- AGPLv3 (GNU Affero General Public License)
- CDDLv1 (Common Development and Distribution License v1.0)
- FDLv13 (GNU Free Documentation License v1.3)
- GPLv1 (GNU General Public License v1.0)
- GPLv2 (GNU General Public License v2.0)
- GPLv3 (GNU General Public License v3.0)
- LGPLv21 (GNU Lesser General Public License v2.1)
- LGPLv3 (GNU Lesser General Public License v2.1)
-
-so for example, one would typically enter:
-
- $ bin/gora goracompiler gora-tutorial/src/main/avro/pageview.json
gora-tutorial/src/main/java/
-
-
-The schema file is a single JSON file or a directory containing JSON files.
-
-The output directory is the destination for the generated Java source files.
For example, if you specific src/main/java then the
-generate source is placed into src/main/java/generated. It's generally a good
idea to ignore the generate directory in whatever
-version control software you're using. You are using version control, right?
-
-Finally, the license parameter tells the compile to add a license header to
each generated file. Current header options include:
-
-* ASLv2 (<a href="http://www.apache.org/licenses/LICENSE-2.0.html";>Apache
Software License v2.0</a>)
-* AGPLv3 (<a href="http://www.gnu.org/licenses/agpl.html";>GNU Affero General
Public License</a>)
-* CDDLv1 (<a href="http://opensource.org/licenses/CDDL-1.0";>Common
Development and Distribution License v1.0</a>)
-* FDLv13 (<a href-"http://www.gnu.org/copyleft/fdl.html";>GNU Free
Documentation License v1.3</a>)
-* GPLv1 (<a href="http://www.gnu.org/licenses/gpl-1.0.html";>GNU General
Public License v1.0</a>)
-* GPLv2 (<a href="http://www.gnu.org/licenses/gpl-2.0.html";>GNU General
Public License v2.0</a>)
-* GPLv3 (<a href="http://www.gnu.org/licenses/gpl-3.0.html";>GNU General
Public License v3.0</a>)
-* LGPLv21 (<a href="http://www.gnu.org/licenses/lgpl-2.1.html";>GNU Lesser
General Public License v2.1</a>)
-* LGPLv3 (<a href="http://www.gnu.org/licenses/lgpl-3.0.html";>GNU Lesser
General Public License v3</a>)
+ $ Usage: gora-compiler ( -h | --help ) | (<input> [<input>...] <output>)
+
+so for example, if you wished to compile one schema file, you could enter:
+
+ $ bin/gora gora-compiler gora-tutorial/src/main/avro/pageview.json
gora-tutorial/src/main/java/
+
+if however for example you wished to compile more than one schema file, you
could enter:
+
+ $ bin/gora gora-compiler gora-tutorial/src/main/avro/pageview.json
gora-core/src/examples/avro/webpage.json
gora-tutorial/src/main/avro/metricdatum.json gora-tutorial/src/main/java/
+
+The schema file is a single JSON file or a string array of JSON files.
+
+The output directory is the destination for the generated Java source files.
For example, if you specific <code>src/main/java</code> then the
+generate source is placed into <code>src/main/java/</code> under the package
naming convention used within the JSON schema.
-It should be noted that if no license header argument is passed, by default
the ASLv2 license profile is selected.
