From e8e8c4506ed786403a2322a1e2fd450a4cada20c Mon Sep 17 00:00:00 2001 From: Jan Friedrich Date: Mon, 11 Mar 2024 13:45:56 +0100 Subject: [PATCH 1/5] Update version for 2.0.17 --- doc/CONTRIBUTING.md | 2 +- doc/MailTemplate.txt | 19 +++++++++ doc/RELEASING.md | 2 +- src/log4net/log4net.csproj | 4 +- src/site/xdoc/download_log4net.xml | 51 +++++++++---------------- src/site/xdoc/release/release-notes.xml | 27 ++++++++----- 6 files changed, 59 insertions(+), 46 deletions(-) create mode 100644 doc/MailTemplate.txt diff --git a/doc/CONTRIBUTING.md b/doc/CONTRIBUTING.md index 517def0c..d06343aa 100644 --- a/doc/CONTRIBUTING.md +++ b/doc/CONTRIBUTING.md @@ -50,4 +50,4 @@ Additional Resources + [General GitHub documentation](https://help.github.com/) + [GitHub pull request documentation](https://help.github.com/send-pull-requests/) -[cla]:https://www.apache.org/licenses/#clas +[cla]:https://www.apache.org/licenses/#clas \ No newline at end of file diff --git a/doc/MailTemplate.txt b/doc/MailTemplate.txt new file mode 100644 index 00000000..6705d347 --- /dev/null +++ b/doc/MailTemplate.txt @@ -0,0 +1,19 @@ +To: dev@logging.apache.org +Subject: [VOTE] Release Apache Log4net 2.0.17 + +This is a vote to release the Apache Log4net 2.0.17. + +Website: https://logging.staged.apache.org/log4net/release/release-notes.html +GitHub: https://github.com/apache/logging-log4net +GitHub release (pre-release): https://github.com/apache/logging-log4net/releases/tag/2.0.17-rc1 +Distribution: https://dist.apache.org/repos/dist/dev/logging/log4net + +Please download, test, and cast your votes on this mailing list. + +[ ] +1, release the artifacts +[ ] -1, don't release, because... + +This vote is open for 72 hours and will pass unless getting a +net negative vote count. All votes are welcome and we encourage +everyone to test the release, but only the Logging Services PMC +votes are officially counted. \ No newline at end of file diff --git a/doc/RELEASING.md b/doc/RELEASING.md index 919d81e9..5af391df 100644 --- a/doc/RELEASING.md +++ b/doc/RELEASING.md @@ -66,7 +66,7 @@ release version 2.0.123: - copy in source & binary artifacts to respective locations - `svn delete` old items (or defer this until after the vote completes) - `svn commit` -13. raise a vote on the log4net mailing list (dev@logging.apache.org) +13. raise a vote on the log4net mailing list (dev@logging.apache.org) - see MailTemplate.txt 14. wait 15. when the vote has 3 or more +1's, it's time to go live! 16. copy the apache artifacts (binary and source) to the release svn repo and commit diff --git a/src/log4net/log4net.csproj b/src/log4net/log4net.csproj index 61dfe5a9..380fba97 100644 --- a/src/log4net/log4net.csproj +++ b/src/log4net/log4net.csproj @@ -1,8 +1,8 @@  log4net - 2.0.16 - 2.0.16 + 2.0.17 + $(Version) Apache log4net Apache log4net diff --git a/src/site/xdoc/download_log4net.xml b/src/site/xdoc/download_log4net.xml index 0a343092..3e52ee76 100644 --- a/src/site/xdoc/download_log4net.xml +++ b/src/site/xdoc/download_log4net.xml @@ -23,27 +23,22 @@ limitations under the License.
-

Apache log4net is distributed under the Apache - License, version 2.0.

+

Apache log4net is distributed under the Apache License, version 2.0.

-

Starting with log4net 1.2.11 log4net is available as source only or - binary only release.

+

Starting with log4net 1.2.11 log4net is available as source only or binary only release.

-

Users who download the ZIP files to Windows may need to unblock the - archive (right click on the ZIP and press the "Unblock" button) - before extracting it.

+

Users who download the ZIP files to Windows may need to unblock the archive (right click on the ZIP and press the "Unblock" button) before extracting it.

-
+
- - - + + +
apache-log4net-source-2.0.16.zipsha512pgpapache-log4net-source-2.0.17.zipsha512pgp
@@ -52,14 +47,14 @@ limitations under the License.

Binaries are available in a zip file or nupkg, which is also available from nuget.org

- - - + + + - - - + + +
log4net-binaries-2.0.16.zipsha512pgplog4net-binaries-2.0.17.zipsha512pgp
log4net-2.0.16.nupkgsha512pgplog4net-2.0.17.nupkgsha512pgp
@@ -67,12 +62,8 @@ limitations under the License.
-

The KEYS link - links to the code signing keys used to sign the product. The - PGP link downloads the OpenPGP compatible - signature from our main site. The MD5 link - downloads the checksum from the main site.

+

The KEYS link links to the code signing keys used to sign the product. + The PGP link downloads the OpenPGP compatible signature from our main site.

@@ -94,16 +85,10 @@ limitations under the License.
-

It is essential that you verify the integrity of the downloaded - files using the PGP signature or MD5 checksums. The checksums are - not as strong indicators as the PGP signature.

+

It is essential that you verify the integrity of the downloaded files using the PGP signature.

Please read Verifying - Apache HTTP Server Releases for more information on why you - should verify our releases. The PGP keys used to sign our - distributions are part of the KEYS - file.

+ href="http://httpd.apache.org/dev/verification.html">Verifying Apache HTTP Server Releases for more information on why you should verify our releases. + The PGP keys used to sign our distributions are part of the KEYS file.

diff --git a/src/site/xdoc/release/release-notes.xml b/src/site/xdoc/release/release-notes.xml index 928b2002..5dc0dd8d 100644 --- a/src/site/xdoc/release/release-notes.xml +++ b/src/site/xdoc/release/release-notes.xml @@ -27,40 +27,49 @@ limitations under the License.
+
+ Apache log4net 2.0.16 addresses reported issues: +
+ +
+
Apache log4net 2.0.16 addresses reported issues:
From 6af6316c3f094e8b85da6a8750cba0b3dcf162d3 Mon Sep 17 00:00:00 2001 From: Davyd McColl Date: Fri, 15 Mar 2024 13:49:49 +0200 Subject: [PATCH 2/5] :bookmark: update versioning to 2.0.17.0 --- src/log4net/AssemblyInfo.cs | 46 +++++++++++++++--------------- src/log4net/AssemblyVersionInfo.cs | 4 +-- 2 files changed, 25 insertions(+), 25 deletions(-) diff --git a/src/log4net/AssemblyInfo.cs b/src/log4net/AssemblyInfo.cs index 3c55f6bc..06ff5fc3 100644 --- a/src/log4net/AssemblyInfo.cs +++ b/src/log4net/AssemblyInfo.cs @@ -55,77 +55,77 @@ // #if (CLI_1_0) -[assembly: AssemblyInformationalVersionAttribute("2.0.16.0-.CLI 1.0")] +[assembly: AssemblyInformationalVersionAttribute("2.0.17.0-.CLI 1.0")] [assembly: AssemblyTitle("Apache log4net for CLI 1.0 Compatible Frameworks")] #elif (NET_1_0) -[assembly: AssemblyInformationalVersionAttribute("2.0.16.0-.NET 1.0")] +[assembly: AssemblyInformationalVersionAttribute("2.0.17.0-.NET 1.0")] [assembly: AssemblyTitle("Apache log4net for .NET Framework 1.0")] #elif (NET_1_1) -[assembly: AssemblyInformationalVersionAttribute("2.0.16.0-.NET 1.1")] +[assembly: AssemblyInformationalVersionAttribute("2.0.17.0-.NET 1.1")] [assembly: AssemblyTitle("Apache log4net for .NET Framework 1.1")] #elif (NET_4_5) -[assembly: AssemblyInformationalVersionAttribute("2.0.16.0-.NET 4.5")] +[assembly: AssemblyInformationalVersionAttribute("2.0.17.0-.NET 4.5")] [assembly: AssemblyTitle("Apache log4net for .NET Framework 4.5")] #elif (NET_4_0) #if CLIENT_PROFILE -[assembly: AssemblyInformationalVersionAttribute("2.0.16.0-.NET 4.0 CP")] +[assembly: AssemblyInformationalVersionAttribute("2.0.17.0-.NET 4.0 CP")] [assembly: AssemblyTitle("Apache log4net for .NET Framework 4.0 Client Profile")] #else -[assembly: AssemblyInformationalVersionAttribute("2.0.16.0-.NET 4.0")] +[assembly: AssemblyInformationalVersionAttribute("2.0.17.0-.NET 4.0")] [assembly: AssemblyTitle("Apache log4net for .NET Framework 4.0")] #endif // Client Profile #elif (NET_3_5) #if CLIENT_PROFILE -[assembly: AssemblyInformationalVersionAttribute("2.0.16.0-.NET 3.5 CP")] +[assembly: AssemblyInformationalVersionAttribute("2.0.17.0-.NET 3.5 CP")] [assembly: AssemblyTitle("Apache log4net for .NET Framework 3.5 Client Profile")] #else -[assembly: AssemblyInformationalVersionAttribute("2.0.16.0-.NET 3.5")] +[assembly: AssemblyInformationalVersionAttribute("2.0.17.0-.NET 3.5")] [assembly: AssemblyTitle("Apache log4net for .NET Framework 3.5")] #endif // Client Profile #elif (NET_2_0) -[assembly: AssemblyInformationalVersionAttribute("2.0.16.0-.NET 2.0")] +[assembly: AssemblyInformationalVersionAttribute("2.0.17.0-.NET 2.0")] [assembly: AssemblyTitle("Apache log4net for .NET Framework 2.0")] #elif (NETCF_1_0) -[assembly: AssemblyInformationalVersionAttribute("2.0.16.0-.NETCF 1.0")] +[assembly: AssemblyInformationalVersionAttribute("2.0.17.0-.NETCF 1.0")] [assembly: AssemblyTitle("Apache log4net for .NET Compact Framework 1.0")] #elif (NETCF_2_0) -[assembly: AssemblyInformationalVersionAttribute("2.0.16.0-.NETCF 2.0")] +[assembly: AssemblyInformationalVersionAttribute("2.0.17.0-.NETCF 2.0")] [assembly: AssemblyTitle("Apache log4net for .NET Compact Framework 2.0")] #elif (MONO_1_0) -[assembly: AssemblyInformationalVersionAttribute("2.0.16.0-Mono 1.0")] +[assembly: AssemblyInformationalVersionAttribute("2.0.17.0-Mono 1.0")] [assembly: AssemblyTitle("Apache log4net for Mono 1.0")] #elif (MONO_2_0) -[assembly: AssemblyInformationalVersionAttribute("2.0.16.0-Mono 2.0")] +[assembly: AssemblyInformationalVersionAttribute("2.0.17.0-Mono 2.0")] [assembly: AssemblyTitle("Apache log4net for Mono 2.0")] #elif (MONO_3_5) -[assembly: AssemblyInformationalVersionAttribute("2.0.16.0-Mono 3.5")] +[assembly: AssemblyInformationalVersionAttribute("2.0.17.0-Mono 3.5")] [assembly: AssemblyTitle("Apache log4net for Mono 3.5")] #elif (MONO_4_0) -[assembly: AssemblyInformationalVersionAttribute("2.0.16.0-Mono 4.0")] +[assembly: AssemblyInformationalVersionAttribute("2.0.17.0-Mono 4.0")] [assembly: AssemblyTitle("Apache log4net for Mono 4.0")] #elif (SSCLI_1_0) -[assembly: AssemblyInformationalVersionAttribute("2.0.16.0-SSCLI 1.0")] +[assembly: AssemblyInformationalVersionAttribute("2.0.17.0-SSCLI 1.0")] [assembly: AssemblyTitle("Apache log4net for Shared Source CLI 1.0")] #elif (NET) -[assembly: AssemblyInformationalVersionAttribute("2.0.16.0-.NET")] +[assembly: AssemblyInformationalVersionAttribute("2.0.17.0-.NET")] [assembly: AssemblyTitle("Apache log4net for .NET Framework")] #elif (NETSTANDARD1_3) -[assembly: AssemblyInformationalVersionAttribute("2.0.16.0-.NET Standard 1.3")] +[assembly: AssemblyInformationalVersionAttribute("2.0.17.0-.NET Standard 1.3")] [assembly: AssemblyTitle("Apache log4net for .NET Standard 1.3")] #elif (NETSTANDARD2_0) -[assembly: AssemblyInformationalVersionAttribute("2.0.16.0-.NET Standard 2.0")] +[assembly: AssemblyInformationalVersionAttribute("2.0.17.0-.NET Standard 2.0")] [assembly: AssemblyTitle("Apache log4net for .NET Standard 2.0")] #elif (NETCF) -[assembly: AssemblyInformationalVersionAttribute("2.0.16.0-.NETCF")] +[assembly: AssemblyInformationalVersionAttribute("2.0.17.0-.NETCF")] [assembly: AssemblyTitle("Apache log4net for .NET Compact Framework")] #elif (MONO) -[assembly: AssemblyInformationalVersionAttribute("2.0.16.0-Mono")] +[assembly: AssemblyInformationalVersionAttribute("2.0.17.0-Mono")] [assembly: AssemblyTitle("Apache log4net for Mono")] #elif (SSCLI) -[assembly: AssemblyInformationalVersionAttribute("2.0.16.0-SSCLI")] +[assembly: AssemblyInformationalVersionAttribute("2.0.17.0-SSCLI")] [assembly: AssemblyTitle("Apache log4net for Shared Source CLI")] #else -[assembly: AssemblyInformationalVersionAttribute("2.0.16.0")] +[assembly: AssemblyInformationalVersionAttribute("2.0.17.0")] [assembly: AssemblyTitle("Apache log4net")] #endif diff --git a/src/log4net/AssemblyVersionInfo.cs b/src/log4net/AssemblyVersionInfo.cs index 14524de4..45e01a6e 100644 --- a/src/log4net/AssemblyVersionInfo.cs +++ b/src/log4net/AssemblyVersionInfo.cs @@ -28,11 +28,11 @@ // You can specify all the values or you can default the Revision and Build Numbers // by using the '*' as shown below: -[assembly: System.Reflection.AssemblyVersion("2.0.16.0")] +[assembly: System.Reflection.AssemblyVersion("2.0.17.0")] #if !NETCF #if !SSCLI -[assembly: System.Reflection.AssemblyFileVersion("2.0.16.0")] +[assembly: System.Reflection.AssemblyFileVersion("2.0.17.0")] #endif #endif From 403f66aede2c9c7cf3463f8dd6032cee7d921bb1 Mon Sep 17 00:00:00 2001 From: Davyd McColl Date: Fri, 15 Mar 2024 13:59:34 +0200 Subject: [PATCH 3/5] :arrow_up: prepare for release --- log4net.build | 2 +- log4net.shfbproj | 2 +- pom.xml | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) diff --git a/log4net.build b/log4net.build index 7172d4f2..f1700d02 100644 --- a/log4net.build +++ b/log4net.build @@ -20,7 +20,7 @@ limitations under the License. - + diff --git a/log4net.shfbproj b/log4net.shfbproj index ae39e037..ac37fbb3 100644 --- a/log4net.shfbproj +++ b/log4net.shfbproj @@ -33,7 +33,7 @@ limitations under the License. .NET Framework 3.5 doc\sdk\net\4.0\ - log4net-sdk-2.0.16 + log4net-sdk-2.0.17 en-US Standard Blank diff --git a/pom.xml b/pom.xml index 96d4cdc7..bd0bcef9 100644 --- a/pom.xml +++ b/pom.xml @@ -21,7 +21,7 @@ log4net apache-log4net pom - 2.0.16 + 2.0.17 Apache log4net Logging framework for Microsoft .NET Framework. http://logging.apache.org/log4net/ From f9f5a408f28e8dfba6ef1025ca32391976344265 Mon Sep 17 00:00:00 2001 From: Davyd McColl Date: Fri, 15 Mar 2024 14:00:01 +0200 Subject: [PATCH 4/5] :poop: work around default-tools-installer hanging on one download (internet here is rubbish right now) --- local-tasks/default-tools-installer.ts | 58 ++++++++++++++++++++++++++ 1 file changed, 58 insertions(+) create mode 100644 local-tasks/default-tools-installer.ts diff --git a/local-tasks/default-tools-installer.ts b/local-tasks/default-tools-installer.ts new file mode 100644 index 00000000..6f71dcae --- /dev/null +++ b/local-tasks/default-tools-installer.ts @@ -0,0 +1,58 @@ +/// +// 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. +(function () { + const + debug = requireModule("debug")(__filename), + gulp = requireModule("gulp"), + env = requireModule("env"), + nugetSourceName = process.env.NUGET_SOURCE || "nuget.org", + installLocalTools = requireModule("install-local-tools"), + isDotnetCore = env.resolveFlag("DOTNET_CORE"), + tools = isDotnetCore + ? [] // currently, only dotnet targets are used for dotnet test/build + : [ + `${ nugetSourceName }/nunit.consolerunner` + ]; + + env.associate("default-tools-installer", [ "BUILD_TOOLS_FOLDER", "DOTNET_CORE" ]); + + gulp.task( + "default-tools-installer", + `Installs the default toolset: ${ tools.join(", ") }`, + () => { + if (env.resolveFlag("DOTNET_CORE")) { + debug(`DOTNET_CORE builds currently have ${ tools.length } default tools to install`); + } + if (tools.length === 0) { + // don't waste time calling into the installer + // when there are no tools to install + return Promise.resolve(); + } + return installLocalTools.install(tools); + } + ); + + gulp.task( + "clean-tools-folder", + "Cleans out folders under the tools folder (will always be done as part of tool installation)", + () => { + return installLocalTools.clean(); + } + ); + })(); + \ No newline at end of file From 61e28326da40646161fe5167905f6c5f55e468a2 Mon Sep 17 00:00:00 2001 From: Jan Friedrich Date: Thu, 21 Mar 2024 11:22:40 +0100 Subject: [PATCH 5/5] - updated site content - removed obsolete content --- src/site/apt/roadmap.apt | 4 +- src/site/resources/doap_log4net.rdf | 92 +- src/site/site.xml | 78 +- src/site/xdoc/download_log4net.xml | 7 +- src/site/xdoc/index.xml | 52 +- src/site/xdoc/release/building.xml | 117 +-- src/site/xdoc/release/features.xml | 33 +- src/site/xdoc/release/framework-support.xml | 911 ++------------------ src/site/xdoc/release/howto/chainsaw.xml | 115 --- src/site/xdoc/release/howto/index.xml | 53 -- 10 files changed, 135 insertions(+), 1327 deletions(-) delete mode 100644 src/site/xdoc/release/howto/chainsaw.xml delete mode 100644 src/site/xdoc/release/howto/index.xml diff --git a/src/site/apt/roadmap.apt b/src/site/apt/roadmap.apt index e3396ec4..4736f7eb 100644 --- a/src/site/apt/roadmap.apt +++ b/src/site/apt/roadmap.apt @@ -20,8 +20,8 @@ Apache log4net™ Roadmap - The log4net development roadmap is managed by our JIRA issue tracking system. + The log4net development roadmap is managed by our Github issue tracking system. For a list of upcoming fixes and in-progress tasks see: - {{{http://issues.apache.org/jira/browse/LOG4NET?report=com.atlassian.jira.plugin.system.project:roadmap-panel}Apache log4net Roadmap}} + {{{https://github.com/apache/logging-log4net/milestones}log4net Milestones}} diff --git a/src/site/resources/doap_log4net.rdf b/src/site/resources/doap_log4net.rdf index acdb9695..fd6ad3bb 100644 --- a/src/site/resources/doap_log4net.rdf +++ b/src/site/resources/doap_log4net.rdf @@ -29,100 +29,16 @@ Apache log4net provides logging services for .NET. - + - + C# - - + + - - - Apache log4net 1.2.9 - 2005-03-21 - 1.2.9 - - - - - Apache log4net 1.2.10 - 2006-04-19 - 1.2.10 - - - - - Apache log4net 1.2.11 - 2011-10-12 - 1.2.11 - - - - - Apache log4net 1.2.12 - 2013-09-12 - 1.2.12 - - - - - Apache log4net 1.2.13 - 2013-11-21 - 1.2.13 - - - - - Apache log4net 1.2.14 - 2015-11-11 - 1.2.14 - - - - - Apache log4net 1.2.15 - 2015-12-09 - 1.2.15 - - - - - Apache log4net 2.0.6 - 2016-12-25 - 2.0.6 - - - - - Apache log4net 2.0.7 - 2017-01-05 - 2.0.7 - - - - - Apache log4net 2.0.8 - 2017-03-11 - 2.0.8 - - - - - Apache log4net 2.0.9 - 2019-08-25 - 2.0.9 - - - - - Apache log4net 2.0.10 - 2019-09.12 - 2.0.10 - - diff --git a/src/site/site.xml b/src/site/site.xml index c4f86fb5..2be04ee2 100644 --- a/src/site/site.xml +++ b/src/site/site.xml @@ -27,52 +27,50 @@ - - - - - - - + + + + + + + - - - - - - - - - - + + + + + + + + - - - - - - - - + + + + + + + + - - - - - - + + + + + + - - - - - - - - - + + + + + + + + + diff --git a/src/site/xdoc/download_log4net.xml b/src/site/xdoc/download_log4net.xml index 3e52ee76..45fcd91c 100644 --- a/src/site/xdoc/download_log4net.xml +++ b/src/site/xdoc/download_log4net.xml @@ -74,9 +74,8 @@ limitations under the License.

The 1.2.10 and 1.2.9 releases have been created while log4net was still undergoing incubation and those releases are available - from the distribution - archive for the Incubator project.

+ from the distribution archive + for the Incubator project.

Previous releases of log4net are available from the SourceForge Project Site.

@@ -85,7 +84,7 @@ limitations under the License.
-

It is essential that you verify the integrity of the downloaded files using the PGP signature.

+

It is essential that you verify the integrity of the downloaded files using the GPG signature.

Please read Verifying Apache HTTP Server Releases for more information on why you should verify our releases. diff --git a/src/site/xdoc/index.xml b/src/site/xdoc/index.xml index 8cbe4859..d3c3a5d3 100644 --- a/src/site/xdoc/index.xml +++ b/src/site/xdoc/index.xml @@ -16,33 +16,27 @@ See the License for the specific language governing permissions and limitations under the License. --> - - - Nicko Cadell - Apache log4net: Home - - - - - -

- -

- The Apache log4net library is a tool to help the programmer output log statements to a variety - of output targets. log4net is a port of the excellent Apache log4j™ framework to the - Microsoft® .NET runtime. We have kept the framework similar in spirit to the original log4j - while taking advantage of new features in the .NET runtime. - For more information on log4net see the features document. -

-
- -
-

- log4net is part of the Apache Logging Services - project at the Apache Software Foundation. The Logging Services project is intended to provide cross-language logging - services for purposes of application debugging and auditing. -

-
- - + + Nicko Cadell + Apache log4net: Home + + + +
+

+ The Apache log4net library is a tool to help the programmer output log statements to a variety + of output targets. log4net is a port of the excellent Apache log4j™ framework to the + Microsoft® .NET runtime. We have kept the framework similar in spirit to the original log4j + while taking advantage of new features in the .NET runtime. + For more information on log4net see the features document. +

+
+
+

+ log4net is part of the Apache Logging Services + project at the Apache Software Foundation. The Logging Services project is intended to provide cross-language logging + services for purposes of application debugging and auditing. +

+
+ diff --git a/src/site/xdoc/release/building.xml b/src/site/xdoc/release/building.xml index 9a9644d6..f4c21a2c 100644 --- a/src/site/xdoc/release/building.xml +++ b/src/site/xdoc/release/building.xml @@ -17,107 +17,18 @@ limitations under the License. --> - - Nicko Cadell - Apache log4net: Building log4net - - - - - -
-

- The log4net release builds are built using NAnt. Log4net can also be built - using Visual Studio .NET 2008 or 2010. -

- -
-

- Visual Studio .NET 2008 and 2010 are supported build platforms for log4net. -

- -
-

- The log4net distribution includes a solution and project file - for Visual Studio .NET 2008. Open the log4net.vs2008.sln - from the src directory in the distribution. -

-

- The log4net project requires only the following references: -

-
    -
  • System
  • -
  • System.Configuration
  • -
  • System.Data
  • -
  • System.Web
  • -
  • System.XML
  • -
-
- -
-

- The log4net distribution includes a solution and project file - for Visual Studio .NET 2010. Open the log4net.vs2010.sln - from the src directory in the distribution. -

-

- The log4net project requires only the following references: -

-
    -
  • System
  • -
  • System.Configuration
  • -
  • System.Data
  • -
  • System.Web
  • -
  • System.XML
  • -
-
-
- -
-

- The log4net distribution is built using the NAnt tool. - A recent NAnt version 0.91 alpha2 is required to build log4net, this is - available from nant.sourceforge.net. -

-

- To support building log4net for the SSCLI framework the NAnt configuration - files need to be updated to specify the SSCLI framework directory. -

-

- To build log4net from the command line, change directory to the root of the - log4net distribution, ensure that the nant executable is in the - PATH, and then run the following command: -

-
-nant -buildfile:log4net.build compile-all
-

- This command will build log4net for all the supported frameworks - that are available on the current machine. To list all the build - targets that are available run the following command: -

-
-nant -buildfile:log4net.build -projecthelp
-

- Under windows the build.cmd can be used - to script the nant build. This can be called from a different - directory and will locate the correct log4net.build file to use. - For example: -

-
-build.cmd compile-all
-
- -
-

- Sandcastle - Helpfile Builder is used to build the log4net SDK - documentation. Running it is currently not - integrated with the NAnt build process, you'll - have to open and run log4net.shfbproj - with SHFB manually. -

-
- -
- + + Nicko Cadell + Apache log4net: Building log4net + + + + + +
+

+ see BUILDING.md +

+
+
diff --git a/src/site/xdoc/release/features.xml b/src/site/xdoc/release/features.xml index c42b7235..eb7b09a3 100644 --- a/src/site/xdoc/release/features.xml +++ b/src/site/xdoc/release/features.xml @@ -65,39 +65,12 @@ limitations under the License.

- log4net runs on all ECMA CLI 1.0 compatible runtimes. log4net has specific builds for the following frameworks:

    -
  • .NET Core 1.0 - using netstandard-1.3
  • -
  • Microsoft® .NET Framework 1.0*
  • -
  • Microsoft .NET Framework 1.1*
  • -
  • Microsoft .NET Framework 2.0
  • -
  • Microsoft .NET Framework 3.5
  • -
  • Microsoft .NET Framework 4.0
  • -
  • Microsoft .NET Framework 4.5
  • -
  • Microsoft .NET Framework 3.5 Client Profile
  • -
  • Microsoft .NET Framework 4.0 Client Profile
  • -
  • Microsoft .NET Compact Framework 1.0*
  • -
  • Microsoft .NET Compact Framework 2.0*
  • -
  • Mono 1.0*
  • -
  • Mono 2.0
  • -
  • Mono 3.5
  • -
  • Mono 4.0
  • -
  • Microsoft Shared Source CLI 1.0*
  • -
  • CLI 1.0 Compatible*
  • +
  • .NET Core 6 or higher - using netstandard-2.0
  • +
  • Microsoft .NET Framework 4.6.2 or higher
-

The "Client Profile" builds are stripped down - versions of the "normal" builds that don't contain any - ASP.NET releated code - which for example means the - %aspnet-* patterns and the - AspNetTraceAppender are not available.

- -

- *Not - supported by the binary release but can be built - from the source release. -

@@ -311,4 +284,4 @@ limitations under the License.
- + \ No newline at end of file diff --git a/src/site/xdoc/release/framework-support.xml b/src/site/xdoc/release/framework-support.xml index 15a42ae8..c19be03d 100644 --- a/src/site/xdoc/release/framework-support.xml +++ b/src/site/xdoc/release/framework-support.xml @@ -17,867 +17,52 @@ limitations under the License. --> - - Nicko Cadell - Apache log4net: Supported Frameworks - - - - - -
- -
-

- log4net is built on a number of different frameworks. Each new version of the frameworks add - new features. To take advantage of these new features we must build log4net using the - appropriate framework. We also maintain builds compatible with older versions of the frameworks. -

-

- It is important to remember that the .NET frameworks support backward compatibility, that is - a new version of the framework will run binary assemblies that were targeted to previous versions - of the framework. -

-

- While the number of different builds available may seem confusing, you only need to select the - nearest build for your platform that is equal to or earlier than your chosen deployment framework. - If you intend to deploy your application on the Microsoft® .NET Framework 1.0 don't pick the - log4net build that is built against the Microsoft .NET Framework 1.1 because the .NET framework - does not guarantee forward compatibility only backward compatibility. -

-

- log4net is regularly built by its developers on the following frameworks: -

- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
FrameworkWebsite
.NET Core 1.0 providing .NET Standard 1.3https://dotnet.github.io/
Microsoft .NET Framework 2.0http://msdn.microsoft.com/en-us/netframework/
Microsoft .NET Framework 3.5http://msdn.microsoft.com/en-us/netframework/
Microsoft .NET Framework 4.0http://msdn.microsoft.com/en-us/netframework/
Microsoft .NET Framework 3.5 Client Profilehttp://msdn.microsoft.com/en-us/library/cc656912.aspx
Microsoft .NET Framework 4.0 Client Profilehttp://msdn.microsoft.com/en-us/library/cc656912.aspx
Microsoft .NET Framework 4.5http://msdn.microsoft.com/en-us/netframework/
Mono 2.0http://www.mono-project.com
Mono 3.5http://www.mono-project.com
Mono 4.0http://www.mono-project.com
-
-

- log4net should also build on the following - frameworks but binaries are not created by the - developers and source compatibility can not be - guaranteed: -

-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
FrameworkWebsite
Microsoft .NET Framework 1.0http://msdn.microsoft.com/en-us/netframework/
Microsoft .NET Framework 1.1http://msdn.microsoft.com/en-us/netframework/
Microsoft .NET Compact Framework 1.0http://msdn2.microsoft.com/en-us/netframework/aa497273.aspx
Microsoft .NET Compact Framework 2.0http://msdn2.microsoft.com/en-us/netframework/aa497273.aspx
Mono 1.0http://www.mono-project.com
Microsoft Shared Source CLI 1.0http://msdn.microsoft.com/en-us/library/ms973879.aspx
CLI 1.0 Compatiblehttp://msdn.microsoft.com/en-us/netframework/aa569283.aspx
-
-

- For most of these frameworks a log4net assembly targeting the framework is supplied. Although it's - perfectly possible to use the .NET Framework 3.5 version of log4net on the .NET Framework 4.0, having - an assembly that really targets a specific framework allows us to use features in that framework that - are not available in other frameworks or remove features from log4net that are not supported in a - specific framework. -

-

- There are no assemblies targeting the Compact - Framework 1.0/2.0, .NET Framework or Mono 1.x or - Microsoft Shared Source CLI 1.0 in the binary - release, but they can be built from the source - release. -

-
- -
-

- The appenders available to each framework depend on the functionality of the - framework and the platform it runs on: -

-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Appender.NET Framework 1.0.NET Framework 1.1.NET Framework 2.0.NET Framework 3.5.NET Framework 4.0.NET Framework 4.5.NET Framework 3.5 Client Profile.NET Framework 4.0 Client Profile.NET Standard 1.3.NET CF 1.0.NET CF 2.0MonoShared Source CLI 1.0CLI 1.0 Compatible
AdoNetAppenderxxxxxxxxxxxx
AnsiColorTerminalAppenderxxxxxxxxxxxxxx
AspNetTraceAppenderxxxxxxxx
BufferingForwardingAppenderxxxxxxxxxxxxxx
ColoredConsoleAppenderxxxxxxxx
ConsoleAppenderxxxxxxxxxxxxxx
DebugAppenderxxxxxxxxxxxxxx
EventLogAppenderxxxxxxxxxx
FileAppenderxxxxxxxxxxxxxx
ForwardingAppenderxxxxxxxxxxxxxx
LocalSyslogAppenderxxxxxxxxxxx
ManagedColoredConsoleAppenderxxxxxxxx
MemoryAppenderxxxxxxxxxxxxxx
NetSendAppenderxxxxxxxx
OutputDebugStringAppenderxxxxxxxxxxx
RemoteSyslogAppenderxxxxxxxxxxxxxx
RemotingAppenderxxxxxxxxxxx
RollingFileAppenderxxxxxxxxxxxxxx
SmtpAppenderxxxxxxxxxx
SmtpPickupDirAppenderxxxxxxxxxxxxxx
TelnetAppenderxxxxxxxxxxxxxx
TraceAppenderxxxxxxxxxxxxxx
UdpAppenderxxxxxxxxxxxxxx
-
-
- -
-
-

- Targets netstandard-1.3 and thus doesn't support - a few things that work on Mono or the classical - .NET platform. -

-

Things that are not supported in log4net - for .NET Standard 1.3:

-
    -
  • the ADO.NET appender
  • -
  • anything related to ASP.NET (trace appender - and several pattern converters)
  • -
  • .NET Remoting
  • -
  • the colored console appender
  • -
  • the event log appender
  • -
  • The NetSendAppender
  • -
  • The SMTP appender
  • -
  • DOMConfigurator
  • -
  • stack trace patterns
  • -
  • access to appSettings (neither - the log4net section itself nor using the - AppSettingsPatternConverter)
  • -
  • Access to "special paths" using the - EnvironmentFolderPathPatternConverter
  • -
  • Impersonation of Windows accounts
  • -
- -

log4net.LogicalThreadContext and - the associated properties and stack classes use - AsyncLocal rather than - CallContext. Prior to log4net 2.0.8 - they haven't been supported for .NET Standard at - all.

-
- -
-

- none -

-
- -
-

- none -

-
- -
-

- none -

-
- -
-

- none -

-
- -
-

- none -

-
- -
-

- none -

-
- -
-

- As of log4net 1.2.11 this version is identical - to the .NET 3.5 version without support for - ASP.NET specific appenders and patterns. -

-
- -
-

- As of log4net 1.2.11 this version is identical - to the .NET 4.0 version without support for - ASP.NET specific appenders and patterns. -

-
- -
-

Assembly attributes

-

- The .NET Compact Framework 1.0 does not support retrieving assembly level - attributes, therefore all log4net configuration attributes were removed from - the .NET Compact Framework 1.0 version of log4net. -

-

- For Smart-device applications, the log4net system can be configured by passing - the location of the log4net configuration file to the - log4net.Config.XmlConfigurator.Configure(FileInfo) - method in the entry point of the application. -

-

For example:

-

-

-namespace TestApp
-{
-    using System.IO;
-
-    public class EntryPoint
-    {
-        /// <summary>
-        /// Application entry point.
-        /// </summary>
-        public static void Main()
-        {
-            // Uncomment the next line to enable log4net internal debugging
-            // log4net.Util.LogLog.InternalDebugging = true;
-
-            // This will instruct log4net to look for a configuration file
-            // called config.log4net in the root directory of the device
-            log4net.Config.XmlConfigurator.Configure(new FileInfo(@"\config.log4net"));
-
-            ...
-
-            // This will shutdown the log4net system
-            log4net.LogManager.Shutdown();
-        }
-    }
-}
-                            
-

Notification events

-

- The .NET Compact Framework 1.0 does not support notification events during the - application shutdown, therefore log4net cannot automatically hook the - application shutdown notification. -

-

- Applications will need to programmatically shutdown the log4net system during - the application's shutdown using the - log4net.LogManager.Shutdown() - method in order to prevent losing logging events. - See the code above for an example. -

-

FileSystemWatcher

-

- The .NET Compact Framework 1.0 does not support the - System.IO.FileSystemWatcher - class. As a result, the - XmlConfiguratorAttribute.Watch - property and the - XmlConfigurator.ConfigureAndWatch - methods are not available. Watching changes to the log4net configuration - file is not supported on the .NET Compact Framework 1.0. -

-

UserName

-

- The .NET Compact Framework 1.0 does not support the - System.Security.Principal.WindowsIdentity class. - This is used to capture the current thread's user identity. Therefore - the LoggingEvent.UserName property will return the value - "NOT AVAILABLE". -

-

Identity

-

- The .NET Compact Framework 1.0 does not support the - System.Security.Principal.IPrincipal interface. - This is used to capture the current thread's user identity. Therefore - the LoggingEvent.Identity property will return the value - "NOT AVAILABLE". -

-

Environment variables

-

- The .NET Compact Framework 1.0 does not support retrieving environment - variables, therefore it's not possible to substitute environment variables in - parameter values when using the .NET Compact Framework 1.0 version of log4net. -

-

Serialization

-

- The .NET Compact Framework 1.0 does not support serialization, therefore none of - the log4net classes in the .NET Compact Framework 1.0 version are serializable. -

-

LoggingEvent.Domain

-

- The .NET Compact Framework 1.0 does not support AppDomain functionality. The - friendly name for the current AppDomain is stored in the LoggingEvent.Domain - property and is accessed using the %a pattern of the - PatternLayout. On the .NET Compact Framework 1.0 this - value is generated by taking the file name for the application's primary module. -

-
-
-

- See notes for .NET Compact Framework 1.0 -

-
-
-

- There are 2 separate builds of log4net for mono; Mono 1.0, built using the C# compiler in a mode - which is compatible with the CLI 1.0 language specification, and; Mono 2.0, built using the .NET - 2.0 extensions to the C# language. -

- -
-

- none -

-
-
-

- none -

-
-
-

- none -

-
-
-

- none -

-
- -
- -
-

FileSystemWatcher

-

- SSCLI 1.0 does not support the - System.IO.FileSystemWatcher - class. As a result, the - XmlConfiguratorAttribute.Watch - property and the - XmlConfigurator.ConfigureAndWatch - methods are not available. Watching changes to the log4net configuration - file is not supported on SSCLI 1.0. -

-

UserName

-

- SSCLI 1.0 does not support the - System.Security.Principal.WindowsIdentity class. - This is used to capture the current thread's user identity. Therefore - the LoggingEvent.UserName property will return the value - "NOT AVAILABLE". -

-

Identity

-

- SSCLI 1.0 does not support the - System.Security.Principal.IPrincipal interface. - This is used to capture the current thread's user identity. Therefore - the LoggingEvent.Identity property will return the value - "NOT AVAILABLE". -

-
- -
-

- This build of log4net is designed to run on any ECMA CLI 1.0 compatible runtime. - The assembly does not support any platform specific features. The build includes - the common subset of functionality found in the .NET 1.0 and Mono 1.0 builds. - The output assembly is built using the Microsoft .NET 1.0 compiler and library. -

-

- The log4net CLI 1.0 assembly is runtime compatible with the following frameworks: -

-
    -
  • Microsoft .NET Framework 1.0 (and higher)
  • -
  • Mono 1.0 (and higher)
  • -
-

- Only a Release build is generated for this configuration because the assembly - debugging information has not been standardized. -

-
- -
- -
- - + + Nicko Cadell + Apache log4net: Supported Frameworks + + + + + +
+ +
+

+ log4net is built on a number of different frameworks. Each new version of the frameworks add + new features. To take advantage of these new features we must build log4net using the + appropriate framework. We also maintain builds compatible with older versions of the frameworks. +

+

+ It is important to remember that the .NET frameworks support backward compatibility, that is + a new version of the framework will run binary assemblies that were targeted to previous versions + of the framework. +

+

+ log4net is regularly built by its developers on the following frameworks: +

+ +
+ + + + + + + + + + + + + + + + + +
FrameworkWebsite
.NET Core 6 or higher providing .NET Standard 2.0https://dotnet.github.io/
Microsoft .NET Framework 4.6.2https://dotnet.microsoft.com/en-us/download/dotnet-framework/net462
+
+
+
+
diff --git a/src/site/xdoc/release/howto/chainsaw.xml b/src/site/xdoc/release/howto/chainsaw.xml deleted file mode 100644 index 1bfef699..00000000 --- a/src/site/xdoc/release/howto/chainsaw.xml +++ /dev/null @@ -1,115 +0,0 @@ - - - - - - Ron Grabowski - Nicko Cadell - Apache log4net: How To view logging events using Apache log4j Chainsaw - - - - - -
-

- Apache log4j™ includes Apache Chainsaw™ - a graphical log viewer. -

-

- Chainsaw can either receive and display log events in realtime over - the network, or it can load a previously created log file. -

- -

- Before Chainsaw can display data, one or more receivers must be setup. - This is usually done by specifying an xml config file when the program - first starts up.
- Save one or more of the sample xml config files to your local system and - load them when Chainsaw starts. -

- -

- Please note also that it may be necessary to configure Chainsaw tabs as reported as - issue LOG4NET-259. -

- -
-

- Apache log4net™ can be configured to log messages via UDP in such a way that Chainsaw - can receive and display them. -

- -
-

- Configure log4net to use a UdpAppender with the following config snippet: -

- - - - - - - -]]> -
- -
-

- Chainsaw should be configured to start a UDPReceiver using the - following configuration document: -

- - - - - - - -]]> -
- -
- -
-

- Chainsaw can also load an XML log file if it is formatted according - to the log4j schema. Use the following log4net config to output - to file using the log4j schema: -

- - - - - - - -]]> - -

- To load the file into Chainsaw drag the file into the Chainsaw - app and drop it on the tab labeled Drag & Drop log files here. -

-
- -
- -
diff --git a/src/site/xdoc/release/howto/index.xml b/src/site/xdoc/release/howto/index.xml deleted file mode 100644 index 43c72d94..00000000 --- a/src/site/xdoc/release/howto/index.xml +++ /dev/null @@ -1,53 +0,0 @@ - - - - - - Nicko Cadell - Apache log4net: How Tos - - - - - -
- -

- Below are presented, in no particular order, a series of documents - on how to get stuff done. -

-

- New documents can be contributed via the issue tracking system. - See the Issue Tracking page for - details. -

- - - -
- -