Browse Source

Add note about Valgrind and CII badge

Caleb James DeLisle 7 years ago
parent
commit
71691201ff
2 changed files with 8 additions and 0 deletions
  1. 7 0
      HACKING.md
  2. 1 0
      README.md

+ 7 - 0
HACKING.md

@@ -82,6 +82,13 @@ To stop the program in the debugger, use ctrl+c, this will put you in the debugg
 Once in the debugger shell, to quit the debugger use ctrl+d, if the program is
 running it will prompt you, another ctrl+d will be taken as a "yes, please quit".
 
+### Valgrind
+
+Generally doesn't work because Poly1305 (on most processors) does crypto on floating point
+registers and valgrind interprets the assembly and does not properly interpret floating
+point instructions so under valgrind tests will fail and the engine will not run correctly.
+See: http://www.valgrind.org/docs/manual/manual-core.html#manual-core.limits
+
 
 Profiling
 ---------

+ 1 - 0
README.md

@@ -13,6 +13,7 @@ near-zero-configuration networking, and prevents many of the security and
 scalability issues that plague existing networks.
 
 [![Build Status](https://travis-ci.org/cjdelisle/cjdns.svg?branch=master)](https://travis-ci.org/cjdelisle/cjdns)
+[![CII Best Practices](https://bestpractices.coreinfrastructure.org/projects/387/badge)](https://bestpractices.coreinfrastructure.org/projects/387)
 [![tip for next commit](https://tip4commit.com/projects/941.svg)](https://tip4commit.com/github/cjdelisle/cjdns)
 [![irc](https://img.shields.io/badge/irc%20chat-%23cjdns-blue.svg)](https://kiwiirc.com/client/irc.efnet.org/?nick=visitor|?#cjdns)