Skip to content

Use Markdown for READMEs. Add Travis badge to root README. #65

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Sep 9, 2015
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 0 additions & 4 deletions README

This file was deleted.

7 changes: 7 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
# Jsonnet - The data templating language

[![Build Status](https://travis-ci.org/google/jsonnet.svg?branch=master)](https://travis-ci.org/google/jsonnet)

Website: http://google.github.io/jsonnet/doc/

Discussion Forum: https://groups.google.com/forum/#!forum/jsonnet
10 changes: 0 additions & 10 deletions case_studies/kubernetes/README

This file was deleted.

21 changes: 21 additions & 0 deletions case_studies/kubernetes/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
# Kubernetes Example

This Kubernetes example is based on https://github.com/vasanthbala/hackathon/tree/master/kbp/redis

Generate the yaml (actually json) files for Kubernetes:

```sh
jsonnet -m example.jsonnet
```

Check they are the same as the original handwritten files:

```sh
python test_same.py
```

Clean up

```sh
rm -v *.out *.new.yaml
```
12 changes: 5 additions & 7 deletions test_suite/README → test_suite/README.md
Original file line number Diff line number Diff line change
@@ -1,17 +1,15 @@
=============
Test programs
=============
# Test programs

Run ./run_tests.sh to run the full suite and report results.
Run `./run_tests.sh` to run the full suite and report results.

The tests are executed with very aggressive garbage collection parameters. A full garbage
collection cycle is run on every allocation. This means if an object is freed by the GC but still
referenced (because the reference was not from the stack / heap) then the error can be caught in
valgrind.

The output of each test (merging stdout and stderr with 2>&1) should match its .golden file. If a
test has no .golden file, the test should return "true". If a test's name begins with "error." then
The output of each test (merging `stdout` and `stderr` with `2>&1`) should match its .golden file. If a
test has no `.golden` file, the test should return "true". If a test's name begins with "error." then
its exit code is expected to be 1, otherwise it should be 0.

If a test is changed, and its golden output needs to be updated (e.g. line numbers in stack traces
no-longer match up) then run ./refresh_golden.sh <thetest.jsonnet>
no-longer match up) then run `./refresh_golden.sh <thetest.jsonnet>`