commercialhaskell/stack

Optionally cache Git object files in Pantry directory

Open

#4 758 ouverte le 21 avr. 2019

Voir sur GitHub
 (2 commentaires) (1 réaction) (0 assignés)Haskell (848 forks)batch import
help wantednewcomer friendlytype: discusstype: enhancementtype: performance

Métriques du dépôt

Stars
 (4 060 stars)
Métriques de merge PR
 (Merge moyen 14h 21m) (12 PRs mergées en 30 j)

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.

Guide contributeur

Direction de recherche
Étudiez l'utilisation de GIT OBJECT DIRECTORY dans les opérations git de Stack. Examinez le module pantry (par exemple, src/Pantry/...) et comment les dépôts sont clonés et mis en cache. Consultez les commentaires de @borsboom et @qrilka pour un contexte supplémentaire. Envisagez d'implémenter une option de configuration pour activer ce comportement de mise en cache.
Stack technique
Aucun
Domaine
build systemperformance
Type d'issue
Fonctionnalité
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
3
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
3-5 jours
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
Ancienne
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Claire
Prérequis
Familiarity with Git internalsKnowledge of Stack's pantry directory
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
30