update readme, r=ttaubert DONTBUILD
authorFranziskus Kiefer <franziskuskiefer@gmail.com>
Thu, 19 Jan 2017 09:26:39 +0100
changeset 13039 c188b719789ddbc847c5c69d6feab1386fbf333a
parent 13038 ea43fcc316e16ca24b3b396c649f73f82d1b5e27
child 13040 ff2afbfc0f9776dd7b6f8896e314721e2483d2a1
push id1941
push userfranziskuskiefer@gmail.com
push dateThu, 19 Jan 2017 08:35:21 +0000
reviewersttaubert
update readme, r=ttaubert DONTBUILD Differential Revision: https://nss-review.dev.mozaws.net/D159
build.sh
readme.md
--- a/build.sh
+++ b/build.sh
@@ -12,16 +12,17 @@ source "$cwd"/coreconf/sanitizers.sh
 
 # Usage info
 show_help()
 {
     cat << EOF
 Usage: ${0##*/} [-hcv] [-j <n>] [--nspr] [--gyp|-g] [--opt|-o] [-m32]
                 [--test] [--fuzz] [--pprof] [--scan-build[=output]]
                 [--asan] [--ubsan] [--msan] [--sancov[=edge|bb|func|...]]
+                [--ct-verif] [--disable-tests]
 
 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:
 
--- a/readme.md
+++ b/readme.md
@@ -29,53 +29,55 @@ Build requirements:
 * [gyp](https://gyp.gsrc.io/)
 * [ninja](https://ninja-build.org/)
 
 After changing into the NSS directory a typical build is done as follows
 
     ./build.sh
 
 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`.
+`../dist/Debug` for debug builds and `../dist/Release` for opt builds.
+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: ${0##*/} [-hcv] [-j <n>] [--nspr] [--gyp|-g] [--opt|-o] [-m32]
+    Usage: build.sh [-hcv] [-j <n>] [--nspr] [--gyp|-g] [--opt|-o] [-m32]
                     [--test] [--fuzz] [--pprof] [--scan-build[=output]]
                     [--asan] [--ubsan] [--msan] [--sancov[=edge|bb|func|...]]
+                    [--ct-verif] [--disable-tests]
 
     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
-        -v            verbose build
-        -j <n>        run at most <n> concurrent jobs
-        --nspr        force a rebuild of NSPR
-        --gyp|-g      force a rerun of gyp
-        --opt|-o      do an opt 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
-        --pprof       build with gperftool support
-        --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
-        --asan        do an asan build
-        --ubsan       do an ubsan build
-                      --ubsan=bool,shift,... sets specific UB sanitizers
-        --msan        do an msan build
-        --sancov      do sanitize coverage builds
-                      --sancov=func sets coverage to function level for example
-
+        -h               display this help and exit
+        -c               clean before build
+        -v               verbose build
+        -j <n>           run at most <n> concurrent jobs
+        --nspr           force a rebuild of NSPR
+        --gyp|-g         force a rerun of gyp
+        --opt|-o         do an opt 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
+        --pprof          build with gperftool support
+        --ct-verif       build with valgrind for ct-verif
+        --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
+        --asan           do an asan build
+        --ubsan          do an ubsan build
+                         --ubsan=bool,shift,... sets specific UB sanitizers
+        --msan           do an msan build
+        --sancov         do sanitize coverage builds
+                         --sancov=func sets coverage to function level for example
+        --disable-tests  don't build tests and corresponding cmdline utils
 
 ## 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