travitch / build-bom

Dynamically discover the commands used to create a piece of software
Apache License 2.0
45 stars 8 forks source link

README: Update documentation of CLI flags #33

Closed langston-barrett closed 2 years ago

langston-barrett commented 2 years ago
build-bom-generate-bitcode 0.2.0

USAGE:
    build-bom generate-bitcode [FLAGS] [OPTIONS] [-- <command>...]

FLAGS:
    -h, --help                        Prints help information
        --suppress-automatic-debug    Prevent `build-bom` from automatically injecting flags to generate debug
                                      information in bitcode files
    -V, --version                     Prints version information
    -v, --verbose                     Generate verbose output

OPTIONS:
    -b, --bc-out <bcout-path>
            Directory to place LLVM bitcode (bc) output data.  The default is to place it next to the object file, but
            it must be accessible by a subsequent Extract operation and some build tools build in a temporary directory
            that is disposed of at the end of the build (e.g. CMake) 
        --clang <clang-path>
            Name of the clang binary to use to generate bitcode (default: `clang`)

        --inject-argument <inject-arguments>...
            Have `build-bom` inject the given argument into the argument list when generating bitcode

        --remove-argument <remove-arguments>...
            Have `build-bom` remove arguments matching the given regular expression when generating bitcode

ARGS:
    <command>...    The build command to run