This commit is contained in:
Paul deGrandis 2016-09-02 13:51:49 +00:00 committed by GitHub
commit d228e0a10c
3 changed files with 89 additions and 21 deletions

46
.gitignore vendored Normal file
View file

@ -0,0 +1,46 @@
# Project related
mk
# Go related
# Java related
pom.xml
*.class
# Python
*.pyc
*.pyo
/__pycache__/
# Ruby
#Gemfile.lock
.sass-cache/
# Temp Files
*.orig
*~
.*.swp
.*.swo
*.tmp
*.bak
# Editors (IntelliJ / Eclipse)
*/.idea
.idea
*/.classpath
.classpath
*/.project
.project
*/.settings
.settings
# OS X
.DS_Store
# Logging
*.log
/logs/
# Builds
*.o
out/

View file

@ -7,13 +7,19 @@ Mk is a reboot of the Plan 9 mk command, which itself is [a successor to
make](http://www.cs.tufts.edu/~nr/cs257/archive/andrew-hume/mk.pdf). This tool
is for anyone who loves make, but hates all its stupid bullshit.
# Installation
## Installation
1. Install Go.
2. Run `go get github.com/dcjones/mk`
3. Make sure `$GOPATH/bin` is in your `PATH`.
# Why Plan 9 mk is better than make
### Building/installing from source
1. `git clone` the repo
2. `go get`
3. `go build`
## Why Plan 9 mk is better than make
Way back in the 90s, some smart guys at Bell Labs got together and decided to
write new operating system to replace Unix. The idea was to keep everything that
@ -43,13 +49,14 @@ elegant, and powerful. To name a few specifics:
`<|sh config.sh`.
1. A generalized mechanism to determine if a target is out of date, for when
timestamps won't cut it.
1. Variables are expanded in recipes only if they are defined. They way you
1. Variables are expanded in recipes only if they are defined. That way you
usually don't have to escape `$`.
And much more! Read [Maintaining Files on Plan 9 with
Mk](http://doc.cat-v.org/plan_9/4th_edition/papers/mk) for good overview.
And much more!
Read [Maintaining Files on Plan 9 with Mk](http://doc.cat-v.org/plan_9/4th_edition/papers/mk)
for good overview.
# Improvements over Plan 9 mk
## Improvements over Plan 9 mk
This mk stays mostly faithful to Plan 9, but makes a few (in my opinion)
improvements.
@ -72,21 +79,21 @@ improvements.
1. Pretty colors.
# Usage
## Usage
`mk [options] [target] ...`
## Options
### Options
* `-f filename` Use the given file as the mkfile.
* `-n` Dry run, print commands without actually executing.
* `-r` Force building of the immediate targets.
* `-a` Force building the targets and of all their dependencies.
* `-p` Maximum number of jobs to execute in parallel (default: 8)
* `-p` Maximum number of jobs to execute in parallel (default: # CPU cores)
* `-i` Show rules that will execute and prompt before executing.
# Non-shell recipes
## Non-shell recipes
Non-shell recipes are a major addition over Plan 9 mk. They can be used with the
`S[command]` attribute, where `command` is an arbitrary command that the recipe
@ -100,9 +107,21 @@ mean.txt:Sjulia: input.txt
mean(map(parseint, eachline(open("$prereq")))))
```
# Current State
## Current State
Functional, but with some bugs and some unimplemented minor features. Give it a
try and see what you think!
## Building and installing from source
* clone the repo
* `go build` - build the executable
* `go test` - run the tests
## License
This work is provided under the [BSD 2-clause](https://opensource.org/licenses/BSD-2-Clause) license.
Copyright (c) 2013, [Daniel C. Jones](https://github.com/dcjones) - All rights reserved.
Updates made by [Paul deGrandis](https://github.com/ohpauleez) Feb 2016.

7
mk.go
View file

@ -2,6 +2,7 @@ package main
import (
"bufio"
"runtime"
"flag"
"fmt"
"io/ioutil"
@ -9,10 +10,12 @@ import (
"path/filepath"
"strings"
"sync"
"github.com/mattn/go-isatty"
)
// True if messages should be printed without fancy colors.
var nocolor bool = false
// - By default, if the output stream is not the terminal, colors are disabled
var nocolor bool = !isatty.IsTerminal(os.Stdout.Fd())
// True if we are ignoring timestamps and rebuilding everything.
var rebuildall bool = false
@ -311,7 +314,7 @@ func main() {
flag.BoolVar(&dryrun, "n", false, "print commands without actually executing")
flag.BoolVar(&shallowrebuild, "r", false, "force building of just targets")
flag.BoolVar(&rebuildall, "a", false, "force building of all dependencies")
flag.IntVar(&subprocsAllowed, "p", 4, "maximum number of jobs to execute in parallel")
flag.IntVar(&subprocsAllowed, "p", runtime.NumCPU(), "maximum number of jobs to execute in parallel")
flag.BoolVar(&interactive, "i", false, "prompt before executing rules")
flag.BoolVar(&quiet, "q", false, "don't print recipes before executing them")
flag.Parse()