This is an automated email from the ASF dual-hosted git repository. freeandnil pushed a commit to branch Feature/Antora in repository https://gitbox.apache.org/repos/asf/logging-log4net.git
commit 9826f8f0cca78ac4a095b42a7c15bc4d0064d538 Author: Jan Friedrich <[email protected]> AuthorDate: Sat Nov 2 23:35:37 2024 +0100 updated development.adoc --- antora-playbook.yaml | 6 +-- src/site/antora/antora.tmpl.yml | 4 +- .../antora/modules/ROOT/pages/development.adoc | 47 ++++++++++++++++++++-- src/site/antora/modules/ROOT/pages/features.adoc | 7 ++-- 4 files changed, 51 insertions(+), 13 deletions(-) diff --git a/antora-playbook.yaml b/antora-playbook.yaml index a878afa4..6b2a2c3b 100644 --- a/antora-playbook.yaml +++ b/antora-playbook.yaml @@ -16,8 +16,8 @@ # site: - title: Apache Log4j Tools - url: "https://logging.apache.org/log4j/kotlin"; + title: Apache log4net + url: "https://logging.apache.org/log4net"; start_page: "ROOT::index.adoc" content: @@ -138,4 +138,4 @@ ui: # Fix the `Edit this page` link - path: partials/edit-this-page.hbs contents: | - <div class="edit-this-page"><a href="https://github.com/apache/logging-log4j-tools/edit/main/src/site/antora/modules/{{page.module}}/pages/{{page.relativeSrcPath}}";>Edit this Page</a></div> + <div class="edit-this-page"><a href="https://github.com/apache/logging-log4net/edit/Feature/Antora/src/site/antora/modules/{{page.module}}/pages/{{page.relativeSrcPath}}";>Edit this Page</a></div> diff --git a/src/site/antora/antora.tmpl.yml b/src/site/antora/antora.tmpl.yml index 743772b9..f57633a7 100644 --- a/src/site/antora/antora.tmpl.yml +++ b/src/site/antora/antora.tmpl.yml @@ -40,8 +40,8 @@ asciidoc: attributes: project-github-url: "${scm.url}" project-version: "${project.version}" - project-name: "Log4j Tools" - project-id: "log4j-tools" + project-name: "log4net" + project-id: "log4net" java-target-version: "${maven.compiler.target}" java-compiler-version: "${minimalJavaBuildVersion}" logging-services-url: "https://logging.apache.org"; diff --git a/src/site/antora/modules/ROOT/pages/development.adoc b/src/site/antora/modules/ROOT/pages/development.adoc index 2bb11445..67aea4bd 100644 --- a/src/site/antora/modules/ROOT/pages/development.adoc +++ b/src/site/antora/modules/ROOT/pages/development.adoc @@ -15,22 +15,61 @@ limitations under the License. //// +[#development] = Development {project-name} uses {project-github-url}[GitHub] for source code management. -The project requires a Java compiler matching the `{java-compiler-version}` range and targets Java `{java-target-version}`. +[#building] +== Building log4net -You can build and verify sources using: +Log4net provides support for the following targets +* net462 +* netstandard2.0 + +[#windows] +=== Windows +* install Visual Studio Build Tools (at least VS 2022) +* install dotnet (v8+) and the .NET SDK (current latest) +* in the project folder ++ +[source,powershell] +---- +dotnet test ./src/log4net.sln +---- + +[#docker] +=== Docker +* install docker (if you haven't already) +** https://docs.docker.com/engine/install/ +* in logging/log4net run ++ [source,bash] ---- -./mvnw verify +docker build -t log4net-builder . +docker run -it log4net-builder +---- +** this will +*** install all dependencies in the container +*** build src/log4net.sln +* inside the container run ++ +[source,bash] +---- +dotnet test /logging-log4net/src/log4net.sln ---- +[#linux-macos] +=== Linux / MacOS +- install the dotnet SDK - v8 or better +- install Mono (you're going to need it to target certain versions of .NET) + +[#site] +== Site You can build and view the website as follows: -[source,bash] +[source,bash/powershell] ---- ./mvnw -N site ---- diff --git a/src/site/antora/modules/ROOT/pages/features.adoc b/src/site/antora/modules/ROOT/pages/features.adoc index a13ffaef..fec253d9 100644 --- a/src/site/antora/modules/ROOT/pages/features.adoc +++ b/src/site/antora/modules/ROOT/pages/features.adoc @@ -18,8 +18,7 @@ limitations under the License. = Features log4net is a tool to help the programmer output log statements to a variety of output targets. -In case of problems with an application, it is helpful to enable logging so that the problem -can be located. +In case of problems with an application, it is helpful to enable logging so that the problem can be located. With log4net it is possible to enable logging at runtime without modifying the application binary. -The log4net package is designed so that log statements can remain in shipped code without incurring a -high performance cost. It follows that the speed of logging (or rather not logging) is crucial. +The log4net package is designed so that log statements can remain in shipped code without incurring a high performance cost. +It follows that the speed of logging (or rather not logging) is crucial. \ No newline at end of file
