microsoft / microsoft/VFSForGit

Mac: Clean up folder/target structure of shared user-mode code

Open
#1,182 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

domain: user-mode platform: macOS
Dominant language
C#
Stars
6.1k
Forks
474
Avg merge
2d 4h
Merged PRs (30d)
8

Description

From the discussion in #1098:

I saw we're doing some weird things as far as directly compiling .cpp files from PrjFSLib in other projects (for example PrjFSKextLogDaemon builds PrjFSUser.cpp and now JsonWriter.cpp out of the PrjFSLib folder). I did not change this as part of this PR.

Yeah, I think if we're going to have multiple such shared utility compilation units, we should probably move them to their own directory, where the various targets can include them in their builds or not as needed. Then for unit testing them we can just have a test target that builds all of (and only) the shared compilation units.

Full discussion here: https://github.com/microsoft/VFSForGit/pull/1098#discussion_r285736296

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

Read the discussion from PR #1098 and inspect how PrjFSKextLogDaemon currently builds PrjFSUser.cpp and JsonWriter.cpp from PrjFSLib. Identify the shared compilation units and the existing unit-test target; done means shared code has a consistent folder/target structure and the test target builds the shared units described in the discussion.

Written by the indexing model from the issue text.

Assessment

Tech stack
cpp
Domain
build-system
Issue type
Refactor
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.