From 37d8fcf47b8356bd307d1afca043d807d9cb3e35 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Paul=20Li=C3=A9tar?= Date: Thu, 23 May 2019 18:49:19 +0100 Subject: [PATCH] Add link to difference.md from README --- README.md | 3 ++- difference.md | 6 +++--- 2 files changed, 5 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 9b22f44..f857cd5 100644 --- a/README.md +++ b/README.md @@ -11,7 +11,8 @@ snmalloc is a research allocator. Its key design features are: required. Details about snmalloc's design can be found in the -[accompanying paper](snmalloc.pdf). +[accompanying paper](snmalloc.pdf). Differences between the paper and the +current implementation are [described here](difference.md). [![Build Status](https://dev.azure.com/snmalloc/snmalloc/_apis/build/status/Microsoft.snmalloc?branchName=master)](https://dev.azure.com/snmalloc/snmalloc/_build/latest?definitionId=1?branchName=master) diff --git a/difference.md b/difference.md index 20f4f35..7cc6237 100644 --- a/difference.md +++ b/difference.md @@ -1,7 +1,7 @@ # Difference from published paper -This document outlines the changes that have diverged from the published paper -on `snmalloc`. +This document outlines the changes that have diverged from +[the published paper](snmalloc.pdf) on `snmalloc`. 1. Link no longer terminates the bump-free list. The paper describes a complex invariant for how the final element of the bump-free list can @@ -17,4 +17,4 @@ on `snmalloc`. The value 1, is never a valid bump allocation value, as we initially allocate the first entry as the link, so we can use 1 as the no more bump - space value. \ No newline at end of file + space value.