commercialhaskell/stack

Optionally cache Git object files in Pantry directory

Open

#4,758 opened on Apr 21, 2019

View on GitHub
 (2 comments) (1 reaction) (0 assignees)Haskell (848 forks)batch import
help wantednewcomer friendlytype: discusstype: enhancementtype: performance

Repository metrics

Stars
 (4,060 stars)
PR merge metrics
 (Avg merge 17d 10h) (6 merged PRs in 30d)

Description

Setting milestone to P1 to ensure we decide on this before the Stack 2.0 release.

I was unaware until recently of the GIT_OBJECT_DIRECTORY environment variable, described at https://git-scm.com/book/en/v2/Git-Internals-Environment-Variables. IIUC, we can set this environment variable to a shared directory inside the pantry directory, and cache repository information across usages.

Advantages:

  • Don't need to reclone the entire history of a repo when switching to a slightly later commit
  • The current inefficiency of using multiple subdirectories from a single repo will mostly disappear

Disadvantages:

  • Adds lots of additional storage

The disadvantage can be addressed with a future feature of some gc command to Stack, which is actually the topic of a likely GSoC project.

CC @borsboom and @qrilka for feedback.

Contributor guide

Research direction
Investigate how to set the GIT OBJECT DIRECTORY environment variable in Stack's source code to point to a shared directory inside the pantry, and test caching behavior with multiple commits and subdirectories.
Tech stack
haskell
Domain
tooling
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-2 days
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
GitHaskell
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
35