Skip to content

Commit

Permalink
removed legacy target framework from docs
Browse files Browse the repository at this point in the history
  • Loading branch information
@FreeAndNil
FreeAndNil committed Mar 4, 2024
1 parent 5115430 commit 6e885f1
Show file tree
Hide file tree
Showing 8 changed files with 2,017 additions and 2,915 deletions.
21 changes: 3 additions & 18 deletions doc/BUILDING.md
View file
Original file line number Diff line number Diff line change
@@ -1,9 +1,8 @@
## Building log4net

Log4net provides support for a wide array of targets, including
- older .net 2 and 3.5 (including client profiles)
- more modern net40/net45
- netstandard1.3/2.0
Log4net provides support for the following targets
- net462
- netstandard2.0

As such, it does require a relatively full .net environment on Windows to build.

Expand All @@ -14,20 +13,6 @@ Options:
- include desktop targets at least
- include dotnet core targets or download and install
the latest dotnet sdk (you will need at least v2.1)
- note that build is possible with VS2022 build tools, but I had to
install VS2019 build tools _as well_ to get msbuild to recognise
the legacy net35-profile target
- Ensure you have .NET Framework 3.5 SP1 installed
- on Win10+, this can only be installed via Add/Remove Windows Components
- on other platforms, see https://dotnet.microsoft.com/download/dotnet-framework/net35-sp1
- Building against .net 2/3.5, especially Client Profile, is not supported on Mono
- Log4Net supports some older, out-of-support .net SDKs, particularly
dotnet core 1.1 and .net framework client profiles for 3.5 and 4.0.
There are helper powershell scripts in the root of this
repository to assist with obtaining and installing these
SDKs from Microsoft servers. Please see:
- [install-dotnet-core-sdk-1.1.ps1](install-dotnet-core-sdk-1.1.ps1)
- [install-net-framework-sdk-3.5.ps1](install-net-framework-sdk-3.5.ps1)
- Binaries can be built with a Visual Studio or Rider installation
- Binaries, packages and a release zip can be built via commandline
- Ensure that you have a reasonably modern NodeJS installed (at least version 8+)
Expand Down
9 changes: 3 additions & 6 deletions doc/CONTRIBUTING.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,6 @@ follow so that we can have a chance of keeping on top of things.
Getting Started
---------------

