index file

[drom]

Do we have the index yaml file that would allow fetching all the rest of yaml files?

[dhower-qc]

there is no index; it just assumes every .yaml file under arch is included (type is implied by whether it exists in the inst, ext, etc., subfolder).

You can generate a single file with everything in it with ./do gen:arch (will appear in gen/_/arch/arch_def.yaml

[drom]

I am fetching it from the web page, and I can't do ls internet. I need to know list of the files and folders. Assuming that tools outside of this Git project will use yaml file we need sort of index with JSON references. I can do it via GitHub API but it will cost me tokens.

[dhower-qc]

ah, interesting. we could generate the unified description with each push on main (similar to how we keep https://riscv-software-src.github.io/riscv-unified-db/manual/html/landing/index.html updated). Would that work?

[drom]

There is no problem having 1k of yaml files, but if we can just regenerate index.yaml file and add it to the same commit. It would help. If it is uses JSON references then it would simplify things:

{
  arch: {
    inst: {
      A: {
        'amoadd.d': {'$ref': './arcs/inst/A/amoadd.d.yaml'},
        ...

      }
    }
  }
}

https://datatracker.ietf.org/doc/html/draft-pbryan-zyp-json-ref-03

[drom]

I can make quick PoC in JS

[drom]

#201

./index-unifieddb.js ./arch > index.json

[drom]

with index.json I was able to fetch UnifiedDB from GitHub using web client. Here is example:
https://observablehq.com/@drom/risc-v-unifieddb