Bug 1308765 - Update build.sh help in readme, r=franziskus DONTBUILD
authorMartin Thomson <martin.thomson@gmail.com>
Mon, 28 Nov 2016 20:53:12 +1100
changeset 12917 4ec711b5ebaaccf7e98f043d98bf2af525a3e6d7
parent 12916 d908488dc92e42f4e3c3f0e2aaf5b181e20e7da0
child 12918 7558be7c3ce67a109bd8daac88514f5dc2cf235b
push id1829
push usermartin.thomson@gmail.com
push dateMon, 28 Nov 2016 09:53:21 +0000
reviewersfranziskus
bugs1308765
Bug 1308765 - Update build.sh help in readme, r=franziskus DONTBUILD
readme.md
--- a/readme.md
+++ b/readme.md
@@ -36,29 +36,44 @@ After changing into the NSS directory a 
 Once the build is done the build output is found in the directory
 `../dist/*.OBJ`, where `*` will be a name dynamically derived from your system's
 architecture. Exported header files can be found in the `include` directory,
 library files in directory `lib`, and tools in directory `bin`. In order to run
 the tools, set your system environment to use the libraries of your build from
 the "lib" directory, e.g., using the `LD_LIBRARY_PATH` or `DYLD_LIBRARY_PATH`.
 
     Usage: build.sh [-hcgv] [-j <n>] [--test] [--fuzz] [--scan-build[=output]]
-                    [-m32] [--opt|-o]
+                    [-m32] [--opt|-o] [--asan] [--ubsan] [--sancov[=edge|bb|func]]
+                    [--pprof] [--msan]
+
+    This script builds NSS with gyp and ninja.
+
+    This build system is still under development.  It does not yet support all
+    the features or platforms that NSS supports.
+
+    NSS build tool options:
 
-    -h            display this help and exit
-    -c            clean before build
-    -g            force a rebuild of gyp (and NSPR, because why not)
-    -j <n>        run at most <n> concurrent jobs
-    -v            verbose build
-    -m32          do a 32-bit build on a 64-bit system
-    --test        ignore map files and export everything we have
-    --fuzz        enable fuzzing mode. this always enables test builds
-    --scan-build  run the build with scan-build (scan-build has to be in the path)
-                  --scan-build=/out/path sets the output path for scan-build
-    --opt|-o      do an opt build
+        -h            display this help and exit
+        -c            clean before build
+        -g            force a rebuild of gyp (and NSPR, because why not)
+        -j <n>        run at most <n> concurrent jobs
+        -v            verbose build
+        -m32          do a 32-bit build on a 64-bit system
+        --test        ignore map files and export everything we have
+        --fuzz        enable fuzzing mode. this always enables test builds
+        --scan-build  run the build with scan-build (scan-build has to be in the path)
+                      --scan-build=/out/path sets the output path for scan-build
+        --opt|-o      do an opt build
+        --asan        do an asan build
+        --ubsan       do an ubsan build
+        --msan        do an msan build
+        --sancov      do sanitize coverage builds
+                      --sancov=func sets coverage to function level for example
+        --pprof       build with gperftool support
+
 
 ## Building NSS (legacy build system)
 
 After changing into the NSS directory a typical build of 32-bit NSS is done as
 follows:
 
     make nss_build_all