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 2022/12/31 17:18:31 UTC
[logging-log4cxx] 02/02: Fix some bad output with latest doxygen version
This is an automated email from the ASF dual-hosted git repository.
rmiddleton pushed a commit to branch next_stable
in repository https://gitbox.apache.org/repos/asf/logging-log4cxx.git
commit 42aa08aa8891051c1d84088e26648c43203938a3
Author: Robert Middleton <ro...@rm5248.com>
AuthorDate: Sat Dec 31 12:18:23 2022 -0500
Fix some bad output with latest doxygen version
---
src/site/doxy/Doxyfile.in | 4 ++--
src/site/doxy/footer.html | 2 +-
src/site/markdown/3-development.md | 1 +
src/site/markdown/community/issue-tracking.md | 9 ++++++++-
src/site/markdown/community/mailing-lists.md | 6 +++---
src/site/markdown/index.md | 11 +++++++++--
src/site/markdown/library-design.md | 4 ++--
7 files changed, 26 insertions(+), 11 deletions(-)
diff --git a/src/site/doxy/Doxyfile.in b/src/site/doxy/Doxyfile.in
index 1a867fad..38d1ba83 100644
--- a/src/site/doxy/Doxyfile.in
+++ b/src/site/doxy/Doxyfile.in
@@ -47,7 +47,7 @@ DOXYFILE_ENCODING = UTF-8
# title of most generated pages and in a few other places.
# The default value is: My Project.
-PROJECT_NAME = "Apache log4cxx"
+PROJECT_NAME = "Apache Log4cxx"
# The PROJECT_NUMBER tag can be used to enter a project or revision number. This
# could be handy for archiving the generated documentation or if some version
@@ -317,7 +317,7 @@ MARKDOWN_SUPPORT = YES
# Minimum value: 0, maximum value: 99, default value: 0.
# This tag requires that the tag MARKDOWN_SUPPORT is set to YES.
-TOC_INCLUDE_HEADINGS = 0
+TOC_INCLUDE_HEADINGS = 3
# When enabled doxygen tries to link words that correspond to documented
# classes, or namespaces to their corresponding documentation. Such a link can
diff --git a/src/site/doxy/footer.html b/src/site/doxy/footer.html
index 9dedb9ac..8c7e226e 100644
--- a/src/site/doxy/footer.html
+++ b/src/site/doxy/footer.html
@@ -8,7 +8,7 @@
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="$relpath^doxygen.png" alt="doxygen"/></a> $doxygenversion </li>
<li class="center">
-Copyright © 2003-2022 <a href="https://www.apache.org/">Apache Software Foundation</a>. All Rights Reserved. <a href="https://privacy.apache.org/policies/privacy-policy-public.html">Privacy Policy</a><br/>
+Copyright © 2003-2023 <a href="https://www.apache.org/">Apache Software Foundation</a>. All Rights Reserved. <a href="https://privacy.apache.org/policies/privacy-policy-public.html">Privacy Policy</a><br/>
Apache Logging, Apache Log4j, Log4j, Apache, the Apache feather logo, and the Apache Logging project logo are trademarks of The Apache Software Foundation.<br/>
</li>
</ul>
diff --git a/src/site/markdown/3-development.md b/src/site/markdown/3-development.md
index c0e6c072..98994336 100644
--- a/src/site/markdown/3-development.md
+++ b/src/site/markdown/3-development.md
@@ -28,3 +28,4 @@ See the following pages for development information:
* @subpage building
* @subpage build-cmake
* @subpage build-vcpkg
+* @subpage library-design
diff --git a/src/site/markdown/community/issue-tracking.md b/src/site/markdown/community/issue-tracking.md
index ae2c1b38..a0a3aec8 100644
--- a/src/site/markdown/community/issue-tracking.md
+++ b/src/site/markdown/community/issue-tracking.md
@@ -23,7 +23,7 @@ Issue Tracking {#issue-tracking}
# Overview
This project uses [JIRA](https://www.atlassian.com/software/jira), a J2EE-based issue tracking
-and project management application.
+and project management application. Issues may also be filed through GitHub.
# Issue Tracking
@@ -32,6 +32,13 @@ for this project.
https://issues.apache.org/jira/browse/LOGCXX
+If you do not have a JIRA account, you may email private@logging.apache.org due to the
+Apache Software Foundation restricting signups([more information](https://infra.apache.org/jira-guidelines.html#who)).
+
+Issues may also be filed via the github mirror:
+
+https://github.com/apache/logging-log4cxx/issues
+
*Please don't just open bugs only because things don't work for you*, some issues simply
aren't bugs in the code base of the project or it's build tools, but may have a lot of
different other reasons. If things don't work for you and you need some help, please subscribe
diff --git a/src/site/markdown/community/mailing-lists.md b/src/site/markdown/community/mailing-lists.md
index 81b85529..5d1377f9 100644
--- a/src/site/markdown/community/mailing-lists.md
+++ b/src/site/markdown/community/mailing-lists.md
@@ -26,13 +26,13 @@ archive link.
| | | | | | |
| -------------------------------------------- | ------------------------------------------------------------- | ----------------------------------------------------------------- | ---------------------------------------------- | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------- |
| Name | Subscribe | Unsubscribe | Post | Archive | Other Archives |
-| log4cxx usage | [Subscribe](mailto:log4cxx-user-subscribe@logging.apache.org) | [Unsubscribe](mailto:log4cxx-user-unsubscribe@logging.apache.org) | [Post](mailto:log4cxx-user@logging.apache.org) | [mail-archives.apache.org](http://mail-archives.apache.org/mod_mbox/logging-log4cxx-user/) | [markmail.org](http://markmail.org/search/list:org.apache.logging.log4cxx-user) |
+| Log4cxx usage | [Subscribe](mailto:log4cxx-user-subscribe@logging.apache.org) | [Unsubscribe](mailto:log4cxx-user-unsubscribe@logging.apache.org) | [Post](mailto:log4cxx-user@logging.apache.org) | [mail-archives.apache.org](http://mail-archives.apache.org/mod_mbox/logging-log4cxx-user/) | [markmail.org](http://markmail.org/search/list:org.apache.logging.log4cxx-user) |
| \- | \- | \- | \- | \- | [marc.info](http://marc.info/?l=log4cxx-user) |
| \- | \- | \- | \- | \- | [dir.gmane.org](http://dir.gmane.org/gmane.comp.apache.logging.log4cxx.user) |
-| log4cxx development | [Subscribe](mailto:dev-subscribe@logging.apache.org) | [Unsubscribe](mailto:dev-unsubscribe@logging.apache.org) | [Post](mailto:dev@logging.apache.org) | [mail-archives.apache.org](http://mail-archives.apache.org/mod_mbox/logging-dev/) | [markmail.org](http://markmail.org/search/list:org.apache.logging.dev) |
+| Log4cxx development | [Subscribe](mailto:dev-subscribe@logging.apache.org) | [Unsubscribe](mailto:dev-unsubscribe@logging.apache.org) | [Post](mailto:dev@logging.apache.org) | [mail-archives.apache.org](http://mail-archives.apache.org/mod_mbox/logging-dev/) | [markmail.org](http://markmail.org/search/list:org.apache.logging.dev) |
| \- | \- | \- | \- | \- | [marc.info](http://marc.info/?l=dev) |
| \- | \- | \- | \- | \- | [dir.gmane.org](http://dir.gmane.org/gmane.comp.apache.logging.devel) |
-| Old log4cxx development (NOT USED ANYMORE\!) | [Subscribe](mailto:log4cxx-dev-subscribe@logging.apache.org) | [Unsubscribe](mailto:log4cxx-dev-unsubscribe@logging.apache.org) | [Post](mailto:log4cxx-dev@logging.apache.org) | [mail-archives.apache.org](http://mail-archives.apache.org/mod_mbox/logging-log4cxx-dev/) | [markmail.org](http://markmail.org/search/list:org.apache.logging.log4cxx-dev) |
+| Old Log4cxx development (NOT USED ANYMORE\!) | [Subscribe](mailto:log4cxx-dev-subscribe@logging.apache.org) | [Unsubscribe](mailto:log4cxx-dev-unsubscribe@logging.apache.org) | [Post](mailto:log4cxx-dev@logging.apache.org) | [mail-archives.apache.org](http://mail-archives.apache.org/mod_mbox/logging-log4cxx-dev/) | [markmail.org](http://markmail.org/search/list:org.apache.logging.log4cxx-dev) |
| \- | \- | \- | \- | \- | [marc.info](http://marc.info/?l=log4cxx-dev) |
| \- | \- | \- | \- | \- | [dir.gmane.org](http://dir.gmane.org/gmane.comp.apache.logging.log4cxx.devel) |
diff --git a/src/site/markdown/index.md b/src/site/markdown/index.md
index 7cfd507a..da4e0106 100644
--- a/src/site/markdown/index.md
+++ b/src/site/markdown/index.md
@@ -35,7 +35,7 @@ and the corresponding logged result values.
These debugging log statements can be removed from the shipped application
using a compiler build directive.
Logging statements do increase the (code) size of the application,
-but with log4cxx the speed of the application is not generally affected (see [Performance]).
+but with Log4cxx the speed of the application is not generally affected (see [Performance]).
Logging is useful where debuggers are not, for example:
- distributed applications
@@ -50,8 +50,15 @@ The configuration also allows you to control the destination of log messages.
They can be sent to a file, a remote socket server, event loggers as well as the console,
with support for directing particular messages to one or more destinations.
+More information on how to use Log4cxx can be found on the [usage] page. For
+a more general overview of what logging is, the logging services committee
+has a [logging overview] page that explains more of what logging is and
+when to use it.
+
[Apache log4j]:https://logging.apache.org/log4j/2.x/
[Apache Portable Runtime]:https://apr.apache.org/
[Apache License]:https://www.apache.org/licenses/
+[usage]:usage.html
[Open Source Initiative]:https://opensource.org/
-[Performance]:usage.html#performance
\ No newline at end of file
+[Performance]:usage.html#performance
+[logging overview]:https://logging.apache.org/what-is-logging.html
diff --git a/src/site/markdown/library-design.md b/src/site/markdown/library-design.md
index 7c3e2ddb..9d673c5f 100644
--- a/src/site/markdown/library-design.md
+++ b/src/site/markdown/library-design.md
@@ -1,4 +1,4 @@
-# Library Design Notes
+# Library Design Notes {#library-design}
===
<!--
Note: License header cannot be first, as doxygen does not generate
@@ -21,7 +21,7 @@
limitations under the License.
-->
-With version x.y of Log4cxx, the library is designed to be ABI stable, such
+With version 1.0.0 of Log4cxx, the library is designed to be ABI stable, such
that any internal changes to classes will not cause client code to break.
In order to do this, there are a few patterns that are used in order to make
sure that it stays stable.