You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@activemq.apache.org by cl...@apache.org on 2017/09/14 19:53:45 UTC
svn commit: r1018164 [1/8] - in
/websites/production/activemq/content/artemis/docs/latest/hacking-guide: ./
gitbook/ gitbook/fonts/ gitbook/fonts/fontawesome/
gitbook/gitbook-plugin-fontsettings/ gitbook/gitbook-plugin-highlight/
gitbook/gitbook-plugin...
Author: clebertsuconic
Date: Thu Sep 14 19:53:45 2017
New Revision: 1018164
Log:
hacking guide 2.3.0
Added:
websites/production/activemq/content/artemis/docs/latest/hacking-guide/
websites/production/activemq/content/artemis/docs/latest/hacking-guide/book.pdf (with props)
websites/production/activemq/content/artemis/docs/latest/hacking-guide/building.html
websites/production/activemq/content/artemis/docs/latest/hacking-guide/code-coverage-report.html
websites/production/activemq/content/artemis/docs/latest/hacking-guide/code.html
websites/production/activemq/content/artemis/docs/latest/hacking-guide/formatting.html
websites/production/activemq/content/artemis/docs/latest/hacking-guide/gitbook/
websites/production/activemq/content/artemis/docs/latest/hacking-guide/gitbook/fonts/
websites/production/activemq/content/artemis/docs/latest/hacking-guide/gitbook/fonts/fontawesome/
websites/production/activemq/content/artemis/docs/latest/hacking-guide/gitbook/fonts/fontawesome/FontAwesome.otf (with props)
websites/production/activemq/content/artemis/docs/latest/hacking-guide/gitbook/fonts/fontawesome/fontawesome-webfont.eot (with props)
websites/production/activemq/content/artemis/docs/latest/hacking-guide/gitbook/fonts/fontawesome/fontawesome-webfont.svg
websites/production/activemq/content/artemis/docs/latest/hacking-guide/gitbook/fonts/fontawesome/fontawesome-webfont.ttf (with props)
websites/production/activemq/content/artemis/docs/latest/hacking-guide/gitbook/fonts/fontawesome/fontawesome-webfont.woff (with props)
websites/production/activemq/content/artemis/docs/latest/hacking-guide/gitbook/fonts/fontawesome/fontawesome-webfont.woff2 (with props)
websites/production/activemq/content/artemis/docs/latest/hacking-guide/gitbook/gitbook-plugin-fontsettings/
websites/production/activemq/content/artemis/docs/latest/hacking-guide/gitbook/gitbook-plugin-fontsettings/fontsettings.js
websites/production/activemq/content/artemis/docs/latest/hacking-guide/gitbook/gitbook-plugin-fontsettings/website.css
websites/production/activemq/content/artemis/docs/latest/hacking-guide/gitbook/gitbook-plugin-highlight/
websites/production/activemq/content/artemis/docs/latest/hacking-guide/gitbook/gitbook-plugin-highlight/ebook.css
websites/production/activemq/content/artemis/docs/latest/hacking-guide/gitbook/gitbook-plugin-highlight/website.css
websites/production/activemq/content/artemis/docs/latest/hacking-guide/gitbook/gitbook-plugin-lunr/
websites/production/activemq/content/artemis/docs/latest/hacking-guide/gitbook/gitbook-plugin-lunr/lunr.min.js
websites/production/activemq/content/artemis/docs/latest/hacking-guide/gitbook/gitbook-plugin-lunr/search-lunr.js
websites/production/activemq/content/artemis/docs/latest/hacking-guide/gitbook/gitbook-plugin-search/
websites/production/activemq/content/artemis/docs/latest/hacking-guide/gitbook/gitbook-plugin-search/lunr.min.js
websites/production/activemq/content/artemis/docs/latest/hacking-guide/gitbook/gitbook-plugin-search/search-engine.js
websites/production/activemq/content/artemis/docs/latest/hacking-guide/gitbook/gitbook-plugin-search/search.css
websites/production/activemq/content/artemis/docs/latest/hacking-guide/gitbook/gitbook-plugin-search/search.js
websites/production/activemq/content/artemis/docs/latest/hacking-guide/gitbook/gitbook-plugin-sharing/
websites/production/activemq/content/artemis/docs/latest/hacking-guide/gitbook/gitbook-plugin-sharing/buttons.js
websites/production/activemq/content/artemis/docs/latest/hacking-guide/gitbook/gitbook.js
websites/production/activemq/content/artemis/docs/latest/hacking-guide/gitbook/images/
websites/production/activemq/content/artemis/docs/latest/hacking-guide/gitbook/images/apple-touch-icon-precomposed-152.png (with props)
websites/production/activemq/content/artemis/docs/latest/hacking-guide/gitbook/images/favicon.ico (with props)
websites/production/activemq/content/artemis/docs/latest/hacking-guide/gitbook/style.css
websites/production/activemq/content/artemis/docs/latest/hacking-guide/gitbook/theme.js
websites/production/activemq/content/artemis/docs/latest/hacking-guide/history.html
websites/production/activemq/content/artemis/docs/latest/hacking-guide/ide.html
websites/production/activemq/content/artemis/docs/latest/hacking-guide/images/
websites/production/activemq/content/artemis/docs/latest/hacking-guide/images/artemis-logo.png (with props)
websites/production/activemq/content/artemis/docs/latest/hacking-guide/index.html
websites/production/activemq/content/artemis/docs/latest/hacking-guide/maintainers.html
websites/production/activemq/content/artemis/docs/latest/hacking-guide/notice.html
websites/production/activemq/content/artemis/docs/latest/hacking-guide/search_index.json
websites/production/activemq/content/artemis/docs/latest/hacking-guide/tests.html
websites/production/activemq/content/artemis/docs/latest/hacking-guide/validating-releases.html
Added: websites/production/activemq/content/artemis/docs/latest/hacking-guide/book.pdf
==============================================================================
Binary file - no diff available.
Propchange: websites/production/activemq/content/artemis/docs/latest/hacking-guide/book.pdf
------------------------------------------------------------------------------
svn:mime-type = application/octet-stream
Added: websites/production/activemq/content/artemis/docs/latest/hacking-guide/building.html
==============================================================================
--- websites/production/activemq/content/artemis/docs/latest/hacking-guide/building.html (added)
+++ websites/production/activemq/content/artemis/docs/latest/hacking-guide/building.html Thu Sep 14 19:53:45 2017
@@ -0,0 +1,400 @@
+
+<!DOCTYPE HTML>
+<html lang="" >
+ <head>
+ <title>Building · ActiveMQ Artemis Documentation</title>
+ <meta charset="UTF-8">
+ <meta http-equiv="X-UA-Compatible" content="IE=edge" />
+ <meta content="text/html; charset=utf-8" http-equiv="Content-Type">
+ <meta name="description" content="">
+ <meta name="generator" content="GitBook 3.1.1">
+
+
+
+
+ <link rel="stylesheet" href="gitbook/style.css">
+
+
+
+
+ <link rel="stylesheet" href="gitbook/gitbook-plugin-highlight/website.css">
+
+
+
+ <link rel="stylesheet" href="gitbook/gitbook-plugin-search/search.css">
+
+
+
+ <link rel="stylesheet" href="gitbook/gitbook-plugin-fontsettings/website.css">
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ <meta name="HandheldFriendly" content="true"/>
+ <meta name="viewport" content="width=device-width, initial-scale=1, user-scalable=no">
+ <meta name="apple-mobile-web-app-capable" content="yes">
+ <meta name="apple-mobile-web-app-status-bar-style" content="black">
+ <link rel="apple-touch-icon-precomposed" sizes="152x152" href="gitbook/images/apple-touch-icon-precomposed-152.png">
+ <link rel="shortcut icon" href="gitbook/images/favicon.ico" type="image/x-icon">
+
+
+ <link rel="next" href="tests.html" />
+
+
+ <link rel="prev" href="ide.html" />
+
+
+ </head>
+ <body>
+
+<div class="book">
+ <div class="book-summary">
+
+
+<div id="book-search-input" role="search">
+ <input type="text" placeholder="Type to search" />
+</div>
+
+
+ <nav role="navigation">
+
+
+
+<ul class="summary">
+
+
+
+
+
+
+
+
+
+ <li class="chapter " data-level="1.1" data-path="./">
+
+ <a href="./">
+
+
+ Introduction
+
+ </a>
+
+
+
+ </li>
+
+ <li class="chapter " data-level="1.2" data-path="notice.html">
+
+ <a href="notice.html">
+
+
+ Legal Notice
+
+ </a>
+
+
+
+ </li>
+
+ <li class="chapter " data-level="1.3" data-path="code.html">
+
+ <a href="code.html">
+
+
+ Working with the Code
+
+ </a>
+
+
+
+ </li>
+
+ <li class="chapter " data-level="1.4" data-path="ide.html">
+
+ <a href="ide.html">
+
+
+ IDE Integration
+
+ </a>
+
+
+
+ </li>
+
+ <li class="chapter active" data-level="1.5" data-path="building.html">
+
+ <a href="building.html">
+
+
+ Building
+
+ </a>
+
+
+
+ </li>
+
+ <li class="chapter " data-level="1.6" data-path="tests.html">
+
+ <a href="tests.html">
+
+
+ Tests
+
+ </a>
+
+
+
+ </li>
+
+ <li class="chapter " data-level="1.7" data-path="code-coverage-report.html">
+
+ <a href="code-coverage-report.html">
+
+
+ Code coverage report
+
+ </a>
+
+
+
+ </li>
+
+ <li class="chapter " data-level="1.8" data-path="formatting.html">
+
+ <a href="formatting.html">
+
+
+ Code Formatting
+
+ </a>
+
+
+
+ </li>
+
+ <li class="chapter " data-level="1.9" data-path="validating-releases.html">
+
+ <a href="validating-releases.html">
+
+
+ Validating releases
+
+ </a>
+
+
+
+ </li>
+
+ <li class="chapter " data-level="1.10" data-path="maintainers.html">
+
+ <a href="maintainers.html">
+
+
+ Notes for Maintainers
+
+ </a>
+
+
+
+ </li>
+
+ <li class="chapter " data-level="1.11" data-path="history.html">
+
+ <a href="history.html">
+
+
+ History
+
+ </a>
+
+
+
+ </li>
+
+
+
+
+ <li class="divider"></li>
+
+ <li>
+ <a href="https://www.gitbook.com" target="blank" class="gitbook-link">
+ Published with GitBook
+ </a>
+ </li>
+</ul>
+
+
+ </nav>
+
+
+ </div>
+
+ <div class="book-body">
+
+ <div class="body-inner">
+
+
+
+<div class="book-header" role="navigation">
+
+
+ <!-- Title -->
+ <h1>
+ <i class="fa fa-circle-o-notch fa-spin"></i>
+ <a href="." >Building</a>
+ </h1>
+</div>
+
+
+
+
+ <div class="page-wrapper" tabindex="-1" role="main">
+ <div class="page-inner">
+
+<div id="book-search-results">
+ <div class="search-noresults">
+
+ <section class="normal markdown-section">
+
+ <h1 id="building">Building</h1>
+<p>We use Apache Maven to build the code, distribution, etc. and to manage dependencies.</p>
+<p>We use <code>gitbook</code> to build the docs.</p>
+<p>The minimum required Maven version is 3.0.0.</p>
+<p>Note that there are some <a href="https://cwiki.apache.org/confluence/display/MAVEN/Maven+3.x+Compatibility+Notes" target="_blank">compatibility issues with Maven 3.X</a>
+still unsolved. This is specially true for the <a href="https://maven.apache.org/plugins-archives/maven-site-plugin-3.3/maven-3.html" target="_blank">'site' plugin</a>.</p>
+<h2 id="full-release">Full Release</h2>
+<h4 id="upgrading-the-gitbook-version-and-regenerating-the-npm-shrinkwrapjson-file">Upgrading the <code>gitbook</code> version and regenerating the <code>npm-shrinkwrap.json</code> file</h4>
+<p>The full release uses <code>gitbook</code> to build a static website from the documentation. This is automatically installed using
+an <code>NPM</code> plugin and is controlled via a package.json file.</p>
+<p>Install <code>NPM</code> using the instructions below</p>
+<pre><code>cd artemis-website
+alter the `package.json` changing the version
+npm cache clean; rm -rf ./node_modules/ ./node npm-shrinkwrap.json
+npm install --save-dev
+npm shrinkwrap --dev
+</code></pre><p>The new npm-shrinkwrap.json should be written, commit it.</p>
+<h3 id="gitbook">gitbook</h3>
+<p>Artemis will automate the execution and download of npm. But it may be useful to install it on your system. Simply type:</p>
+<pre><code>$ npm install -g gitbook-cli
+</code></pre><p>If you don't have <code>npm</code> installed then you would need to install it first.</p>
+<h4 id="install-npm-on-fedora">Install npm On Fedora</h4>
+<pre><code>$ yum install npm
+</code></pre><h4 id="install-npm-on-fedora-24">Install npm On Fedora 24</h4>
+<p>This is what you should do if you are using Fedora 24+.</p>
+<pre><code>$ dnf install nodejs
+</code></pre><h4 id="install-npm-on-mac-os">Install npm On Mac-OS</h4>
+<p>The easiest way would be through brew <a href="http://brew.sh" target="_blank">brew</a></p>
+<p>You first install brew using the instructions on the <a href="http://brew.sh" target="_blank">brew</a> website.</p>
+<p>After you installed brew you can install npm by:</p>
+<pre><code>brew install npm
+</code></pre><p>To build the full release with documentation, Javadocs, and the full web site:</p>
+<pre><code>$ mvn -Prelease package
+</code></pre><p>To install it to your local maven repo:</p>
+<pre><code>$ mvn -Prelease install
+</code></pre><h2 id="build-the-distribution-without-docs">Build the distribution without docs</h2>
+<p>It is possible to build a distribution without the manuals and Javadocs.
+simply run</p>
+<pre><code>$ mvn package
+</code></pre><h2 id="building-the-docs">Building the docs</h2>
+<p>From either <code>docs/hacking-guide/en</code> or <code>docs/user-manual/en</code> run <code>gitbook build</code> (after you've installed gitbook)</p>
+
+
+ </section>
+
+ </div>
+ <div class="search-results">
+ <div class="has-results">
+
+ <h1 class="search-results-title"><span class='search-results-count'></span> results matching "<span class='search-query'></span>"</h1>
+ <ul class="search-results-list"></ul>
+
+ </div>
+ <div class="no-results">
+
+ <h1 class="search-results-title">No results matching "<span class='search-query'></span>"</h1>
+
+ </div>
+ </div>
+</div>
+
+ </div>
+ </div>
+
+ </div>
+
+
+
+ <a href="ide.html" class="navigation navigation-prev " aria-label="Previous page: IDE Integration">
+ <i class="fa fa-angle-left"></i>
+ </a>
+
+
+ <a href="tests.html" class="navigation navigation-next " aria-label="Next page: Tests">
+ <i class="fa fa-angle-right"></i>
+ </a>
+
+
+
+ </div>
+
+ <script>
+ var gitbook = gitbook || [];
+ gitbook.push(function() {
+ gitbook.page.hasChanged({"page":{"title":"Building","level":"1.5","depth":1,"next":{"title":"Tests","level":"1.6","depth":1,"path":"tests.md","ref":"tests.md","articles":[]},"previous":{"title":"IDE Integration","level":"1.4","depth":1,"path":"ide.md","ref":"ide.md","articles":[]},"dir":"ltr"},"config":{"plugins":[],"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"pluginsConfig":{"highlight":{},"search":{},"lunr":{"maxIndexSize":1000000},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"fontsettings":{"theme":"white","family":"sans","size":2},"theme-default":{"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"showLevel":false
}},"github":"apache/activemq-artemis","theme":"default","githubHost":"https://github.com/","pdf":{"pageNumbers":true,"fontSize":12,"fontFamily":"Arial","paperSize":"a4","chapterMark":"pagebreak","pageBreaksBefore":"/","margin":{"right":62,"left":62,"top":56,"bottom":56}},"structure":{"langs":"LANGS.md","readme":"README.md","glossary":"GLOSSARY.md","summary":"SUMMARY.md"},"variables":{},"title":"ActiveMQ Artemis Documentation","links":{"home":"http://activemq.apache.org/artemis","issues":"https://issues.apache.org/jira/browse/ARTEMIS","contribute":"http://activemq.apache.org/contributing.html"},"gitbook":"3.x.x","description":"ActiveMQ Artemis Hacking Guide"},"file":{"path":"building.md","mtime":"2017-08-02T14:47:17.000Z","type":"markdown"},"gitbook":{"version":"3.1.1","time":"2017-09-14T19:50:29.711Z"},"basePath":".","book":{"language":""}});
+ });
+ </script>
+</div>
+
+
+ <script src="gitbook/gitbook.js"></script>
+ <script src="gitbook/theme.js"></script>
+
+
+ <script src="gitbook/gitbook-plugin-search/search-engine.js"></script>
+
+
+
+ <script src="gitbook/gitbook-plugin-search/search.js"></script>
+
+
+
+ <script src="gitbook/gitbook-plugin-lunr/lunr.min.js"></script>
+
+
+
+ <script src="gitbook/gitbook-plugin-lunr/search-lunr.js"></script>
+
+
+
+ <script src="gitbook/gitbook-plugin-sharing/buttons.js"></script>
+
+
+
+ <script src="gitbook/gitbook-plugin-fontsettings/fontsettings.js"></script>
+
+
+
+ </body>
+</html>
+
Added: websites/production/activemq/content/artemis/docs/latest/hacking-guide/code-coverage-report.html
==============================================================================
--- websites/production/activemq/content/artemis/docs/latest/hacking-guide/code-coverage-report.html (added)
+++ websites/production/activemq/content/artemis/docs/latest/hacking-guide/code-coverage-report.html Thu Sep 14 19:53:45 2017
@@ -0,0 +1,380 @@
+
+<!DOCTYPE HTML>
+<html lang="" >
+ <head>
+ <title>Code coverage report · ActiveMQ Artemis Documentation</title>
+ <meta charset="UTF-8">
+ <meta http-equiv="X-UA-Compatible" content="IE=edge" />
+ <meta content="text/html; charset=utf-8" http-equiv="Content-Type">
+ <meta name="description" content="">
+ <meta name="generator" content="GitBook 3.1.1">
+
+
+
+
+ <link rel="stylesheet" href="gitbook/style.css">
+
+
+
+
+ <link rel="stylesheet" href="gitbook/gitbook-plugin-highlight/website.css">
+
+
+
+ <link rel="stylesheet" href="gitbook/gitbook-plugin-search/search.css">
+
+
+
+ <link rel="stylesheet" href="gitbook/gitbook-plugin-fontsettings/website.css">
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ <meta name="HandheldFriendly" content="true"/>
+ <meta name="viewport" content="width=device-width, initial-scale=1, user-scalable=no">
+ <meta name="apple-mobile-web-app-capable" content="yes">
+ <meta name="apple-mobile-web-app-status-bar-style" content="black">
+ <link rel="apple-touch-icon-precomposed" sizes="152x152" href="gitbook/images/apple-touch-icon-precomposed-152.png">
+ <link rel="shortcut icon" href="gitbook/images/favicon.ico" type="image/x-icon">
+
+
+ <link rel="next" href="formatting.html" />
+
+
+ <link rel="prev" href="tests.html" />
+
+
+ </head>
+ <body>
+
+<div class="book">
+ <div class="book-summary">
+
+
+<div id="book-search-input" role="search">
+ <input type="text" placeholder="Type to search" />
+</div>
+
+
+ <nav role="navigation">
+
+
+
+<ul class="summary">
+
+
+
+
+
+
+
+
+
+ <li class="chapter " data-level="1.1" data-path="./">
+
+ <a href="./">
+
+
+ Introduction
+
+ </a>
+
+
+
+ </li>
+
+ <li class="chapter " data-level="1.2" data-path="notice.html">
+
+ <a href="notice.html">
+
+
+ Legal Notice
+
+ </a>
+
+
+
+ </li>
+
+ <li class="chapter " data-level="1.3" data-path="code.html">
+
+ <a href="code.html">
+
+
+ Working with the Code
+
+ </a>
+
+
+
+ </li>
+
+ <li class="chapter " data-level="1.4" data-path="ide.html">
+
+ <a href="ide.html">
+
+
+ IDE Integration
+
+ </a>
+
+
+
+ </li>
+
+ <li class="chapter " data-level="1.5" data-path="building.html">
+
+ <a href="building.html">
+
+
+ Building
+
+ </a>
+
+
+
+ </li>
+
+ <li class="chapter " data-level="1.6" data-path="tests.html">
+
+ <a href="tests.html">
+
+
+ Tests
+
+ </a>
+
+
+
+ </li>
+
+ <li class="chapter active" data-level="1.7" data-path="code-coverage-report.html">
+
+ <a href="code-coverage-report.html">
+
+
+ Code coverage report
+
+ </a>
+
+
+
+ </li>
+
+ <li class="chapter " data-level="1.8" data-path="formatting.html">
+
+ <a href="formatting.html">
+
+
+ Code Formatting
+
+ </a>
+
+
+
+ </li>
+
+ <li class="chapter " data-level="1.9" data-path="validating-releases.html">
+
+ <a href="validating-releases.html">
+
+
+ Validating releases
+
+ </a>
+
+
+
+ </li>
+
+ <li class="chapter " data-level="1.10" data-path="maintainers.html">
+
+ <a href="maintainers.html">
+
+
+ Notes for Maintainers
+
+ </a>
+
+
+
+ </li>
+
+ <li class="chapter " data-level="1.11" data-path="history.html">
+
+ <a href="history.html">
+
+
+ History
+
+ </a>
+
+
+
+ </li>
+
+
+
+
+ <li class="divider"></li>
+
+ <li>
+ <a href="https://www.gitbook.com" target="blank" class="gitbook-link">
+ Published with GitBook
+ </a>
+ </li>
+</ul>
+
+
+ </nav>
+
+
+ </div>
+
+ <div class="book-body">
+
+ <div class="body-inner">
+
+
+
+<div class="book-header" role="navigation">
+
+
+ <!-- Title -->
+ <h1>
+ <i class="fa fa-circle-o-notch fa-spin"></i>
+ <a href="." >Code coverage report</a>
+ </h1>
+</div>
+
+
+
+
+ <div class="page-wrapper" tabindex="-1" role="main">
+ <div class="page-inner">
+
+<div id="book-search-results">
+ <div class="search-noresults">
+
+ <section class="normal markdown-section">
+
+ <h1 id="code-coverage-report">Code coverage report</h1>
+<h2 id="getting-jacoco-exec-files">Getting JaCoCo exec files</h2>
+<p>Before you can generate code coverage report by JaCoCo tool,
+you need to get data about what lines of code were executed
+during testing. These information are collected by JaCoCo
+agent and stored in JaCoCo exec files. All you need to do
+is run the tests with <code>jacoco</code> maven profile.</p>
+<pre><code>mvn test -Ptests,extra-tests,jacoco
+</code></pre><h2 id="generate-jacoco-reports">Generate JaCoCo reports</h2>
+<pre><code>mvn verify -Pjacoco-generate-report -DskipTests
+</code></pre><p>For generating JaCoCo reports only run the maven build
+with profile <code>jacoco-generate-report</code> as it is shown
+in the example above. After the command was executed,
+in directory <code>target/jacoco-report</code> you can find
+reports in HTML and XML formats.</p>
+<h2 id="merge-jacoco-exec-files-to-one">Merge JaCoCo exec files to one</h2>
+<p>Since ActiveMQ Artemis is divided into several modules,
+exec files are generated for each module separately.
+If you need to merge them together to have all data
+in one place, you can do it by command below.</p>
+<pre><code>mvn jacoco:merge -N -Pjacoco
+</code></pre>
+
+ </section>
+
+ </div>
+ <div class="search-results">
+ <div class="has-results">
+
+ <h1 class="search-results-title"><span class='search-results-count'></span> results matching "<span class='search-query'></span>"</h1>
+ <ul class="search-results-list"></ul>
+
+ </div>
+ <div class="no-results">
+
+ <h1 class="search-results-title">No results matching "<span class='search-query'></span>"</h1>
+
+ </div>
+ </div>
+</div>
+
+ </div>
+ </div>
+
+ </div>
+
+
+
+ <a href="tests.html" class="navigation navigation-prev " aria-label="Previous page: Tests">
+ <i class="fa fa-angle-left"></i>
+ </a>
+
+
+ <a href="formatting.html" class="navigation navigation-next " aria-label="Next page: Code Formatting">
+ <i class="fa fa-angle-right"></i>
+ </a>
+
+
+
+ </div>
+
+ <script>
+ var gitbook = gitbook || [];
+ gitbook.push(function() {
+ gitbook.page.hasChanged({"page":{"title":"Code coverage report","level":"1.7","depth":1,"next":{"title":"Code Formatting","level":"1.8","depth":1,"path":"formatting.md","ref":"formatting.md","articles":[]},"previous":{"title":"Tests","level":"1.6","depth":1,"path":"tests.md","ref":"tests.md","articles":[]},"dir":"ltr"},"config":{"plugins":[],"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"pluginsConfig":{"highlight":{},"search":{},"lunr":{"maxIndexSize":1000000},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"fontsettings":{"theme":"white","family":"sans","size":2},"theme-default":{"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/pri
nt.css"},"showLevel":false}},"github":"apache/activemq-artemis","theme":"default","githubHost":"https://github.com/","pdf":{"pageNumbers":true,"fontSize":12,"fontFamily":"Arial","paperSize":"a4","chapterMark":"pagebreak","pageBreaksBefore":"/","margin":{"right":62,"left":62,"top":56,"bottom":56}},"structure":{"langs":"LANGS.md","readme":"README.md","glossary":"GLOSSARY.md","summary":"SUMMARY.md"},"variables":{},"title":"ActiveMQ Artemis Documentation","links":{"home":"http://activemq.apache.org/artemis","issues":"https://issues.apache.org/jira/browse/ARTEMIS","contribute":"http://activemq.apache.org/contributing.html"},"gitbook":"3.x.x","description":"ActiveMQ Artemis Hacking Guide"},"file":{"path":"code-coverage-report.md","mtime":"2017-09-08T01:26:53.000Z","type":"markdown"},"gitbook":{"version":"3.1.1","time":"2017-09-14T19:50:29.711Z"},"basePath":".","book":{"language":""}});
+ });
+ </script>
+</div>
+
+
+ <script src="gitbook/gitbook.js"></script>
+ <script src="gitbook/theme.js"></script>
+
+
+ <script src="gitbook/gitbook-plugin-search/search-engine.js"></script>
+
+
+
+ <script src="gitbook/gitbook-plugin-search/search.js"></script>
+
+
+
+ <script src="gitbook/gitbook-plugin-lunr/lunr.min.js"></script>
+
+
+
+ <script src="gitbook/gitbook-plugin-lunr/search-lunr.js"></script>
+
+
+
+ <script src="gitbook/gitbook-plugin-sharing/buttons.js"></script>
+
+
+
+ <script src="gitbook/gitbook-plugin-fontsettings/fontsettings.js"></script>
+
+
+
+ </body>
+</html>
+
Added: websites/production/activemq/content/artemis/docs/latest/hacking-guide/code.html
==============================================================================
--- websites/production/activemq/content/artemis/docs/latest/hacking-guide/code.html (added)
+++ websites/production/activemq/content/artemis/docs/latest/hacking-guide/code.html Thu Sep 14 19:53:45 2017
@@ -0,0 +1,505 @@
+
+<!DOCTYPE HTML>
+<html lang="" >
+ <head>
+ <title>Working with the Code · ActiveMQ Artemis Documentation</title>
+ <meta charset="UTF-8">
+ <meta http-equiv="X-UA-Compatible" content="IE=edge" />
+ <meta content="text/html; charset=utf-8" http-equiv="Content-Type">
+ <meta name="description" content="">
+ <meta name="generator" content="GitBook 3.1.1">
+
+
+
+
+ <link rel="stylesheet" href="gitbook/style.css">
+
+
+
+
+ <link rel="stylesheet" href="gitbook/gitbook-plugin-highlight/website.css">
+
+
+
+ <link rel="stylesheet" href="gitbook/gitbook-plugin-search/search.css">
+
+
+
+ <link rel="stylesheet" href="gitbook/gitbook-plugin-fontsettings/website.css">
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ <meta name="HandheldFriendly" content="true"/>
+ <meta name="viewport" content="width=device-width, initial-scale=1, user-scalable=no">
+ <meta name="apple-mobile-web-app-capable" content="yes">
+ <meta name="apple-mobile-web-app-status-bar-style" content="black">
+ <link rel="apple-touch-icon-precomposed" sizes="152x152" href="gitbook/images/apple-touch-icon-precomposed-152.png">
+ <link rel="shortcut icon" href="gitbook/images/favicon.ico" type="image/x-icon">
+
+
+ <link rel="next" href="ide.html" />
+
+
+ <link rel="prev" href="notice.html" />
+
+
+ </head>
+ <body>
+
+<div class="book">
+ <div class="book-summary">
+
+
+<div id="book-search-input" role="search">
+ <input type="text" placeholder="Type to search" />
+</div>
+
+
+ <nav role="navigation">
+
+
+
+<ul class="summary">
+
+
+
+
+
+
+
+
+
+ <li class="chapter " data-level="1.1" data-path="./">
+
+ <a href="./">
+
+
+ Introduction
+
+ </a>
+
+
+
+ </li>
+
+ <li class="chapter " data-level="1.2" data-path="notice.html">
+
+ <a href="notice.html">
+
+
+ Legal Notice
+
+ </a>
+
+
+
+ </li>
+
+ <li class="chapter active" data-level="1.3" data-path="code.html">
+
+ <a href="code.html">
+
+
+ Working with the Code
+
+ </a>
+
+
+
+ </li>
+
+ <li class="chapter " data-level="1.4" data-path="ide.html">
+
+ <a href="ide.html">
+
+
+ IDE Integration
+
+ </a>
+
+
+
+ </li>
+
+ <li class="chapter " data-level="1.5" data-path="building.html">
+
+ <a href="building.html">
+
+
+ Building
+
+ </a>
+
+
+
+ </li>
+
+ <li class="chapter " data-level="1.6" data-path="tests.html">
+
+ <a href="tests.html">
+
+
+ Tests
+
+ </a>
+
+
+
+ </li>
+
+ <li class="chapter " data-level="1.7" data-path="code-coverage-report.html">
+
+ <a href="code-coverage-report.html">
+
+
+ Code coverage report
+
+ </a>
+
+
+
+ </li>
+
+ <li class="chapter " data-level="1.8" data-path="formatting.html">
+
+ <a href="formatting.html">
+
+
+ Code Formatting
+
+ </a>
+
+
+
+ </li>
+
+ <li class="chapter " data-level="1.9" data-path="validating-releases.html">
+
+ <a href="validating-releases.html">
+
+
+ Validating releases
+
+ </a>
+
+
+
+ </li>
+
+ <li class="chapter " data-level="1.10" data-path="maintainers.html">
+
+ <a href="maintainers.html">
+
+
+ Notes for Maintainers
+
+ </a>
+
+
+
+ </li>
+
+ <li class="chapter " data-level="1.11" data-path="history.html">
+
+ <a href="history.html">
+
+
+ History
+
+ </a>
+
+
+
+ </li>
+
+
+
+
+ <li class="divider"></li>
+
+ <li>
+ <a href="https://www.gitbook.com" target="blank" class="gitbook-link">
+ Published with GitBook
+ </a>
+ </li>
+</ul>
+
+
+ </nav>
+
+
+ </div>
+
+ <div class="book-body">
+
+ <div class="body-inner">
+
+
+
+<div class="book-header" role="navigation">
+
+
+ <!-- Title -->
+ <h1>
+ <i class="fa fa-circle-o-notch fa-spin"></i>
+ <a href="." >Working with the Code</a>
+ </h1>
+</div>
+
+
+
+
+ <div class="page-wrapper" tabindex="-1" role="main">
+ <div class="page-inner">
+
+<div id="book-search-results">
+ <div class="search-noresults">
+
+ <section class="normal markdown-section">
+
+ <h1 id="working-with-the-code">Working with the Code</h1>
+<p>While the canonical Apache ActiveMQ Artemis git repository is hosted on Apache hardware at <a href="https://git-wip-us.apache.org/repos/asf?p=activemq-artemis.git" target="_blank">https://git-wip-us.apache.org/repos/asf?p=activemq-artemis.git</a>
+contributors are encouraged (but not required) to use a mirror on GitHub for collaboration and pull-request review
+functionality. Follow the steps below to get set up with GitHub, etc.</p>
+<p>If you do not wish to use GitHub for whatever reason you can follow the overall process outlined in the "Typical
+development cycle" section below but instead attach <a href="http://git-scm.com/docs/git-format-patch" target="_blank">a patch file</a> to the
+related JIRA or an email to the <a href="http://activemq.apache.org/mailing-lists.html" target="_blank">dev list</a>.</p>
+<h2 id="initial-steps">Initial Steps</h2>
+<ol>
+<li><p>Create a GitHub account if you don't have one already</p>
+<p><a href="http://github.com" target="_blank">http://github.com</a></p>
+</li>
+<li><p>Fork the apache-artemis repository into your account</p>
+<p><a href="https://github.com/apache/activemq-artemis" target="_blank">https://github.com/apache/activemq-artemis</a></p>
+</li>
+<li><p>Clone your newly forked copy onto your local workspace:</p>
+<pre><code> $ git clone git@github.com:<your-user-name>/activemq-artemis.git
+ Cloning into 'activemq-artemis'...
+ remote: Counting objects: 63800, done.
+ remote: Compressing objects: 100% (722/722), done.
+ remote: Total 63800 (delta 149), reused 0 (delta 0), pack-reused 62748
+ Receiving objects: 100% (63800/63800), 18.28 MiB | 3.16 MiB/s, done.
+ Resolving deltas: 100% (28800/28800), done.
+ Checking connectivity... done.
+
+ $ cd activemq-artemis
+</code></pre></li>
+<li><p>Add a remote reference to <code>upstream</code> for pulling future updates</p>
+<pre><code> $ git remote add upstream https://github.com/apache/activemq-artemis
+</code></pre></li>
+<li><p>Build with Maven</p>
+<p>Typically developers will want to build using the <code>dev</code> profile which enables license and code style checks. For
+example:</p>
+<pre><code> $ mvn -Pdev install
+ ...
+ [INFO] ------------------------------------------------------------------------
+ [INFO] Reactor Summary:
+ [INFO]
+ [INFO] ActiveMQ Artemis Parent ........................... SUCCESS [2.298s]
+ [INFO] ActiveMQ Artemis Commons .......................... SUCCESS [1.821s]
+ [INFO] ActiveMQ Artemis Selector Implementation .......... SUCCESS [0.767s]
+ [INFO] ActiveMQ Artemis Native POM ....................... SUCCESS [0.189s]
+ [INFO] ActiveMQ Artemis Journal .......................... SUCCESS [0.646s]
+ [INFO] ActiveMQ Artemis Core Client ...................... SUCCESS [5.969s]
+ [INFO] ActiveMQ Artemis JMS Client ....................... SUCCESS [2.110s]
+ [INFO] ActiveMQ Artemis Server ........................... SUCCESS [11.540s]
+ ...
+ [INFO] ActiveMQ Artemis stress Tests ..................... SUCCESS [0.332s]
+ [INFO] ActiveMQ Artemis performance Tests ................ SUCCESS [0.174s]
+ [INFO] ------------------------------------------------------------------------
+ [INFO] BUILD SUCCESS
+ [INFO] ------------------------------------------------------------------------
+</code></pre></li>
+</ol>
+<h2 id="typical-development-cycle">Typical development cycle</h2>
+<ol>
+<li><p>Identify a task (e.g. a bug to fix or feature to implement)</p>
+<p><a href="https://issues.apache.org/jira/browse/ARTEMIS" target="_blank">https://issues.apache.org/jira/browse/ARTEMIS</a></p>
+</li>
+<li><p>Create a topic branch in your local git repo to do your work</p>
+<pre><code> $ git checkout -b my_cool_feature
+</code></pre></li>
+<li><p>Make the changes and commit one or more times</p>
+<pre><code> $ git commit
+</code></pre><p><a name="commitMessageDetails"></a> When you commit your changes you will need to supply a commit message. We follow the
+ 50/72 git commit message format. An ActiveMQ Artemis commit message should be formatted in the following manner:</p>
+<ol>
+<li>Add the ARTEMIS JIRA (if one exists) followed by a brief description of the change in the first line. This line
+should be limited to 50 characters.</li>
+<li>Insert a single blank line after the first line.</li>
+<li>Provide a detailed description of the change in the following lines, breaking paragraphs where needed. These lines
+should be wrapped at 72 characters.</li>
+</ol>
+<p>An example correctly formatted commit message:</p>
+<pre><code> ARTEMIS-123 Add new commit msg format to README
+
+ Adds a description of the new commit message format as well as examples
+ of well formatted commit messages to the README.md. This is required
+ to enable developers to quickly identify what the commit is intended to
+ do and why the commit was added.
+</code></pre></li>
+<li><p>Occasionally you'll want to push your commit(s) to GitHub for safe-keeping and/or sharing with others.</p>
+<pre><code> git push origin my_cool_feature
+</code></pre><p>Note that git push references the branch you are pushing and defaults to <code>master</code>, not your working branch.</p>
+</li>
+<li><p>Discuss your planned changes (if you want feedback)</p>
+<p>On mailing list - <a href="http://activemq.apache.org/mailing-lists.html" target="_blank">http://activemq.apache.org/mailing-lists.html</a>
+On IRC - irc://irc.freenode.org/apache-activemq or <a href="https://webchat.freenode.net/?channels=apache-activemq" target="_blank">https://webchat.freenode.net/?channels=apache-activemq</a></p>
+</li>
+<li><p>Once you're finished coding your feature/fix then rebase your branch against the latest master (applies your patches
+on top of master)</p>
+<pre><code> git fetch upstream
+ git rebase -i upstream/master
+ # if you have conflicts fix them and rerun rebase
+ # The -f, forces the push, alters history, see note below
+ git push -f origin my_cool_feature
+</code></pre><p>The <code>rebase -i</code> triggers an interactive update which also allows you to combine commits, alter commit messages etc.
+It's a good idea to make the commit log very nice for external consumption (e.g. by squashing all related commits
+into a single commit. Note that rebasing and/or using <code>push -f</code> can alter history. While this is great for making a
+clean patch, it is unfriendly to anyone who has forked your branch. Therefore you'll want to make sure that you
+either work in a branch that you don't share, or if you do share it, tell them you are about to revise the branch
+history (and thus, they will then need to rebase on top of your branch once you push it out).</p>
+</li>
+<li><p>Get your changes merged into upstream</p>
+<ol>
+<li>Send a GitHub pull request, by clicking the pull request link while in your repo's fork.</li>
+<li>An email will automatically be sent to the ActiveMQ developer list.</li>
+<li>As part of the review you may see an automated test run comment on your request.</li>
+<li>After review a maintainer will merge your PR into the canonical git repository at which point those changes will
+be synced with the GitHub mirror repository (i.e. your <code>master</code>) and your PR will be closed by the <code>asfgit</code> bot.</li>
+</ol>
+</li>
+</ol>
+<h2 id="other-common-tasks">Other common tasks</h2>
+<ol>
+<li><p>Pulling updates from upstream</p>
+<pre><code> $ git pull --rebase upstream master
+</code></pre><p>(<code>--rebase</code> will automatically move your local commits, if any, on top of the latest branch you pull from; you can leave
+it off if you do not have any local commits).</p>
+<p>One last option, which some prefer, is to avoid using pull altogether, and just use fetch + rebase (this is of course
+more typing). For example:</p>
+<pre><code> $ git fetch upstream
+ $ git pull
+</code></pre></li>
+<li><p>Pushing pulled updates (or local commits if you aren't using topic branches) to your private GitHub repo (origin)</p>
+<pre><code> $ git push
+ Counting objects: 192, done.
+ Delta compression using up to 4 threads.
+ Compressing objects: 100% (44/44), done.
+ Writing objects: 100% (100/100), 10.67 KiB, done.
+ Total 100 (delta 47), reused 100 (delta 47)
+ To git@github.com:<your-user-name>/apache-artemis.git
+ 3382570..1fa25df master -> master
+</code></pre><p>You might need to say -f to force the changes.</p>
+</li>
+</ol>
+<h2 id="adding-new-dependencies">Adding New Dependencies</h2>
+<p>Due to incompatibilities between some open source licenses and the Apache v2.0 license (that this project is licensed under)
+care must be taken when adding new dependencies to the project. The Apache Software Foundation 3rd party licensing
+policy has more information here: <a href="http://www.apache.org/legal/3party.html" target="_blank">http://www.apache.org/legal/3party.html</a></p>
+<p>To keep track of all licenses in ActiveMQ Artemis, new dependencies must be added in either the top level pom.xml or in test/pom.xml
+(depending on whether this is a test only dependency or if it is used in the main code base). The dependency should be
+added under the dependency management section with version and labelled with a comment highlighting the license for the
+dependency version. See existing dependencies in the main pom.xml for examples. The dependency can then be added to
+individual ActiveMQ Artemis modules <em>without</em> the version specified (the version is implied from the dependency management
+section of the top level pom). This allows ActiveMQ Artemis developers to keep track of all dependencies and licenses.</p>
+
+
+ </section>
+
+ </div>
+ <div class="search-results">
+ <div class="has-results">
+
+ <h1 class="search-results-title"><span class='search-results-count'></span> results matching "<span class='search-query'></span>"</h1>
+ <ul class="search-results-list"></ul>
+
+ </div>
+ <div class="no-results">
+
+ <h1 class="search-results-title">No results matching "<span class='search-query'></span>"</h1>
+
+ </div>
+ </div>
+</div>
+
+ </div>
+ </div>
+
+ </div>
+
+
+
+ <a href="notice.html" class="navigation navigation-prev " aria-label="Previous page: Legal Notice">
+ <i class="fa fa-angle-left"></i>
+ </a>
+
+
+ <a href="ide.html" class="navigation navigation-next " aria-label="Next page: IDE Integration">
+ <i class="fa fa-angle-right"></i>
+ </a>
+
+
+
+ </div>
+
+ <script>
+ var gitbook = gitbook || [];
+ gitbook.push(function() {
+ gitbook.page.hasChanged({"page":{"title":"Working with the Code","level":"1.3","depth":1,"next":{"title":"IDE Integration","level":"1.4","depth":1,"path":"ide.md","ref":"ide.md","articles":[]},"previous":{"title":"Legal Notice","level":"1.2","depth":1,"path":"notice.md","ref":"notice.md","articles":[]},"dir":"ltr"},"config":{"plugins":[],"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"pluginsConfig":{"highlight":{},"search":{},"lunr":{"maxIndexSize":1000000},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"fontsettings":{"theme":"white","family":"sans","size":2},"theme-default":{"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.c
ss"},"showLevel":false}},"github":"apache/activemq-artemis","theme":"default","githubHost":"https://github.com/","pdf":{"pageNumbers":true,"fontSize":12,"fontFamily":"Arial","paperSize":"a4","chapterMark":"pagebreak","pageBreaksBefore":"/","margin":{"right":62,"left":62,"top":56,"bottom":56}},"structure":{"langs":"LANGS.md","readme":"README.md","glossary":"GLOSSARY.md","summary":"SUMMARY.md"},"variables":{},"title":"ActiveMQ Artemis Documentation","links":{"home":"http://activemq.apache.org/artemis","issues":"https://issues.apache.org/jira/browse/ARTEMIS","contribute":"http://activemq.apache.org/contributing.html"},"gitbook":"3.x.x","description":"ActiveMQ Artemis Hacking Guide"},"file":{"path":"code.md","mtime":"2017-09-08T01:26:53.000Z","type":"markdown"},"gitbook":{"version":"3.1.1","time":"2017-09-14T19:50:29.711Z"},"basePath":".","book":{"language":""}});
+ });
+ </script>
+</div>
+
+
+ <script src="gitbook/gitbook.js"></script>
+ <script src="gitbook/theme.js"></script>
+
+
+ <script src="gitbook/gitbook-plugin-search/search-engine.js"></script>
+
+
+
+ <script src="gitbook/gitbook-plugin-search/search.js"></script>
+
+
+
+ <script src="gitbook/gitbook-plugin-lunr/lunr.min.js"></script>
+
+
+
+ <script src="gitbook/gitbook-plugin-lunr/search-lunr.js"></script>
+
+
+
+ <script src="gitbook/gitbook-plugin-sharing/buttons.js"></script>
+
+
+
+ <script src="gitbook/gitbook-plugin-fontsettings/fontsettings.js"></script>
+
+
+
+ </body>
+</html>
+
Added: websites/production/activemq/content/artemis/docs/latest/hacking-guide/formatting.html
==============================================================================
--- websites/production/activemq/content/artemis/docs/latest/hacking-guide/formatting.html (added)
+++ websites/production/activemq/content/artemis/docs/latest/hacking-guide/formatting.html Thu Sep 14 19:53:45 2017
@@ -0,0 +1,374 @@
+
+<!DOCTYPE HTML>
+<html lang="" >
+ <head>
+ <title>Code Formatting · ActiveMQ Artemis Documentation</title>
+ <meta charset="UTF-8">
+ <meta http-equiv="X-UA-Compatible" content="IE=edge" />
+ <meta content="text/html; charset=utf-8" http-equiv="Content-Type">
+ <meta name="description" content="">
+ <meta name="generator" content="GitBook 3.1.1">
+
+
+
+
+ <link rel="stylesheet" href="gitbook/style.css">
+
+
+
+
+ <link rel="stylesheet" href="gitbook/gitbook-plugin-highlight/website.css">
+
+
+
+ <link rel="stylesheet" href="gitbook/gitbook-plugin-search/search.css">
+
+
+
+ <link rel="stylesheet" href="gitbook/gitbook-plugin-fontsettings/website.css">
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ <meta name="HandheldFriendly" content="true"/>
+ <meta name="viewport" content="width=device-width, initial-scale=1, user-scalable=no">
+ <meta name="apple-mobile-web-app-capable" content="yes">
+ <meta name="apple-mobile-web-app-status-bar-style" content="black">
+ <link rel="apple-touch-icon-precomposed" sizes="152x152" href="gitbook/images/apple-touch-icon-precomposed-152.png">
+ <link rel="shortcut icon" href="gitbook/images/favicon.ico" type="image/x-icon">
+
+
+ <link rel="next" href="validating-releases.html" />
+
+
+ <link rel="prev" href="code-coverage-report.html" />
+
+
+ </head>
+ <body>
+
+<div class="book">
+ <div class="book-summary">
+
+
+<div id="book-search-input" role="search">
+ <input type="text" placeholder="Type to search" />
+</div>
+
+
+ <nav role="navigation">
+
+
+
+<ul class="summary">
+
+
+
+
+
+
+
+
+
+ <li class="chapter " data-level="1.1" data-path="./">
+
+ <a href="./">
+
+
+ Introduction
+
+ </a>
+
+
+
+ </li>
+
+ <li class="chapter " data-level="1.2" data-path="notice.html">
+
+ <a href="notice.html">
+
+
+ Legal Notice
+
+ </a>
+
+
+
+ </li>
+
+ <li class="chapter " data-level="1.3" data-path="code.html">
+
+ <a href="code.html">
+
+
+ Working with the Code
+
+ </a>
+
+
+
+ </li>
+
+ <li class="chapter " data-level="1.4" data-path="ide.html">
+
+ <a href="ide.html">
+
+
+ IDE Integration
+
+ </a>
+
+
+
+ </li>
+
+ <li class="chapter " data-level="1.5" data-path="building.html">
+
+ <a href="building.html">
+
+
+ Building
+
+ </a>
+
+
+
+ </li>
+
+ <li class="chapter " data-level="1.6" data-path="tests.html">
+
+ <a href="tests.html">
+
+
+ Tests
+
+ </a>
+
+
+
+ </li>
+
+ <li class="chapter " data-level="1.7" data-path="code-coverage-report.html">
+
+ <a href="code-coverage-report.html">
+
+
+ Code coverage report
+
+ </a>
+
+
+
+ </li>
+
+ <li class="chapter active" data-level="1.8" data-path="formatting.html">
+
+ <a href="formatting.html">
+
+
+ Code Formatting
+
+ </a>
+
+
+
+ </li>
+
+ <li class="chapter " data-level="1.9" data-path="validating-releases.html">
+
+ <a href="validating-releases.html">
+
+
+ Validating releases
+
+ </a>
+
+
+
+ </li>
+
+ <li class="chapter " data-level="1.10" data-path="maintainers.html">
+
+ <a href="maintainers.html">
+
+
+ Notes for Maintainers
+
+ </a>
+
+
+
+ </li>
+
+ <li class="chapter " data-level="1.11" data-path="history.html">
+
+ <a href="history.html">
+
+
+ History
+
+ </a>
+
+
+
+ </li>
+
+
+
+
+ <li class="divider"></li>
+
+ <li>
+ <a href="https://www.gitbook.com" target="blank" class="gitbook-link">
+ Published with GitBook
+ </a>
+ </li>
+</ul>
+
+
+ </nav>
+
+
+ </div>
+
+ <div class="book-body">
+
+ <div class="body-inner">
+
+
+
+<div class="book-header" role="navigation">
+
+
+ <!-- Title -->
+ <h1>
+ <i class="fa fa-circle-o-notch fa-spin"></i>
+ <a href="." >Code Formatting</a>
+ </h1>
+</div>
+
+
+
+
+ <div class="page-wrapper" tabindex="-1" role="main">
+ <div class="page-inner">
+
+<div id="book-search-results">
+ <div class="search-noresults">
+
+ <section class="normal markdown-section">
+
+ <h1 id="code-formatting">Code Formatting</h1>
+<h2 id="eclipse">Eclipse</h2>
+<p>Eclipse code formatting and (basic) project configuration files can be found at the <code>etc/</code> folder. You should manually
+copy them <em>after importing all your projects</em>:</p>
+<pre><code>for settings_dir in `find . -type d -name .settings`; do
+ \cp -v etc/ide-settings/eclipse/org.eclipse.jdt.* $settings_dir
+done
+</code></pre><p>Do not use the <a href="https://maven.apache.org/plugins/maven-eclipse-plugin/" target="_blank">maven-eclipse-plugin</a> to copy the files as it
+conflicts with <a href="http://eclipse.org/m2e/" target="_blank">m2e</a>.</p>
+<h2 id="idea">IDEA</h2>
+<p>If you completed the step described on <a href="ide.html#style-templates-and-inspection-settings-for-idea">idea instructions</a>, and selected the code style accordingly you should be ready to go.</p>
+<h2 id="editorconfig">EditorConfig</h2>
+<p>For editors supporting <a href="http://editorconfig.org/" target="_blank">EditorConfig</a>, a settings file is provided in
+etc/ide-settings/editorconfig.ini. Copy it to your Artemis top level directory and
+<a href="http://editorconfig.org/#file-location" target="_blank">name it .editorconfig</a></p>
+
+
+ </section>
+
+ </div>
+ <div class="search-results">
+ <div class="has-results">
+
+ <h1 class="search-results-title"><span class='search-results-count'></span> results matching "<span class='search-query'></span>"</h1>
+ <ul class="search-results-list"></ul>
+
+ </div>
+ <div class="no-results">
+
+ <h1 class="search-results-title">No results matching "<span class='search-query'></span>"</h1>
+
+ </div>
+ </div>
+</div>
+
+ </div>
+ </div>
+
+ </div>
+
+
+
+ <a href="code-coverage-report.html" class="navigation navigation-prev " aria-label="Previous page: Code coverage report">
+ <i class="fa fa-angle-left"></i>
+ </a>
+
+
+ <a href="validating-releases.html" class="navigation navigation-next " aria-label="Next page: Validating releases">
+ <i class="fa fa-angle-right"></i>
+ </a>
+
+
+
+ </div>
+
+ <script>
+ var gitbook = gitbook || [];
+ gitbook.push(function() {
+ gitbook.page.hasChanged({"page":{"title":"Code Formatting","level":"1.8","depth":1,"next":{"title":"Validating releases","level":"1.9","depth":1,"path":"validating-releases.md","ref":"validating-releases.md","articles":[]},"previous":{"title":"Code coverage report","level":"1.7","depth":1,"path":"code-coverage-report.md","ref":"code-coverage-report.md","articles":[]},"dir":"ltr"},"config":{"plugins":[],"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"pluginsConfig":{"highlight":{},"search":{},"lunr":{"maxIndexSize":1000000},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"fontsettings":{"theme":"white","family":"sans","size":2},"theme-default":{"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"s
tyles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"showLevel":false}},"github":"apache/activemq-artemis","theme":"default","githubHost":"https://github.com/","pdf":{"pageNumbers":true,"fontSize":12,"fontFamily":"Arial","paperSize":"a4","chapterMark":"pagebreak","pageBreaksBefore":"/","margin":{"right":62,"left":62,"top":56,"bottom":56}},"structure":{"langs":"LANGS.md","readme":"README.md","glossary":"GLOSSARY.md","summary":"SUMMARY.md"},"variables":{},"title":"ActiveMQ Artemis Documentation","links":{"home":"http://activemq.apache.org/artemis","issues":"https://issues.apache.org/jira/browse/ARTEMIS","contribute":"http://activemq.apache.org/contributing.html"},"gitbook":"3.x.x","description":"ActiveMQ Artemis Hacking Guide"},"file":{"path":"formatting.md","mtime":"2017-08-02T14:47:12.000Z","type":"markdown"},"gitbook":{"version":"3.1.1","time":"2017-09-14T19:50:29.711Z"},"basePath":".","book":{"language":""}});
+ });
+ </script>
+</div>
+
+
+ <script src="gitbook/gitbook.js"></script>
+ <script src="gitbook/theme.js"></script>
+
+
+ <script src="gitbook/gitbook-plugin-search/search-engine.js"></script>
+
+
+
+ <script src="gitbook/gitbook-plugin-search/search.js"></script>
+
+
+
+ <script src="gitbook/gitbook-plugin-lunr/lunr.min.js"></script>
+
+
+
+ <script src="gitbook/gitbook-plugin-lunr/search-lunr.js"></script>
+
+
+
+ <script src="gitbook/gitbook-plugin-sharing/buttons.js"></script>
+
+
+
+ <script src="gitbook/gitbook-plugin-fontsettings/fontsettings.js"></script>
+
+
+
+ </body>
+</html>
+
Added: websites/production/activemq/content/artemis/docs/latest/hacking-guide/gitbook/fonts/fontawesome/FontAwesome.otf
==============================================================================
Binary file - no diff available.
Propchange: websites/production/activemq/content/artemis/docs/latest/hacking-guide/gitbook/fonts/fontawesome/FontAwesome.otf
------------------------------------------------------------------------------
svn:mime-type = application/octet-stream
Added: websites/production/activemq/content/artemis/docs/latest/hacking-guide/gitbook/fonts/fontawesome/fontawesome-webfont.eot
==============================================================================
Binary file - no diff available.
Propchange: websites/production/activemq/content/artemis/docs/latest/hacking-guide/gitbook/fonts/fontawesome/fontawesome-webfont.eot
------------------------------------------------------------------------------
svn:mime-type = application/octet-stream