microsoft / microsoft/MSBuildSdks

DOCS: Instructions for Microsoft.Build.CopyOnWrite do not adequately explain how to install it

Open
#552 2 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
C#
Stars
508
Forks
94
Avg merge
6h 40m
Merged PRs (30d)
2

Description

The Microsoft.Build.CopyOnWrite MSBuild SDK overrides the native MSBuild Copy task to add support for ReFS and Dev Drive CloneFile (Copy on Write or CoW) on Windows. It is designed to be as backwards compatible as possible and should directly replace all usages of Copy in MSBuild.

That is the introduction to the CopyOnWrite package. However there are no actual instructions on how to use it. I was excited to find out this week about DevDrives and this is the last piece to get the full benefits. There is only a mention of Central Package Management, which personally I've never heard of.

  • Is it as simple as installing the package in my project (.NET Framework and/or .NET Core)?
  • Do I need to install it in all projects?
  • Do I need to change build tasks or anything like that?
  • How do I verify it's working?

Also it would be good to include information about the future update to Windows that will make this package redundant.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the Microsoft.Build.CopyOnWrite documentation under src/CopyOnWrite and the existing mention of Central Package Management. Determine and document installation scope, required project or build changes, verification steps, and the future Windows update that may make the package redundant.

Written by the indexing model from the issue text.

Assessment

Domain
build-system, documentation, operating-systems
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.