Re: [ptxdist] [PATCH] license-csv: Add rules to generate CSV license report.

[Andreas Pretzsch <apr@cn-eng.de>]

On Do, 2018-03-29 at 07:29 +0000, Denis OSTERLAND wrote:
> +++ b/scripts/lib/ptxd_make_license_csv.sh
> @@ -0,0 +1,16 @@
> +#! /bin/bash
> +#
> +# Copyright (C) 2017 by Denis Osterland <Denis.Osterland@diehl.com>
> +#
> +
> +ptxd_make_license_csv() {
> +       declare -A pkg_license_flags
> +       ptxd_make_world_license_init || return
> +
> +       if [ "${pkg_section}" != "ignore" ]
> +               then
> +               echo "${pkg_label};${pkg_version};${pkg_section};
> ${pkg_license};${pkg_url}" > ${pkg_license_dir}/report.csv
> +               fi
> +}
> +export -f ptxd_make_license_csv 

Extending the field list by section is a good point, thanks. Will do.

But I would refrain from including the URL (for now), simply as it will
include all sorts of characters, which then will require proper
escaping. And in 20+ years, I've seen way too many broken parsers (and
escapers)...
Beside, the key point of the CSV list (to me / customers) is to have a
diff'able list of included packages (which ones, version, license),
beside the full fledged report. To see if one needs to look into
something. So URL is nice, but not mandatory.

Last, about the CSV separator, I chose | out of experience, avoiding
most collisions. Both , and ; show up often in text and even version
tags. Yes, they are marked as string with "", but back to "broken
parsers"...

So I still tend to a CSV output like:

"name"|"version"|"section"|"licenses"|"flags"
"somepackage"|"1.2.3"|"osi-conform"|"Apache-2.0"|"attribution"
[...]


Denis, what do you think ?
Michael, any experience/opinion on this ?

Best regards,
  Andreas

-- 

carpe noctem engineering
Ingenieurbuero fuer Hard- & Software-Entwicklung Andreas Pretzsch
Dipl.-Ing. (FH) Andreas Pretzsch        Tel. +49-(0)7307-936088-1
Lange Strasse 28a                       Fax: +49-(0)7307-936088-9
89250 Senden, Germany                   email: apr@cn-eng.de


_______________________________________________
ptxdist mailing list
ptxdist@pengutronix.de