https://github.com/snowleopard/mk-miner
Makefile miner
https://github.com/snowleopard/mk-miner
Last synced: 10 months ago
JSON representation
Makefile miner
- Host: GitHub
- URL: https://github.com/snowleopard/mk-miner
- Owner: snowleopard
- License: unlicense
- Created: 2014-12-23T23:28:21.000Z (over 11 years ago)
- Default Branch: master
- Last Pushed: 2014-12-25T14:37:04.000Z (over 11 years ago)
- Last Synced: 2025-03-12T21:17:09.431Z (over 1 year ago)
- Language: Haskell
- Size: 480 KB
- Stars: 2
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Makefile miner
==============
This utility scans a source tree for makefiles and attempts to extract all occurrences of a variable assignment and modification, as well as surrounding `if`/`else`/`endif` statements, and presents the results as annotated Haskell-like code. If you are very lucky the results are directly useable in a build system like [Shake](https://github.com/ndmitchell/shake/blob/master/README.md); otherwise you will at least have everything related to a variable collected in one place giving you a chance to make sense of what is going on. I've written the utility for [migrating GHC's build system to Shake](https://github.com/snowleopard/shaking-up-ghc).
For example, if variable `CFLAGS` is assigned in file `Makefile`:
```
CFLAGS = -O2 -Wall
```
and then modified in file `rules/compiler/flags.mk`:
```
CFLAGS += -std=c++11
ifeq "($Mode)" "paranoid"
CFLAGS += -Werror
else
CFLAGS += -Wno-unused-variable
endif
```
then the miner will produce the following `results/CFLAGS.hs` file:
```Haskell
CFLAGS = [ "-std=c++11 " | ] -- rules/compiler/flags.mk
++ [ "-Werror " | "($Mode)" == "paranoid" ] -- rules/compiler/flags.mk
++ [ "-Wno-unused-variable " | not $ "($Mode)" == "paranoid" ] -- rules/compiler/flags.mk
++ [ "-O2 -Wall " | ] -- Makefile
```
Instructions
------------
The intended location for the miner is inside the build subdirectory of the source tree, therefore by default it looks for makefiles starting from `../..`. To change this, set the `sourceTree` parameter as appropriate in `mkminer.hs`:
```Haskell
sourceTree = ".." > ".."
```
The variables to process are specified in the `todo.txt` file, one per line. To change this, set the `todo` parameter as appropriate in `mkminer.hs`:
```Haskell
todo = "todo.txt"
```
To start the miner, run the `mine.bat` script.
The results will go into the `results` directory:
* `results/vars` subdirectory contains one file per variable, e.g., `CFLAGS.var`. File `X.var` contains all lines extracted from makefiles, which are relevant to variable `X` (including all surrounding `if`/`else`/`endif` statements).
* `results` contains one file per variable, e.g., `CFLAGS.hs`. File `X.hs` contains a Haskell expression for variable `X`.
* `results/allmk.txt` is a concatenation of all found makefiles.
* `results/makefiles.txt` lists all found makefiles.
* `results/summary.txt` contains a (pretty useless) summary.