As a julia beginner, I struggled with the documentation of Comonicon.toml file a bit. The current documentation is a bit brief to tell me, what a configuration actually means. Specifically, it would be great if the docs of Comonicon.Configs.Install could be improved. I for example mistook the compile parameter for the input to the julia -C option. Whereas it actually requires the input to the julia --compile option. I am currently struggling to build a relocatable binary for a CLI app and ran into this.
Version of the package:
Project sor v0.1.0
Status `/some/path/Project.toml`
[863f3e99] Comonicon v1.0.8
[864edb3b] DataStructures v0.18.20
[51b4e782] H5Zbitshuffle v0.1.2
[f67ccb44] HDF5 v0.17.2
[36e57ca2] <undisclosed package>`
To Reproduce
Use a Comonicon.toml with the following content:
name = "foo"
[install]
compile="generic;skylake;btver2"
This will trigger an error
ERROR: julia: invalid argument to --compile (generic)
Describe the bug
As a
juliabeginner, I struggled with the documentation ofComonicon.tomlfile a bit. The current documentation is a bit brief to tell me, what a configuration actually means. Specifically, it would be great if the docs of Comonicon.Configs.Install could be improved. I for example mistook thecompileparameter for the input to thejulia -Coption. Whereas it actually requires the input to thejulia --compileoption. I am currently struggling to build a relocatable binary for a CLI app and ran into this.Version of the package:
To Reproduce Use a Comonicon.toml with the following content:
This will trigger an error
Expected behavior
More clear and explicit docs.