[Pkg-rust-maintainers] Override file format for debcargo

[Vasudev Kamath]

Hi all,

As per our discussion on IRC and suggestion previously by Josh we
decided to provide override configuration for debcargo so that we can
save the changes needed to update template files created by debcargo.

Here I'm pasting the toml file I've come up with. Please suggest any
changes or improvement

# This section basically to update Source package related fields.
[source]
# This is only needed when bumping S-V. Currently
# debcargo has 4.0.0 hard coded in it.
policy = "4.0.0"

# In case of missing home page in Cargo.toml this field can be used.
homepage = "https://clap.rs"

# These are fields needed to update Package section of control files.
# One each inline table for every binary package produced by debcargo.
[package."librust-clap-2-dev"]
# short description, needed to provide meaningful short description.
summary = "Simple, efficient and full featured Command line argument parser - source"

# This field provides long description. Please note that one need to
# wrap lines at 80 characters. Other formatting as per policy is taken
# care in code.
description = """
clap is used to parse and validate string of command line arguments provided by
user at runtime. It provides help and version flags by default and additionally
provide help subcommands in addition to traditional flags.
This package provides clap with following default features.
 * suggestions: provides did you mean suggestions on typos
 * color: turns on colored error messages.
 * wrap_help: Wrap the help at actual terminal width when available.
"""

# This section is for overriding copyright values. We use inline tables
# for this. File name should come after . between quotes (TOML specs)
# User should note that he should provide both copyright notice and the
# license 
[files."*"]
# This is array and each copyright should be put in this array.
copyright = ["2015-2016, Kevin B. Knapp <kbknapp at gmail.com"]
# License. for the section.
license = "MIT"

[files."debian/*"]
copyright = ["2017, Vasudev Kamath <vasudev at copyninja.info"]
license = "MIT"

All sections have optional value including section itself is optional.
But if user is to override Files: of debian/copyright then he should
provide both copyright notice and license field. This is done to avoid
creating further ambiguity for debcargo developers :-).

Please let me know what you think of the format and share improvement
and changes needed.

Cheers,

-------------- next part --------------
A non-text attachment was scrubbed...
Name: clap_override.toml
Type: application/octet-stream
Size: 832 bytes
Desc: not available
URL: <http://lists.alioth.debian.org/pipermail/pkg-rust-maintainers/attachments/20170705/198a934a/attachment.obj>