Documentation

[eine]

The format of hdl-prj.json is currently undocumented. This is expected, since it is in a very early development stage and it is subject to change very frequently. However, since it is the only approach to set GHDL options (such as --std), it might be frustrating for new users to try this tool without any reference. We'll use this issue to collect pieces of information to allow any user to have a hopefully satisfying first experience.

---

Example hdl-prj.json file for VUnit's examples/vhdl/array_axis_vcs:

{
    "options": {
        "ghdl_analysis": [
            "--std=08",
            "-Pvunit_out/ghdl/libraries/osvvm",
            "-Pvunit_out/ghdl/libraries/vunit_lib"
        ]
    },
    "files": [
        { "file": "src/fifo.vhd", "language": "vhdl" },
        { "file": "src/axis_buffer.vhd", "language": "vhdl" },
        { "file": "src/test/tb_axis_loop.vhd", "language": "vhdl" }
    ]
}

NOTE: VUnit sources must be compiled (by executing python run.py -c) for ghdl-ls to find the definitions.

---

At some point it might be useful to provide a json-schema.

---

A link to a demo in play-with-docker would let users try the VSC extension without a local docker installation.