From 26a77160ecda915324770867dbe2f148a96a4d78 Mon Sep 17 00:00:00 2001 From: Christopher Kyle Horton Date: Thu, 20 Dec 2018 15:40:13 -0500 Subject: [PATCH 1/5] Edit OpenXmlBasePart property comment (fixes #511) (#528) Documentation correction. --- src/DocumentFormat.OpenXml/Packaging/OpenXmlBasePart.cs | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/DocumentFormat.OpenXml/Packaging/OpenXmlBasePart.cs b/src/DocumentFormat.OpenXml/Packaging/OpenXmlBasePart.cs index b8d563bb1..89ed2e5a2 100644 --- a/src/DocumentFormat.OpenXml/Packaging/OpenXmlBasePart.cs +++ b/src/DocumentFormat.OpenXml/Packaging/OpenXmlBasePart.cs @@ -263,7 +263,7 @@ internal void CreateInternal2(OpenXmlPackage openXmlPackage, OpenXmlPart parent, #region public properties /// - /// Gets a part that is in the OpenXmlPackage container. + /// Gets the OpenXmlPackage which contains the current part. /// public OpenXmlPackage OpenXmlPackage { From ffe30a88e9033135584fdc3e8e6ae6c691a42cc6 Mon Sep 17 00:00:00 2001 From: Tom Jebo Date: Mon, 7 Jan 2019 13:47:45 -0800 Subject: [PATCH 2/5] clarify command-line build instructions --- README.md | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index eec0d822f..0d3bbd773 100644 --- a/README.md +++ b/README.md @@ -144,10 +144,11 @@ To build the Open XML SDK If you want to use a command line approach: -1. Go to the directory that contains the solution. +1. Go to the directory that contains the project file, i.e. `cd \src\DocumentFormat.OpenXml` 1. Run `dotnet restore` in the directory. -1. Run `dotnet test DocumentFormat.OpenXml.Tests` to run the tests. -1. Run `dotnet pack DocumentFormat.OpenXml` to generate a nupkg. +1. Run `dotnet test DocumentFormat.OpenXml.Tests.csproj` to run the tests. +1. Run `dotnet pack DocumentFormat.OpenXml.csproj` to build the SDK framework assembly. +1. Run `dotnet pack DocumentFormat.OpenXml.csproj` to generate a nupkg. Related tools ------------- From 2e2a14bbd4067c1b8bc30d141c3d28e8ad56d463 Mon Sep 17 00:00:00 2001 From: Tom Jebo Date: Wed, 9 Jan 2019 14:13:57 -0800 Subject: [PATCH 3/5] fixes to build instructions --- README.md | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 0d3bbd773..e4923f85e 100644 --- a/README.md +++ b/README.md @@ -144,11 +144,13 @@ To build the Open XML SDK If you want to use a command line approach: -1. Go to the directory that contains the project file, i.e. `cd \src\DocumentFormat.OpenXml` 1. Run `dotnet restore` in the directory. 1. Run `dotnet test DocumentFormat.OpenXml.Tests.csproj` to run the tests. -1. Run `dotnet pack DocumentFormat.OpenXml.csproj` to build the SDK framework assembly. 1. Run `dotnet pack DocumentFormat.OpenXml.csproj` to generate a nupkg. +1. Run `dotnet pack ./src/DocumentFormat.OpenXml/DocumentFormat.OpenXml.csproj` to build the SDK framework assembly. + +By default, `dotnet` will build/test/run only the .NET Core target. To build all targets, set the ProjectLoadStyle environment variable: `ProjectLoadStyle=All` + Related tools ------------- From 17a85ed964a37a65cf48664e27b41d4ec7117d72 Mon Sep 17 00:00:00 2001 From: Tom Jebo Date: Wed, 9 Jan 2019 17:36:25 -0800 Subject: [PATCH 4/5] more refinement on build instructions and corrections. also link to target framework values. --- README.md | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index e4923f85e..f7447b8e9 100644 --- a/README.md +++ b/README.md @@ -144,12 +144,13 @@ To build the Open XML SDK If you want to use a command line approach: -1. Run `dotnet restore` in the directory. +1. Go to the directory that contains the solution. +1. Run `dotnet restore` in the directory (only if using .NET Core SDK version less than 2.1). 1. Run `dotnet test DocumentFormat.OpenXml.Tests.csproj` to run the tests. -1. Run `dotnet pack DocumentFormat.OpenXml.csproj` to generate a nupkg. -1. Run `dotnet pack ./src/DocumentFormat.OpenXml/DocumentFormat.OpenXml.csproj` to build the SDK framework assembly. +1. Run `dotnet pack .\src\DocumentFormat.OpenXml\DocumentFormat.OpenXml.csproj` to generate a nupkg. +1. Run `dotnet build` to build the SDK and test projects -By default, `dotnet` will build/test/run only the .NET Core target. To build all targets, set the ProjectLoadStyle environment variable: `ProjectLoadStyle=All` +By default, `dotnet` will build/test/run only the .NET Core target framework. To build all target frameworks, set the ProjectLoadStyle environment variable: `ProjectLoadStyle=All` To see the other values for `ProjectLoadStyle`, please refer to the comments in [Directory.Build.Props](Directory.Build.Props). Related tools From bb36a8128a93fb06e6551d607097403e30bf30e6 Mon Sep 17 00:00:00 2001 From: Tom Jebo Date: Fri, 11 Jan 2019 11:38:57 -0800 Subject: [PATCH 5/5] ProjectLoadStyle=All requires msbuild --- README.md | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index f7447b8e9..df7499538 100644 --- a/README.md +++ b/README.md @@ -144,13 +144,13 @@ To build the Open XML SDK If you want to use a command line approach: -1. Go to the directory that contains the solution. -1. Run `dotnet restore` in the directory (only if using .NET Core SDK version less than 2.1). -1. Run `dotnet test DocumentFormat.OpenXml.Tests.csproj` to run the tests. -1. Run `dotnet pack .\src\DocumentFormat.OpenXml\DocumentFormat.OpenXml.csproj` to generate a nupkg. -1. Run `dotnet build` to build the SDK and test projects +* Go to the directory that contains the solution. +* Run `dotnet restore` in the directory (only if using .NET Core SDK version less than 2.1). +* Run `dotnet test DocumentFormat.OpenXml.Tests.csproj` to run the tests. +* Run `dotnet pack .\src\DocumentFormat.OpenXml\DocumentFormat.OpenXml.csproj` to generate a nupkg. +* Run `dotnet build` to build the SDK and test projects -By default, `dotnet` will build/test/run only the .NET Core target framework. To build all target frameworks, set the ProjectLoadStyle environment variable: `ProjectLoadStyle=All` To see the other values for `ProjectLoadStyle`, please refer to the comments in [Directory.Build.Props](Directory.Build.Props). +By default, `dotnet` will build/test/run only the .NET Core target framework. To build all target frameworks, set the ProjectLoadStyle environment variable: `ProjectLoadStyle=All` To see the other values for `ProjectLoadStyle`, please refer to the comments in [Directory.Build.Props](Directory.Build.Props). NOTE: Because the other frameworks will be targeted (like .NET 4.6) when using `ProjectLoadStyle=All`, msbuild.exe is needed instead of dotnet.exe so refer to [appveyor.yml](appveyor.yml) to see the appropriate command lines. Related tools