Bug 1145636 - Update jsapi-tests/README. (The functional change is where it talks about the Makefile; that was stale.) r=Waldo.
authorJason Orendorff <jorendorff@mozilla.com>
Fri, 31 Oct 2014 16:58:18 -0500
changeset 237279 ce54231de5ac877c4f90817d1c6322cf10f6650e
parent 237278 5e245cf4f3408bac104f77ee8f479ad9a45c81af
child 237280 725dbd169e90f0597e370217a1d45dd57f7e9d14
push id57907
push userjorendorff@mozilla.com
push dateThu, 02 Apr 2015 15:02:59 +0000
treeherdermozilla-inbound@b3ef9fce0df5 [default view] [failures only]
perfherder[talos] [build metrics] [platform microbench] (compared to previous push)
reviewersWaldo
bugs1145636
milestone40.0a1
first release with
nightly linux32
nightly linux64
nightly mac
nightly win32
nightly win64
last release without
nightly linux32
nightly linux64
nightly mac
nightly win32
nightly win64
Bug 1145636 - Update jsapi-tests/README. (The functional change is where it talks about the Makefile; that was stale.) r=Waldo.
js/src/jsapi-tests/README
--- a/js/src/jsapi-tests/README
+++ b/js/src/jsapi-tests/README
@@ -1,40 +1,42 @@
-=== JSAPI Test Suite
+# JSAPI Test Suite
 
 The tests in this directory exercise the JSAPI.
 
 
---- Building and running the tests
+## Building and running the tests
 
 If you built JS, you already built the tests.
 
 The tests are built by default when you build JS. All the tests are compiled
 into a single binary named jsapi-tests. They all run in a single process.
 
 To run the tests:
 
     cd $OBJDIR/dist/bin
     ./jsapi-tests
 
 To run the tests in a debugger:
 
     cd $OBJDIR/dist/bin
     gdb ./jsapi-tests
 
---- Creating new tests
 
- 1. You can either add to an existing test*.cpp file or make a new one.
+## Creating new tests
+
+1.  You can either add to an existing test*.cpp file or make a new one.
     Copy an existing test and replace the body with your test code.
     The test harness provides `cx`, `rt`, and `global` for your use.
 
- 2. If you made a new .cpp file, add it to the CPPSRCS list in Makefile.in.
+2.  If you made a new .cpp file, add it to the UNIFIED_SOURCES list
+    in moz.build.
 
 
---- Writing test code
+## Writing test code
 
 Here is a sample test:
 
     #include "tests.h"
 
     BEGIN_TEST(testIntString_bug515273)
     {
         RootedValue v(cx);
@@ -130,17 +132,17 @@ tests.h:
         True if v1 and v2 are the same value according to the ES5 SameValue()
         function, to wit:
 
         SameValue(NaN, NaN) is true.
         SameValue(-0, 0) is false.
         Otherwise SameValue(a, b) iff a === b.
 
 
---- Custom test setup
+## Custom test setup
 
 Before executing each test, the test framework calls the tests' init() member
 function, which populates the rt, cx, and global member variables.
 
 A test can customize the test setup process by overloading virtual member
 functions, like this:
 
     const JSClass globalClassWithResolve = { ... };