+ Make sure you have a [JIRA account](https://issues.apache.org/jira/).
+ Make sure you have a [GitHub account](https://github.com/signup/free).
+ If you're planning to implement a new feature it makes sense to discuss your changes on the [dev list](https://logging.apache.org/log4net/mail-lists.html) first. This way you can make sure you're not wasting your time on something that isn't considered to be in Apache log4net's scope.
+ Submit a ticket for your issue, assuming one does not already exist.
Expand All @@ -24,14 +23,14 @@ Making Changes
+ Respect the original code style:
+ Create minimal diffs - disable on save actions like reformat source code or organize imports. If you feel the source code should be reformatted create a separate PR for this change.
+ Check for unnecessary whitespace with git diff --check before committing.
+ Make sure your commit messages are in the proper format. Your commit message should contain the key of the JIRA issue.
+ Make sure your commit messages are in the proper format. Your commit message should contain the key of the github issue.
+ Make sure you have added the necessary tests for your changes.
+ Run all the tests with `nant` inside the `tests` directory to assure nothing else was accidentally broken.
+ Run all the tests with `npm test` to assure nothing else was accidentally broken.

Making Trivial Changes
----------------------

For changes of a trivial nature to comments and documentation, it is not always necessary to create a new ticket in JIRA.
For changes of a trivial nature to comments and documentation, it is not always necessary to create a new ticket in github.
In this case, it is appropriate to start the first line of a commit with '(doc)' instead of a ticket number.

Submitting Changes
Expand All @@ -40,12 +39,10 @@ Submitting Changes
+ Sign the [Contributor License Agreement][cla] if you haven't already.
+ Push your changes to a topic branch in your fork of the repository.
+ Submit a pull request to the repository in the apache organization.
+ Update your JIRA ticket and include a link to the pull request in the ticket.

Additional Resources
--------------------

+ [Apache log4net JIRA project page](https://issues.apache.org/jira/browse/LOG4NET)
+ [Contributor License Agreement][cla]
+ [General GitHub documentation](https://help.github.com/)
+ [GitHub pull request documentation](https://help.github.com/send-pull-requests/)
Expand Down
144 changes: 47 additions & 97 deletions src/site/xdoc/release/building.xml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -17,107 +17,57 @@ limitations under the License.
-->
<document>

<properties>
<author email="nicko at apache dot org">Nicko Cadell</author>
<title>Apache log4net: Building log4net</title>
</properties>
<properties>
<author email="nicko at apache dot org">Nicko Cadell</author>
<title>Apache log4net: Building log4net</title>
</properties>

<meta name="keywords" content="building log4net, log4net" />
<meta name="keywords" content="building log4net, log4net" />

<body>
<section id="main" name="Building Apache log4net&#x2122;">
<p>
The log4net release builds are built using NAnt. Log4net can also be built
using Visual Studio .NET 2008 or 2010.
</p>

<section id="vsnet" name="Visual Studio">
<p>
Visual Studio .NET 2008 and 2010 are supported build platforms for log4net.
</p>
<body>
<section id="main" name="Building Apache log4net&#x2122;">
<p>
The log4net release builds are built using zarro. Log4net can also be built
using Visual Studio.
</p>

<section id="vsnet-2008" name="Visual Studio .NET 2008">
<p>
The log4net distribution includes a solution and project file
for Visual Studio .NET 2008. Open the <span class="code">log4net.vs2008.sln</span>
from the src directory in the distribution.
</p>
<p>
The log4net project requires only the following references:
</p>
<ul>
<li>System</li>
<li>System.Configuration</li>
<li>System.Data</li>
<li>System.Web</li>
<li>System.XML</li>
</ul>
</section>
<section id="vsnet" name="Visual Studio">
<p>
Visual Studio 2019 and 2022 are supported build platforms for log4net.
</p>

<section id="vsnet-2010" name="Visual Studio .NET 2010">
<p>
The log4net distribution includes a solution and project file
for Visual Studio .NET 2010. Open the <span class="code">log4net.vs2010.sln</span>
from the src directory in the distribution.
</p>
<p>
The log4net project requires only the following references:
</p>
<ul>
<li>System</li>
<li>System.Configuration</li>
<li>System.Data</li>
<li>System.Web</li>
<li>System.XML</li>
</ul>
</section>
</section>

<section id="nant" name="NAnt">
<p>
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 <a href="http://nant.sourceforge.net">nant.sourceforge.net</a>.
</p>
<p>
To support building log4net for the SSCLI framework the NAnt configuration
files need to be updated to specify the SSCLI framework directory.
</p>
<p>
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:
</p>
<div class="syntax"><pre class="code">
nant -buildfile:log4net.build compile-all</pre></div>
<p>
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:
</p>
<div class="syntax"><pre class="code">
nant -buildfile:log4net.build -projecthelp</pre></div>
<p>
Under windows the <span class="code">build.cmd</span> 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:
</p>
<div class="syntax"><pre class="code">
build.cmd compile-all</pre></div>
</section>
<section id="vs" name="Visual Studio">
<p>
The log4net distribution includes a solution and project file
for Visual Studio. Open the <span class="code">log4net.sln</span>
from the src directory in the distribution.
</p>
<p>
The log4net project requires only the following references:
</p>
<ul>
<li>System</li>
<li>System.Configuration</li>
<li>System.Data</li>
<li>System.Web</li>
<li>System.XML</li>
</ul>
</section>
</section>

<section id="sdk" name="SDK Reference">
<p>
<a href="https://github.com/EWSoftware/SHFB">Sandcastle
Helpfile Builder</a> 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 <code>log4net.shfbproj</code>
with SHFB manually.
</p>
</section>
<section id="sdk" name="SDK Reference">
<p>
<a href="https://github.com/EWSoftware/SHFB">
Sandcastle
Helpfile Builder
</a> 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 <code>log4net.shfbproj</code>
with SHFB manually.
</p>
</section>

</section>
</body>
</section>
</body>
</document>
Loading

0 comments on commit 6e885f1

Please sign in to comment.