commercialhaskell/stack

stack haddock ignores the dependencies of test suites and executables

Open

#2620 aperta il 22 set 2016

Vedi su GitHub
 (4 commenti) (2 reazioni) (0 assegnatari)Haskell (848 fork)batch import
component: haddockhelp wantedtype: enhancement

Metriche repository

Star
 (4060 star)
Metriche merge PR
 (Merge medio 14h 21m) (12 PR mergiate in 30 g)

Descrizione

General summary/comments (optional)

stack haddock generates the documentation for the dependencies of the library component, but not of the executable or test components.

Steps to reproduce

  1. Create a cabal package where some packages are required by the executable or test but not the library
  2. Run stack haddock

Expected

If I go to the doc index (.stack-work/install/x86_64-linux/lts-7.0/8.0.1/doc/all/index.html), I expect to see the executables and test suite dependencies docs.

Actual

They're not there.

Stack version

$ stack --version
Version 1.2.1, Git revision f28002bdea51468566fd9370f7f9e801c2b51bc5 (4141 commits) x86_64 hpack-0.14.1

Method of installation

Built from git.

Guida contributor

Direzione di ricerca
Indaga su come `stack haddock` raccolga le dipendenze per i componenti di libreria rispetto a quelli di test ed eseguibili. Esamina il codice di stack per il comando haddock, probabilmente in `src/Stack/Build/Haddock.hs` o simile. Analizza come viene costruito il grafo delle dipendenze per garantire che tutte le dipendenze dei componenti siano incluse. Considera di verificare se esiste già una PR o una discussione su questo comportamento.
Tech stack
Nessuno
Dominio
clibuild systemdocumentation
Tipo issue
Bug
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
3
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
1-3 ore
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
Datata
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Chiara
Prerequisiti
Haskell build system knowledgeStack internalsCabal file structure
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
35