summaryrefslogtreecommitdiff
path: root/docs/coding-style.html
diff options
context:
space:
mode:
authorJohn Ericson <John.Ericson@Obsidian.Systems>2021-07-22 07:26:47 +0000
committerJohn Ericson <John.Ericson@Obsidian.Systems>2021-08-03 17:33:08 +0000
commit562991def56ea199865e0404365c41314c66c646 (patch)
tree0476cae915656f05f874e9af85e489c7b1cceeac /docs/coding-style.html
parent7a5636a18c821f6bfe3f4400d1fb368d110dead3 (diff)
downloadhaskell-wip/organize-headers.tar.gz
Move `/includes` to `/rts/include`, sort per package betterwip/organize-headers
In order to make the packages in this repo "reinstallable", we need to associate source code with a specific packages. Having a top level `/includes` dir that mixes concerns (which packages' includes?) gets in the way of this. To start, I have moved everything to `rts/`, which is mostly correct. There are a few things however that really don't belong in the rts (like the generated constants haskell type, `CodeGen.Platform.h`). Those needed to be manually adjusted. Things of note: - No symlinking for sake of windows, so we hard-link at configure time. - `CodeGen.Platform.h` no longer as `.hs` extension (in addition to being moved to `compiler/`) so as not to confuse anyone, since it is next to Haskell files. - Blanket `-Iincludes` is gone in both build systems, include paths now more strictly respect per-package dependencies. - `deriveConstants` has been taught to not require a `--target-os` flag when generating the platform-agnostic Haskell type. Make takes advantage of this, but Hadrian has yet to.
Diffstat (limited to 'docs/coding-style.html')
-rw-r--r--docs/coding-style.html4
1 files changed, 2 insertions, 2 deletions
diff --git a/docs/coding-style.html b/docs/coding-style.html
index 5c84b3a27e..29112bf60f 100644
--- a/docs/coding-style.html
+++ b/docs/coding-style.html
@@ -11,7 +11,7 @@
<h2>Comments</h2>
<p>These coding style guidelines are mainly intended for use in
-<tt>ghc/rts</tt> and <tt>ghc/includes</tt>.
+<tt>rts</tt>.
<p>NB These are just suggestions. They're not set in stone. Some of
them are probably misguided. If you disagree with them, feel free to
@@ -207,7 +207,7 @@ the RTS is currently enabled with the <tt>-DS</tt> RTS flag.
sanity checking in various parts of the system when <tt>DEBUG</tt> is
defined. For example, to get the scheduler to be verbose about what
it is doing, you would say <tt>+RTS -Ds -RTS</tt>. See
-<tt>includes/RtsFlags.h</tt> and <tt>rts/RtsFlags.c</tt> for the full
+<tt>rts/include/RtsFlags.h</tt> and <tt>rts/RtsFlags.c</tt> for the full
set of debugging flags. To check one of these flags in the code,
write: