You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@logging.apache.org by rm...@apache.org on 2020/08/08 17:11:27 UTC
[logging-log4cxx] 01/01: Put dependencies in markdown format
This is an automated email from the ASF dual-hosted git repository.
rmiddleton pushed a commit to branch dependencies-markdown
in repository https://gitbox.apache.org/repos/asf/logging-log4cxx.git
commit bed1a69f87304fc15a3b92702b2e5e219ed00a8b
Author: Robert Middleton <ro...@rm5248.com>
AuthorDate: Sat Aug 8 13:04:03 2020 -0400
Put dependencies in markdown format
---
src/site/markdown/dependencies2.md | 57 ++++++++++++++++++++++++++++++++++++++
src/site/site.xml | 3 ++
2 files changed, 60 insertions(+)
diff --git a/src/site/markdown/dependencies2.md b/src/site/markdown/dependencies2.md
new file mode 100644
index 0000000..0cfc835
--- /dev/null
+++ b/src/site/markdown/dependencies2.md
@@ -0,0 +1,57 @@
+<!--
+ 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.
+-->
+
+# LOG4CXX Dependencies
+
+log4cxx requires the following software to build and/or run correctly:
+
+|Dependency Name|Version|Dependency Type|Homepage|
+|---------------|-------|---------------|--------|
+|Apache Portable Runtime(APR)|>=1.5.4|Compile/Runtime|https://apr.apache.org
+|APR-Util |>=1.5.4|Compile/Runtime|https://apr.apache.org
+|gzip |any |Test/Runtime(optional)|https://gzip.org
+|zip |any |Test/Runtime(optional)|N/A
+|log4j |1.2.14 |Test |https://http://logging.apache.org/log4j/2.x/
+|java |>=6 |Test |https://www.oracle.com/java/technologies/
+
+## APR/APR-Util
+
+The Apache Portable Runtime(APR) provides the cross-platform backend for log4cxx.
+Both APR and APR-util need to be installed and available on your system.
+
+## zip/gzip
+
+These applications are needed during test of log4cxx. gzip is generally installed
+by default on Linux. zip may not be installed by default; check your distribution's
+documentation for information on how to install these applications.
+
+For Windows, you will have to install gzip and zip through a system such as
+MinGW, cygwin, or MSYS2.
+
+These applications are only needed during runtime if you are compressing the log
+files, for example by setting a rollover policy which ends in ".zip" or ".gz".
+
+## log4j / Java
+
+Log4j and Java are needed to run tests to ensure that log4cxx has binary
+compatability with log4j.
+Note that the correct binary for log4j will be downloaded and used automatically.
+As such, you only need to have Java installed on your system.
+
+# Licenses(direct dependencies only)
+
+**Apache License, Version 2.0**: log4cxx, APR, APR-util
diff --git a/src/site/site.xml b/src/site/site.xml
index c19d505..855ff8c 100644
--- a/src/site/site.xml
+++ b/src/site/site.xml
@@ -106,6 +106,9 @@
<item name="Dependencies"
href="dependencies.html"
/>
+ <item name="Dependencies-markdown"
+ href="dependencies2.html"
+ />
<item name="Building"
href="/building/index.html">
<item name="Apache Maven 2"