[SERVER-70717] Create new hire documentation endorsing the use of multi repos Created: 19/Oct/22 Updated: 29/Oct/23 Resolved: 13/Feb/23 |
|
| Status: | Closed |
| Project: | Core Server |
| Component/s: | None |
| Affects Version/s: | None |
| Fix Version/s: | 7.0.0-rc0 |
| Type: | Improvement | Priority: | Major - P3 |
| Reporter: | Alex Neben | Assignee: | Tausif Rahman (Inactive) |
| Resolution: | Fixed | Votes: | 0 |
| Labels: | None | ||
| Remaining Estimate: | Not Specified | ||
| Time Spent: | Not Specified | ||
| Original Estimate: | Not Specified | ||
| Assigned Teams: |
Server Development Platform
|
| Backwards Compatibility: | Fully Compatible |
| Participants: |
| Description |
|
We have received some complaints that switching between branches causes slower compiles. We should very clearly document how to set a VARIANT_DIR and that cloning the repo multiple places is encouraged. |
| Comments |
| Comment by Alex Neben [ 06/Feb/23 ] |
|
I think putting this in the hitchhikers guide will be "good enough". Just find the doc on scons and add it there. This should be a super small ticket. |
| Comment by Tausif Rahman (Inactive) [ 02/Feb/23 ] |
|
We have a lot of sporadic docs. Some as readmes, some in confluence, etc. We should probably have a single source on "How to build" otherwise these docs don't get used and the question just gets asked via slack. |
| Comment by Tausif Rahman (Inactive) [ 02/Feb/23 ] |
|
I think documenting VARIANT_DIR is a good idea. What about optionally suggesting git worktrees? I recently started testing out git worktrees which makes switching branches pain-free & keeps unstaged changes as well as build artifacts intact. |