clspv icon indicating copy to clipboard operation
clspv copied to clipboard

-mfmt=c is not a valid option

Open robquill opened this issue 1 year ago • 1 comments

README.md says:

Emit the binary as a C initializer list, for easy embedding of a shader in in a C or C++ program source:

clspv -mfmt=c foo.cl -o -

Bu it should say:

clspv --output-format=c foo.cl -o -

It also isn't documented in --help. I had to find test/mfmt_c.cl to find out what the right option was.

robquill avatar May 09 '24 10:05 robquill

Thanks for the report. Looks like we forgot the documentation updates when we unified some options.

alan-baker avatar May 10 '24 13:05 alan-baker

It feels like the documentation is there to me:

$ clspv --help | grep -A 4 "output-format"
  --output-format=<value>                                    - Select output format (ll|bc|spv|c)
    =spv                                                     -   Vulkan SPIR-V
    =ll                                                      -   Readable LLVM IR (Stop compilation before clspv specific passes)
    =bc                                                      -   Binary LLVM IR (Stop compilation before clspv specific passes)
    =c                                                       -   C initializer list (of Vulkan SPIR-V)

I'll update the README

rjodinchr avatar May 17 '24 07:05 rjodinchr

Thanks for fixing this.

robquill avatar May 20 '24 10:05 robquill