Skip to content
  • John Snow's avatar
    13c24eda
    qemu-img: fix .hx and .texi disparity · 13c24eda
    John Snow authored
    
    
    It turns out that having options listed in three places continues to be
    a bad idea. I'm still toying with the idea of an improved infrastructure
    here, but in the meantime, another bandaid.
    
    There are three locations:
    (1) .hx file, formatted as texi
    (2) .hx file, formatted as human readable.
    (3) .texi file, as section headers, formatted as texi.
    
    You can compare the two summaries within the .hx file like so:
    
    Human-readable command summaries:
    `./qemu-img --help | grep 'Command syntax' -A14`
    Detokenized texi command summaries:
    `grep "@item" qemu-img-cmds.hx | sed -E 's|@var\{([^\}]*?)\}|\1|g'`
    
    You can compare the two separate texi summaries like so:
    
    Texi command summaries:
    `grep "@item" qemu-img-cmds.hx"`
    Texi command headers:
    grep -E "@item.*@var" qemu-img.texi | tail -14
    
    Signed-off-by: default avatarJohn Snow <jsnow@redhat.com>
    Reviewed-by: default avatarMarkus Armbruster <armbru@redhat.com>
    Message-id: 20190409210655.777-1-jsnow@redhat.com
    Signed-off-by: default avatarPeter Maydell <peter.maydell@linaro.org>
    13c24eda
    qemu-img: fix .hx and .texi disparity
    John Snow authored
    
    
    It turns out that having options listed in three places continues to be
    a bad idea. I'm still toying with the idea of an improved infrastructure
    here, but in the meantime, another bandaid.
    
    There are three locations:
    (1) .hx file, formatted as texi
    (2) .hx file, formatted as human readable.
    (3) .texi file, as section headers, formatted as texi.
    
    You can compare the two summaries within the .hx file like so:
    
    Human-readable command summaries:
    `./qemu-img --help | grep 'Command syntax' -A14`
    Detokenized texi command summaries:
    `grep "@item" qemu-img-cmds.hx | sed -E 's|@var\{([^\}]*?)\}|\1|g'`
    
    You can compare the two separate texi summaries like so:
    
    Texi command summaries:
    `grep "@item" qemu-img-cmds.hx"`
    Texi command headers:
    grep -E "@item.*@var" qemu-img.texi | tail -14
    
    Signed-off-by: default avatarJohn Snow <jsnow@redhat.com>
    Reviewed-by: default avatarMarkus Armbruster <armbru@redhat.com>
    Message-id: 20190409210655.777-1-jsnow@redhat.com
    Signed-off-by: default avatarPeter Maydell <peter.maydell@linaro.org>
Loading