Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/myuon/ghc-compiler-notes

A collection of Notes on GHC
https://github.com/myuon/ghc-compiler-notes

Last synced: 23 days ago
JSON representation

A collection of Notes on GHC

Host: GitHub
URL: https://github.com/myuon/ghc-compiler-notes
Owner: myuon
License: mit
Created: 2019-01-12T06:00:59.000Z (almost 6 years ago)
Default Branch: master
Last Pushed: 2019-04-14T13:24:54.000Z (over 5 years ago)
Last Synced: 2024-08-01T22:46:48.814Z (3 months ago)
Language: Haskell
Homepage: https://ghc-compiler-notes.readthedocs.io
Size: 1.84 MB
Stars: 69
Watchers: 8
Forks: 5
Open Issues: 2
Metadata Files:
- Readme: README.md
- Changelog: ChangeLog.md
- License: LICENSE

Awesome Lists containing this project

README

# ghc-docs-book

[![Join the chat at https://gitter.im/ghc-compiler-notes/community](https://badges.gitter.im/ghc-compiler-notes/community.svg)](https://gitter.im/ghc-compiler-notes/community?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge) [![CircleCI](https://circleci.com/gh/myuon/ghc-compiler-notes.svg?style=svg)](https://circleci.com/gh/myuon/ghc-compiler-notes) [![Documentation Status](https://readthedocs.org/projects/ghc-compiler-notes/badge/?version=latest)](https://ghc-compiler-notes.readthedocs.io/en/latest/?badge=latest)

## Installation

Requirements:

* GHC (== 8.6.x): for `ghc-paths`
* GCC: for `CPP`
* Sphinx: for `docs` building

```bash
git clone https://github.com/myuon/ghc-compiler-notes.git
cd ghc-compiler-notes
git clone --depth 1 https://gitlab.haskell.org/ghc/ghc.git output/ghc
make generate
make docs
```

Run `make serve-docs` and enjoy reading the notes from `http://localhost:8000`.

## Development

Using stack.

```shell
$ stack run
$ stack test --flag ghc-compiler-notes:dev
```

Using cabal.

```shell
$ cabal new-run
$ cabal new-test --enable-tests -fdev
```

## TODO

* Read Cabal config
- For `MIN_VERSION_Cabal` / etc. macros.
- e.g. Failed to parse `utils/haddock/haddock-test/src/Test/Haddock/Config.hs`.

* Sources using nested pragmas: https://ghc.haskell.org/trac/ghc/ticket/314
- GHC 8.6.x has an issue for raw stream token with nested comments.
- Fixed this issue in GHC 8.8.x.
- e.g. Failed to parse `libraries/ghc-prim/GHC/Classes.hs`.

* Notes not followed standard style
- e.g. "A note about the stupid context" at `compiler/basicTypes/DataCon.hs`.
- e.g. "Note [About the NameSorts]" at `compiler/basicTypes/Name.hs`.
- e.g. "Note [Continuation BlockId]" at `compiler/cmm/CmmNode.hs`.
- e.g. "Soundness checks" at `compiler/ghci/RtClosureInspect.hs`.

* Collect note references
- Collect `See Note [...]` and relate them to notes