Taewoo Kim has submitted this change and it was merged. Change subject: Update the dev-setup document to reflect recent changes - removed incubator string - revised instruction to import asterixdb only ......................................................................
Update the dev-setup document to reflect recent changes - removed incubator string - revised instruction to import asterixdb only Change-Id: Iebee0da98ec4a7bc1a6e404293ae56bbb4390555 Reviewed-on: https://asterix-gerrit.ics.uci.edu/983 Reviewed-by: Till Westmann <[email protected]> --- M content/dev-setup.html M dev-setup.md 2 files changed, 37 insertions(+), 54 deletions(-) Approvals: Till Westmann: Looks good to me, approved diff --git a/content/dev-setup.html b/content/dev-setup.html index 57a8e68..0112075 100644 --- a/content/dev-setup.html +++ b/content/dev-setup.html @@ -167,45 +167,27 @@ <ol> <li> - <p>Check out Hyracks and Asterix master in two folders via git in the command line. Assume that the path is <code>$HOME/workspace</code>.</p> + <p>Check out AsterixDB master in one folder via git in the command line. Assume that the path is <code>$HOME/workspace</code>.</p> - <pre><code> git clone https://github.com/apache/incubator-asterixdb/ - git clone https://github.com/apache/incubator-asterixdb-hyracks/ + <pre><code> git clone https://github.com/apache/asterixdb/ </code></pre> - <p>You will now have <code>$HOME/workspace/incubator-asterixdb/</code> and <code>$HOME/workspace/incubator-asterixdb-hyracks/</code>.</p> + <p>You will now have <code>$HOME/workspace/asterixdb/</code>.</p> </li> <li> - <p>Go to the hyracks and install it’s artifacts to the local Maven repository by executing the following commands:</p> + <p>Go to the asterixdb folder and install it’s artifacts to the local Maven repository by executing the following commands:</p> - <pre><code> cd incubator-asterixdb-hyracks/ + <pre><code> cd asterixdb/ mvn install -DskipTests </code></pre> </li> - <li> - <p>Go to the asterixdb folder and perform the same action:</p> - - <pre><code> cd ../incubator-asterixdb/asterix-maven-plugins/ - mvn install -DskipTests - cd ../ - mvn install -DskipTests -</code></pre> - </li> - <li>In Eclipse, import hyracks as an existing Maven Project. + <li>In Eclipse, import asterixdb as an existing Maven Project. <ul> <li><code>File -> Import -> Maven -> Existing Maven Projects -> Next</code></li> - <li>Specify the Root directory as <code>incubator-asterixdb-hyracks</code> and then click Next until Finish is enabled.</li> + <li>Specify the Root directory as <code>asterixdb</code> and then click Next until Finish is enabled.</li> <li>If Eclipse tries to install the <code>m2e</code> (Maven To Eclipse) connector, let it do so.</li> <li>There might be some plugin errors; however, that is not a big deal. Wait until the job finishes.</li> - <li>Then, click Finish.</li> - </ul> - </li> - <li>Then import asterixdb as an existing Maven Project. - <ul> - <li><code>File -> Import -> Maven -> Existing Maven Projects -> Next</code></li> - <li>Specify root directory as <code>$HOME/workspace/asterixdb</code> and then click Next until Finish is enabled.</li> - <li>Eclipse may try installing <code>m2e</code> or other plugins again; let it do so.</li> - <li>Then, click Finish.</li> + <li>Then, click Finish. Restart Eclipse if asked to do so.</li> </ul> </li> <li>Fix Eclipse’s build path to include compile-time generated sources. @@ -213,12 +195,13 @@ <li>Right click the project where a red X mark is shown(e.g. <code>asterix-algebra</code>. Then resolve by applying the following: <ul> <li>Right click asterix-algebra. Click Build Path and Configure Build Path. Click Add Folder.</li> - <li>Under the <code>target -> generated sources</code>, check the parent folder of the <code>edu</code> folder and click OK.</li> + <li>Under the <code>target -> generated sources</code>, check the parent folder of the <code>org</code> folder and click OK.</li> <li>For example, if the directory structure is “target - generated-sources - javacc - org - apache …”, check the javacc directory and click OK. Then X mark will dissapear.</li> </ul> </li> <li>Repeat this step to all projects which show a red X mark except “asterix-fuzzyjoin” and “asterix-transactions”.</li> - <li>It may be the case that only “asterix-algebra” and “asterix-runtime” will require these steps.</li> + <li>It may be the case that only “asterix-algebra” and “asterix-external-data” will require these steps.</li> + <li>If you see “plugin execution not covered by lifecycle configuration” errors such as this one - “Plugin execution not covered by lifecycle configuration: org.apache.asterix:asterix-test-datagenerator-maven-plugin:0.8.9-SNAPSHOT:generate-testdata (execution: replace-template-data, phase: process-test-resources)”, try to resolve it using the quick fix feature. You can call this feature by right click on the error and select “quick fix”. And then choose “Mark goal generate-testdata as ignored in Eclipse build in Eclipse preferences”.</li> </ul> </li> <li>Set up Eclipse code formatting rules @@ -234,6 +217,13 @@ </li> </ul> </li> + <li> + <p>Lastly, go to the asterixdb folder and execute following command again. This is required since Eclipse might have cleaned the projects and rebuilt the them without creating all necessary classes. Currently, some of the class files can be only built using mvn command.</p> + + <pre><code> cd asterixdb/ + mvn install -DskipTests +</code></pre> + </li> </ol> <hr /> diff --git a/dev-setup.md b/dev-setup.md index d7680f4..14badc9 100644 --- a/dev-setup.md +++ b/dev-setup.md @@ -39,47 +39,35 @@ ### Steps -1. Check out Hyracks and Asterix master in two folders via git in the command line. Assume that the path is `$HOME/workspace`. +1. Check out AsterixDB master in one folder via git in the command line. Assume that the path is `$HOME/workspace`. - git clone https://github.com/apache/incubator-asterixdb/ - git clone https://github.com/apache/incubator-asterixdb-hyracks/ + git clone https://github.com/apache/asterixdb/ - You will now have `$HOME/workspace/incubator-asterixdb/` and `$HOME/workspace/incubator-asterixdb-hyracks/`. + You will now have `$HOME/workspace/asterixdb/`. -2. Go to the hyracks and install it's artifacts to the local Maven repository by executing the following commands: +2. Go to the asterixdb folder and install it's artifacts to the local Maven repository by executing the following commands: - cd incubator-asterixdb-hyracks/ + cd asterixdb/ mvn install -DskipTests - -3. Go to the asterixdb folder and perform the same action: - - cd ../incubator-asterixdb/asterix-maven-plugins/ - mvn install -DskipTests - cd ../ - mvn install -DskipTests - -4. In Eclipse, import hyracks as an existing Maven Project. +3. In Eclipse, import asterixdb as an existing Maven Project. * `File -> Import -> Maven -> Existing Maven Projects -> Next` -* Specify the Root directory as `incubator-asterixdb-hyracks` and then click Next until Finish is enabled. +* Specify the Root directory as `asterixdb` and then click Next until Finish is enabled. * If Eclipse tries to install the `m2e` (Maven To Eclipse) connector, let it do so. * There might be some plugin errors; however, that is not a big deal. Wait until the job finishes. -* Then, click Finish. +* Then, click Finish. Restart Eclipse if asked to do so. -5. Then import asterixdb as an existing Maven Project. -* `File -> Import -> Maven -> Existing Maven Projects -> Next` -* Specify root directory as `$HOME/workspace/asterixdb` and then click Next until Finish is enabled. -* Eclipse may try installing `m2e` or other plugins again; let it do so. -* Then, click Finish. -6. Fix Eclipse's build path to include compile-time generated sources. +4. Fix Eclipse's build path to include compile-time generated sources. * Right click the project where a red X mark is shown(e.g. `asterix-algebra`. Then resolve by applying the following: * Right click asterix-algebra. Click Build Path and Configure Build Path. Click Add Folder. - * Under the `target -> generated sources`, check the parent folder of the `edu` folder and click OK. + * Under the `target -> generated sources`, check the parent folder of the `org` folder and click OK. * For example, if the directory structure is "target - generated-sources - javacc - org - apache ...", check the javacc directory and click OK. Then X mark will dissapear. * Repeat this step to all projects which show a red X mark except "asterix-fuzzyjoin" and "asterix-transactions". -* It may be the case that only "asterix-algebra" and "asterix-runtime" will require these steps. -7. Set up Eclipse code formatting rules +* It may be the case that only "asterix-algebra" and "asterix-external-data" will require these steps. +* If you see "plugin execution not covered by lifecycle configuration" errors such as this one - "Plugin execution not covered by lifecycle configuration: org.apache.asterix:asterix-test-datagenerator-maven-plugin:0.8.9-SNAPSHOT:generate-testdata (execution: replace-template-data, phase: process-test-resources)", try to resolve it using the quick fix feature. You can call this feature by right click on the error and select "quick fix". And then choose "Mark goal generate-testdata as ignored in Eclipse build in Eclipse preferences". + +5. Set up Eclipse code formatting rules * Download files [AsterixCodeFormatProfile.xml](https://cwiki.apache.org/confluence/download/attachments/61322291/AsterixCodeFormatProfile.xml) [AsterixCleanupFormatProfile.xml](https://cwiki.apache.org/confluence/download/attachments/61322291/AsterixCleanupFormatProfile.xml) * Import profiles into Eclipse @@ -87,6 +75,11 @@ * Preferences -> Java -> Code style -> Clean up -> Import -> Select AsterixCleanupFormatProfile.xml * Preferences -> Java -> Editor -> Save actions -> Perform the selected action on save -> Format source code +6. Lastly, go to the asterixdb folder and execute following command again. This is required since Eclipse might have cleaned the projects and rebuilt the them without creating all necessary classes. Currently, some of the class files can be only built using mvn command. + + cd asterixdb/ + mvn install -DskipTests + --- ## Signing Up for Gerrit -- To view, visit https://asterix-gerrit.ics.uci.edu/983 To unsubscribe, visit https://asterix-gerrit.ics.uci.edu/settings Gerrit-MessageType: merged Gerrit-Change-Id: Iebee0da98ec4a7bc1a6e404293ae56bbb4390555 Gerrit-PatchSet: 3 Gerrit-Project: incubator-asterixdb-site Gerrit-Branch: asf-site Gerrit-Owner: Taewoo Kim <[email protected]> Gerrit-Reviewer: Jenkins <[email protected]> Gerrit-Reviewer: Taewoo Kim <[email protected]> Gerrit-Reviewer: Till Westmann <[email protected]>
