Skip to content

Commit

Permalink
update readme, r=ttaubert DONTBUILD
Browse files Browse the repository at this point in the history
Differential Revision: https://nss-review.dev.mozaws.net/D159

--HG--
extra : amend_source : f0eeeab5e9a9fd20862ef44c9d32b86bb87ce62b
extra : histedit_source : ed6ec871fcd97ca9923663a38446e15cd472f425%2C082b74c64e50f941dce9b10b5ff111a619139104
  • Loading branch information
franziskuskiefer committed Jan 19, 2017
1 parent 8d20b63 commit d8a4fc5
Show file tree
Hide file tree
Showing 2 changed files with 29 additions and 26 deletions.
1 change: 1 addition & 0 deletions build.sh
Expand Up @@ -17,6 +17,7 @@ show_help()
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.
Expand Down
54 changes: 28 additions & 26 deletions readme.md
Expand Up @@ -34,15 +34,16 @@ 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.

Expand All @@ -51,26 +52,27 @@ the "lib" directory, e.g., using the `LD_LIBRARY_PATH` or `DYLD_LIBRARY_PATH`.

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)

Expand Down

0 comments on commit d8a4fc5

Please sign in to comment.