search

Open-CMSIS-Pack / vidx2pidx

Utility that converts a vendor index file into a vendor independent package index file
Apache License 2.0
3 stars 3 forks source link

How does this tool fit into a development flow? #7

Closed ReinhardKeil closed 1 month ago

ReinhardKeil commented 2 years ago

Not sure what the purpose of 'vidx2pidx' is. When should I use this tool? Is this something that should be used in context with cpackget?

jkrech commented 2 years ago

This tool does what today is e.g. done by the Keil.com server. It reads www.keil.com/pack/Keil.vidx and creates www.keil.com/pack/index.pidx A user could create an index.pidx from a subset of pack vendors by describing their own vidx file. Such a vidx file could also point to none-public locations (internally hosted packs). If such an index.pidx is located in the $CMSIS_PACK_ROOT/.Web folder cpackget would use this information in order to list and download packs.

ReinhardKeil commented 2 years ago

Is using this tool required to setup the flow for cpackget? Or with other words, cpackget does not contain this fucntionality; is it planned to add it?

jkrech commented 2 years ago

No plans currently to merge these two tools into one. The current assumption is that a public index is used: https://github.com/Open-CMSIS-Pack/cpackget#sepecifying-the-working-pack-root-folder

$ cpackget init --pack-root path/to/new/pack-root https://keil.com/pack/index.pidx

In order to update the index file run

$ cpackget index https://keil.com/pack/index.pidx

For the initial installation of a none-public pack you need to run e.g.

cpackget pack add <url>/Vendor.PackName.x.y.z.pack
jkrech commented 1 month ago

This tool should be used by vendors to allow local validation of <vendor>.pidx prior to registering or updating the registry.