Skip to content

Commit b2844cf

Browse files
committed
Reformatting only of build overview
1 parent 297741f commit b2844cf

File tree

1 file changed

+28
-18
lines changed

1 file changed

+28
-18
lines changed

doc/build_overview.md

Lines changed: 28 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,17 @@
11
<div class="hidden-warning"><a href="https://docs.haskellstack.org/"><img src="https://rawgit.com/commercialhaskell/stack/master/doc/img/hidden-warning.svg"></a></div>
22

3-
# Build Overview
3+
# Build overview
44

5-
__NOTE__ This document should *not be considered accurate* until this
6-
note is removed.
5+
!!! warning
76

8-
This is a work-in-progress document covering the build process used by Stack.
9-
It was started following the Pantry rewrite work in Stack (likely to
10-
land as Stack 2.0), and contains some significant changes/simplifications from
11-
how things used to work. This document will likely not fully be reflected in
12-
the behavior of Stack itself until late in the Stack 2.0 development cycle.
7+
This document should not be considered accurate until this warning is
8+
removed.
9+
10+
This is a work-in-progress document covering the build process used by
11+
Stack. It was started following the Pantry rewrite work in Stack 2.1.1, and
12+
contains some significant changes/simplifications from how things used to
13+
work. This document will likely not fully be reflected in the behavior of
14+
Stack itself until late in the Stack 2.0 development cycle.
1315

1416
## Terminology
1517

@@ -65,7 +67,8 @@ This file is parsed to provide the following config values:
6567
* `ghc-options` (optional field, defaults to `{}`)
6668

6769
`flags` and `ghc-options` break down into both _by name_ (applied to a
68-
specific package) and _general_ (general option `*` for flags is only available in CLI).
70+
specific package) and _general_ (general option `*` for flags is only available
71+
in CLI).
6972

7073
## Wanted compiler, dependencies, and project packages
7174

@@ -95,9 +98,12 @@ specific package) and _general_ (general option `*` for flags is only available
9598
in the corresponding package cabal file, it's an error.
9699
* We are now left with the following:
97100
* A wanted compiler version
98-
* A map from package name to immutable packages with package config (flags, GHC options, hidden)
99-
* A map from package name to mutable packages as dependencies with package config
100-
* A map from package name to mutable packages as project packages with package config
101+
* A map from package name to immutable packages with package config (flags,
102+
GHC options, hidden)
103+
* A map from package name to mutable packages as dependencies with package
104+
config
105+
* A map from package name to mutable packages as project packages with
106+
package config
101107

102108
## Get actual compiler
103109

@@ -202,8 +208,10 @@ a hash of the following information:
202208
Motivation: Any package built from the immutable dependency map and
203209
installed in this database will never need to be rebuilt.
204210

205-
*FIXME* Caveat: do we need to take profiling settings into account
206-
here? How about Haddock status?
211+
!!! bug "To do"
212+
213+
Caveat: do we need to take profiling settings into account here? How about
214+
Haddock status?
207215

208216
## Determine actual target components
209217

@@ -233,10 +241,12 @@ We now have a set of tasks of packages/components to build, with full
233241
config information for each package, and dependencies that must be
234242
built first.
235243

236-
*FIXME* There's some logic to deal with cyclic dependencies between
237-
test suites and benchmarks, where a task can be broken up into
238-
individual components versus be kept as a single task. Need to
239-
document this better. Currently it's the "all in one" logic.
244+
!!! bug "To do"
245+
246+
There's some logic to deal with cyclic dependencies between test suites and
247+
benchmarks, where a task can be broken up into individual components versus
248+
be kept as a single task. Need to document this better. Currently it's the
249+
"all in one" logic.
240250

241251
## Unregister local modified packages
242252

0 commit comments

Comments
 (0)