Page MenuHomeSoftware Heritage

Document how to write a metadata mapping.

Authored by vlorentz on Mar 28 2019, 4:06 PM.

Diff Detail

rDCIDX Metadata indexer
Automatic diff as part of commit; lint not applicable.
Automatic diff as part of commit; unit tests not applicable.

Event Timeline

vlorentz edited the summary of this revision. (Show Details)

Maybe mentioning somewhere the mapping should be tested (prior to opening a diff ;).

This revision is now accepted and ready to land.Mar 28 2019, 4:19 PM
This revision now requires review to proceed.Mar 29 2019, 10:10 AM
zack requested changes to this revision.Mar 29 2019, 10:36 AM

I've nitpicked only about section naming/intro and some style, the rest LGTM.


Please use a different expression here than "mapping". As we have discussed in the past, it's an implementation detail, not related to the goal that readers of this section will try to achieve.

A concrete suggestion is "Add support for additional ecosystem-specific metadata". ("Ecosystem" is an attempt at being more general than "language" or "package manager", YMMV.) Similarly, adapting the description to mention "mapping" only when it's really needed would be nice.


I don't think this comment belongs there, a developer setup is a prerequisite and we don't want to have to mention it in every single piece of documentation we write.


this anchor looks a bit fragile, maybe just use CodeMeta crosswalks instead ?


s/^Create/Then create/


Link to the actual implementation of the PKG-INFO mapping here, so that people can compare the pseudo-code in this section with a real implementation.


rather: "when it finds a license field in content_dict."

This revision now requires changes to proceed.Mar 29 2019, 10:36 AM
vlorentz added inline comments.

Indeed, I like it.


Indeed. (I initially wrote this in the blog post draft before deciding to move it to the documentation)

vlorentz marked 2 inline comments as done.
  • Apply @zack 's comments.
This revision is now accepted and ready to land.Mar 29 2019, 11:18 AM
This revision was automatically updated to reflect the committed changes.