Skip to content
Snippets Groups Projects
  • Gregory Szorc's avatar
    1f21a6835604
    convert: add config option to copy extra keys from Git commits · 1f21a6835604
    Gregory Szorc authored
    Git commit objects support storing arbitrary key-value metadata. While
    there is no user-facing mechanism in Git to record these values, some
    tools do record data here.
    
    Currently, `hg convert` only handles the "author," "committer," and
    "parent" keys in Git commit objects. All other keys are ignored. This
    means that any custom keys are lost when converting Git repos to
    Mercurial.
    
    This patch implements support for copying a whitelist of extra keys
    from Git commit objects to the "extras" dict of the destination. As
    the added tests demonstate, this allows extra metadata to be preserved
    during the conversion process.
    
    This patch stops short of converting all metadata to "extras." We could
    potentially implement this via `convert.git.extrakeys=*` or similar.
    But copying everything by default is a bit dangerous because if Git
    adds new keys to commit objects, we could find ourselves copying
    things that shouldn't be copied!
    
    This patch also assumes the source key is the same as the destination
    key. We could implement support for prefixing the output key to
    distinguish it as coming from Git. But until this feature is needed,
    I'm inclined to hold off implementing it.
    1f21a6835604
    History
    convert: add config option to copy extra keys from Git commits
    Gregory Szorc authored
    Git commit objects support storing arbitrary key-value metadata. While
    there is no user-facing mechanism in Git to record these values, some
    tools do record data here.
    
    Currently, `hg convert` only handles the "author," "committer," and
    "parent" keys in Git commit objects. All other keys are ignored. This
    means that any custom keys are lost when converting Git repos to
    Mercurial.
    
    This patch implements support for copying a whitelist of extra keys
    from Git commit objects to the "extras" dict of the destination. As
    the added tests demonstate, this allows extra metadata to be preserved
    during the conversion process.
    
    This patch stops short of converting all metadata to "extras." We could
    potentially implement this via `convert.git.extrakeys=*` or similar.
    But copying everything by default is a bit dangerous because if Git
    adds new keys to commit objects, we could find ourselves copying
    things that shouldn't be copied!
    
    This patch also assumes the source key is the same as the destination
    key. We could implement support for prefixing the output key to
    distinguish it as coming from Git. But until this feature is needed,
    I'm inclined to hold off implementing it.