You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@logging.apache.org by mi...@apache.org on 2017/01/17 20:54:15 UTC
[24/32] logging-log4j2 git commit: Migrate build page to markdown
Migrate build page to markdown
Also removes the warning about using Maven 3.0.5 as it appears that
Maven 3.3.9 works just fine with the site build (as evidenced by
Jenkins).
Project: http://git-wip-us.apache.org/repos/asf/logging-log4j2/repo
Commit: http://git-wip-us.apache.org/repos/asf/logging-log4j2/commit/879baec1
Tree: http://git-wip-us.apache.org/repos/asf/logging-log4j2/tree/879baec1
Diff: http://git-wip-us.apache.org/repos/asf/logging-log4j2/diff/879baec1
Branch: refs/heads/LOG4J2-1748and1780-remove-ExecutorService-from-LoggerContext
Commit: 879baec1041d231a24dd1bce77f6d10f48b2bede
Parents: b34236d
Author: Matt Sicker <c....@uptake.com>
Authored: Mon Jan 16 15:22:49 2017 -0600
Committer: Matt Sicker <c....@uptake.com>
Committed: Mon Jan 16 15:22:49 2017 -0600
----------------------------------------------------------------------
src/site/markdown/build.md | 61 +++++++++++++++++++++++++++++++
src/site/xdoc/build.xml.vm | 80 -----------------------------------------
2 files changed, 61 insertions(+), 80 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/logging-log4j2/blob/879baec1/src/site/markdown/build.md
----------------------------------------------------------------------
diff --git a/src/site/markdown/build.md b/src/site/markdown/build.md
new file mode 100644
index 0000000..35ff300
--- /dev/null
+++ b/src/site/markdown/build.md
@@ -0,0 +1,61 @@
+<!--
+vim:syn=markdown:
+-->
+<!--
+ Licensed to the Apache Software Foundation (ASF) under one or more
+ contributor license agreements. See the NOTICE file distributed with
+ this work for additional information regarding copyright ownership.
+ The ASF licenses this file to You under the Apache License, Version 2.0
+ (the "License"); you may not use this file except in compliance with
+ the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+-->
+
+Building and Installing Log4j
+=============================
+
+*The information below is for developers who want to modify Log4j or contribute
+to Log4j. If your goal is to add logging to your application you don't need to
+build from the source code, you can [download](download.html) the pre-built
+binaries instead.*
+
+Log4j 2 is hosted in the Apache Software Foundation's Git repository. Details on obtaining the
+most current source code can be found at
+[Log4j Source Repository](source-repository.html). The source from the latest release may be
+obtained by downloading it using the instructions at [Log4j Downloads](download.html).
+
+Log4j 2.x uses Maven 3 as its build tool. To build and install Log4j in your local Maven cache, from
+the root directory run: `mvn install`
+
+Note that if your `/etc/hosts` file does not include an entry for your computer's hostname, then
+many unit tests may execute slowly due to DNS lookups to translate your hostname to an IP address in
+<a class="javadoc" href="http://docs.oracle.com/javase/7/docs/api/java/net/InetAddress.html#getLocalHost()">InetAddress::getLocalHost</a>.
+To remedy this, you can execute the following:
+
+```
+printf '127.0.0.1 %s\n::1 %s\n' `hostname` `hostname` | sudo tee -a /etc/hosts
+```
+
+Then to build the full site, you must use a local staging directory:
+
+```
+mvn site
+[Windows] mvn site:stage-deploy -DstagingSiteURL=file:///%HOME%/log4j
+[Unix] mvn site:stage-deploy -DstagingSiteURL=file:///$HOME/log4j
+```
+
+To rebuild only what's changed and execute the tests, run: `mvn test`
+
+To rebuild from scratch, add "clean", for example: `mvn clean test`
+
+Releasing Log4j
+---------------
+
+Please see the wiki [Log4j2ReleaseGuide](https://wiki.apache.org/logging/Log4j2ReleaseGuide).
http://git-wip-us.apache.org/repos/asf/logging-log4j2/blob/879baec1/src/site/xdoc/build.xml.vm
----------------------------------------------------------------------
diff --git a/src/site/xdoc/build.xml.vm b/src/site/xdoc/build.xml.vm
deleted file mode 100644
index 84a6dc2..0000000
--- a/src/site/xdoc/build.xml.vm
+++ /dev/null
@@ -1,80 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<!--
- Licensed to the Apache Software Foundation (ASF) under one or more
- contributor license agreements. See the NOTICE file distributed with
- this work for additional information regarding copyright ownership.
- The ASF licenses this file to You under the Apache License, Version 2.0
- (the "License"); you may not use this file except in compliance with
- the License. You may obtain a copy of the License at
-
- http://www.apache.org/licenses/LICENSE-2.0
-
- Unless required by applicable law or agreed to in writing, software
- distributed under the License is distributed on an "AS IS" BASIS,
- WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- See the License for the specific language governing permissions and
- limitations under the License.
--->
-#set($dollar = '$')
-<document xmlns="http://maven.apache.org/XDOC/2.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
- xsi:schemaLocation="http://maven.apache.org/XDOC/2.0 http://maven.apache.org/xsd/xdoc-2.0.xsd">
-
- <properties>
- <title>Building and Installing Log4j</title>
- </properties>
-
- <body>
- <section name="Building and Installing Log4j">
-
- <p>
- <i>The information below is for developers who want to modify Log4j or
- contribute to Log4j. If your goal is to add logging to your application
- you don't need to build from the source code,
- you can <a href="download.html">download</a> the pre-built binaries instead.
- </i>
- </p>
- <p>
- Log4j 2 is hosted in the Apache Software Foundation's Git repository. Details on obtaining the
- most current source code can be found at
- <a href="./source-repository.html">Log4j Source Repository</a>. The source from the latest release may be
- obtained by downloading it using the instructions at <a href="./download.html">Log4j Downloads</a>.
- </p>
- <p>
- Log4j 2.x uses Maven 3 as its build tool. To build and install Log4j in your local Maven cache, from
- the root directory run: <kbd>mvn install</kbd>
- </p>
- <p>
- Note that if your <code>/etc/hosts</code> file does not include an entry for your computer's hostname, then
- many unit tests may execute slowly due to DNS lookups to translate your hostname to an IP address in
- <a class="javadoc" href="http://docs.oracle.com/javase/7/docs/api/java/net/InetAddress.html#getLocalHost()">InetAddress::getLocalHost</a>.
- To remedy this, you can execute the following:
- </p>
- <pre class="prettyprint"><![CDATA[
-printf '127.0.0.1 %s\n::1 %s\n' `hostname` `hostname` | sudo tee -a /etc/hosts
-]]></pre>
- <p class="bg-warning">Note that in order to build the website, you need to use
- <a href="http://maven.apache.org/download.cgi#Maven_3.0.5">Maven 3.0.5</a> due to plugin compatibility
- issues as documented in
- <a href="http://jira.codehaus.org/browse/MSITE-695">MSITE-695</a>.
- </p>
- <p>
- Then to build the full site, you must use a local staging directory:
- </p>
- <pre>mvn site
-[Windows] mvn site:stage-deploy -DstagingSiteURL=file:///%HOME%/log4j
-[Unix] mvn site:stage-deploy -DstagingSiteURL=file:///${dollar}HOME/log4j</pre>
- <p>
- To rebuild only what's changed and execute the tests, run: <kbd>mvn test</kbd>
- </p>
- <p>
- To rebuild from scratch, add "clean", for example: <kbd>mvn clean test</kbd>
- </p>
-
- </section>
- <section name="Releasing Log4j">
- <p>
- Please see the wiki <a href="https://wiki.apache.org/logging/Log4j2ReleaseGuide">Log4j2ReleaseGuide</a>.
- </p>
- </section>
- </body>
-</document>