[ptxdist] How to generate license report?

[ptxdist] How to generate license report?

[Alexander Dahl]

Hello,

from the Git repository and some hints in the ptxdist source code I assume 
ptxdist can generate some kind of license report, based on the FOO_LICENSE 
variables in each packages make rule. However I could not find any hint on how 
to generate this report in:

* documentation (ptxdist docs-html or on ptxdist.org)
* `ptxdist --help`
* `ptxdist`
* sourcecode of ptxdist

Is it possible to generate such a report? How?

Greets
Alex


_______________________________________________
ptxdist mailing list
ptxdist@pengutronix.de

[ptxdist] [PATCH] ptxdist: Add switch to generate PDF license report.

[Denis OSTERLAND]

Signed-off-by: Denis Osterland <Denis.Osterland@diehl.com>
---
 rules/license-report.in   | 6 ++++++
 rules/license-report.make | 3 +++
 2 files changed, 9 insertions(+)
 create mode 100644 rules/license-report.in
 create mode 100644 rules/license-report.make

diff --git a/rules/license-report.in b/rules/license-report.in
new file mode 100644
index 0000000..9d15a7f
--- /dev/null
+++ b/rules/license-report.in
@@ -0,0 +1,6 @@
+## SECTION=ptxdist_options
+
+config PROJECT_LICENSE_REPORT
+	bool "PDF license report"
+
+
diff --git a/rules/license-report.make b/rules/license-report.make
new file mode 100644
index 0000000..44745fe
--- /dev/null
+++ b/rules/license-report.make
@@ -0,0 +1,3 @@
+
+images: $(if $(PTXCONF_PROJECT_LICENSE_REPORT),license-report)
+
-- 
2.7.4


Diehl AKO Stiftung & Co. KG, Pfannerstraße 75-83, 88239 Wangen im Allgäu
Bereichsvorstand: Dr.-Ing. Michael Siedentop (Sprecher), Josef Fellner (Mitglied)
Sitz der Gesellschaft: Wangen i.A. – Registergericht: Amtsgericht Ulm HRA 620609 – Persönlich haftende Gesellschafterin: Diehl Verwaltungs-Stiftung – Sitz: Nürnberg – Registergericht: Amtsgericht Nürnberg HRA 11756 –
Vorstand: Dr.-Ing. E.h. Thomas Diehl (†) (Vorsitzender), Herr Dipl.-Wirtsch.-Ing. Wolfgang Weggen (stellvertretender Vorsitzender), Dipl.-Kfm. Claus Günther, Dipl.-Kfm. Frank Gutzeit, Dr.-Ing. Heinrich Schunk, Dr.-Ing. Michael Siedentop , Dipl.-Kfm. Dr.-Ing. Martin Sommer, Dipl.-Ing. (FH) Rainer von Borstel, Vorsitzender des Aufsichtsrates: Dr. Klaus Maier
___________________________________________________________________________________________________
Der Inhalt der vorstehenden E-Mail ist nicht rechtlich bindend. Diese E-Mail enthaelt vertrauliche und/oder rechtlich geschuetzte Informationen.
Informieren Sie uns bitte, wenn Sie diese E-Mail faelschlicherweise erhalten haben. Bitte loeschen Sie in diesem Fall die Nachricht. Jede unerlaubte Form der Reproduktion, Bekanntgabe, Aenderung, Verteilung und/oder Publikation dieser E-Mail ist strengstens untersagt.
The contents of the above mentioned e-mail is not legally binding. This e-mail contains confidential and/or legally protected information. Please inform us if you have received this e-mail by mistake and delete it in such a case. Each unauthorized reproduction, disclosure, alteration, distribution and/or publication of this e-mail is strictly prohibited.

_______________________________________________
ptxdist mailing list
ptxdist@pengutronix.de

Re: [ptxdist] How to generate license report?

[Roland Hieber]

On 22.03.2018 10:51, Alexander Dahl wrote:
> Hello,
> 
> from the Git repository and some hints in the ptxdist source code I assume
> ptxdist can generate some kind of license report, based on the FOO_LICENSE
> variables in each packages make rule. However I could not find any hint on how
> to generate this report in:
> 
> * documentation (ptxdist docs-html or on ptxdist.org)
> * `ptxdist --help`
> * `ptxdist`
> * sourcecode of ptxdist
> 
> Is it possible to generate such a report? How?

This should probably be documented. You can get it via

    $ ptxdist make license-report

  - Roland

_______________________________________________
ptxdist mailing list
ptxdist@pengutronix.de

[ptxdist] [PATCH] doc: ref parameter: document special make target 'license-report'

[Roland Hieber]

Signed-off-by: Roland Hieber <r.hieber@pengutronix.de>
---
 doc/ref_parameter.inc | 5 +++++
 1 file changed, 5 insertions(+)

diff --git a/doc/ref_parameter.inc b/doc/ref_parameter.inc
index 7763f74ba..73269ab19 100644
--- a/doc/ref_parameter.inc
+++ b/doc/ref_parameter.inc
@@ -217,6 +217,11 @@ Misc Actions
 ``make <target>``
   build specified make target in PTXdist.
 
+``make license-report``
+  build a license report. This report shows up in
+  ``platform-<name>/report/license-report.pdf`` and contains all open-source
+  licenses for each package that is used in the project.
+
 ``export_src <target-dir>``
   export all source archives needed for this project to ``<target-dir>``.
 
-- 
2.11.0


_______________________________________________
ptxdist mailing list
ptxdist@pengutronix.de

Re: [ptxdist] How to generate license report?

[Michael Olbrich]

Hi,

On Mon, Mar 26, 2018 at 09:44:17AM +0200, Roland Hieber wrote:
> On 22.03.2018 10:51, Alexander Dahl wrote:
> > from the Git repository and some hints in the ptxdist source code I assume
> > ptxdist can generate some kind of license report, based on the FOO_LICENSE
> > variables in each packages make rule. However I could not find any hint on how
> > to generate this report in:
> > 
> > * documentation (ptxdist docs-html or on ptxdist.org)
> > * `ptxdist --help`
> > * `ptxdist`
> > * sourcecode of ptxdist
> > 
> > Is it possible to generate such a report? How?
> 
> This should probably be documented. You can get it via
> 
>    $ ptxdist make license-report

That's currently the way to do this. It's not documented because I actually
want to hook this up somewhere. But I'm not sure where exactly.

I want to move this stuff out of rules/post/ and do something similar to
the image rules. And then hook up these new packages these packages
somewhere. I'm not sure 'world' is the correct place, so a new command
'ptxdist license-report'?
Any opinions on this?

Michael

-- 
Pengutronix e.K.                           |                             |
Industrial Linux Solutions                 | http://www.pengutronix.de/  |
Peiner Str. 6-8, 31137 Hildesheim, Germany | Phone: +49-5121-206917-0    |
Amtsgericht Hildesheim, HRA 2686           | Fax:   +49-5121-206917-5555 |

_______________________________________________
ptxdist mailing list
ptxdist@pengutronix.de

Re: [ptxdist] How to generate license report?

[Alexander Dahl]

[-- Attachment #1.1: Type: text/plain, Size: 853 bytes --]

Hello,

On Tue, Mar 27, 2018 at 09:43:35AM +0200, Michael Olbrich wrote:
> I want to move this stuff out of rules/post/ and do something similar to
> the image rules. And then hook up these new packages these packages
> somewhere. I'm not sure 'world' is the correct place, so a new command
> 'ptxdist license-report'?
> Any opinions on this?

From user side of view, a new command would be easy to find, that's
where I looked in the first place. Having the license-report kind of
parallel to creating 'images' or 'docs' seems reasonable to me.

Greets
Alex

-- 
»With the first link, the chain is forged. The first speech censured, 
the first thought forbidden, the first freedom denied, chains us all 
irrevocably.« (Jean-Luc Picard, quoting Judge Aaron Satie)
*** GnuPG-FP: C28E E6B9 0263 95CF 8FAF  08FA 34AD CD00 7221 5CC6 ***

[-- Attachment #1.2: signature.asc --]
[-- Type: application/pgp-signature, Size: 833 bytes --]

[-- Attachment #2: Type: text/plain, Size: 91 bytes --]

_______________________________________________
ptxdist mailing list
ptxdist@pengutronix.de

Re: [ptxdist] How to generate license report?

[Alm, Michael]

Hi,

On Tue, Mar 27, 2018 at 09:43:35AM +0200, Michael Olbrich wrote:
> > > Is it possible to generate such a report? How?
> > 
> > This should probably be documented. You can get it via
> > 
> >    $ ptxdist make license-report
>
> That's currently the way to do this. It's not documented because I 
> actually want to hook this up somewhere. But I'm not sure where exactly.
>
> I want to move this stuff out of rules/post/ and do something similar to the image rules. 
> And then hook up these new packages these packages somewhere. I'm not sure 'world' 
> is the correct place, so a new command 'ptxdist license-report'?
> Any opinions on this?

Sounds ok for me. It might also be useful to only generate a license report including the target or 
host packages. In many cases only the target license report is of interest to the final customer.
So the command might look something like this:

'ptxdist license-report'   generates 2 reports: 1 for the target and 1 for the host packages
'ptxdist license-report target'   generates  1 report including the target packages only
'ptxdist license-report host'   generates  1 report including the host packages only

Also, it would be helpful to have a short-list with the package name, version and license 
type only, without all the license text. Maybe like this:

'ptxdist license-report target short'

foo, 1.0, BSD
bar, 2.8.1.5, GPLv2
...


Greets,
Michael


_______________________________________________
ptxdist mailing list
ptxdist@pengutronix.de

Re: [ptxdist] How to generate license report?

[Andreas Pretzsch]

On Di, 2018-03-27 at 09:26 +0000, Alm, Michael wrote:
> Also, it would be helpful to have a short-list with the package name, version and license 
> type only, without all the license text. Maybe like this:
> 
> 'ptxdist license-report target short'
> 
> foo, 1.0, BSD
> bar, 2.8.1.5, GPLv2
> ...

Have a look at my patchset "license-report: also create CSV lists" just
sent to the list. It adds CSV generation to the regular process
(triggered by "ptxdist make license-report").
It might already solve your task.

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

Re: [ptxdist] How to generate license report?

[Denis OSTERLAND]

We did something similar, some time ago.
We have used make dependencies to generate csv along with pdf report.
I have sent the patch to list.

Regards Denis
Am Mittwoch, den 28.03.2018, 22:31 +0200 schrieb Andreas Pretzsch:
> On Di, 2018-03-27 at 09:26 +0000, Alm, Michael wrote:
> > 
> > Also, it would be helpful to have a short-list with the package name, version and license 
> > type only, without all the license text. Maybe like this:
> > 
> > 'ptxdist license-report target short'
> > 
> > foo, 1.0, BSD
> > bar, 2.8.1.5, GPLv2
> > ...
> Have a look at my patchset "license-report: also create CSV lists" just
> sent to the list. It adds CSV generation to the regular process
> (triggered by "ptxdist make license-report").
> It might already solve your task.
> 
> Best regards,
>   Andreas
> 
Diehl AKO Stiftung & Co. KG, Pfannerstraße 75-83, 88239 Wangen im Allgäu
Bereichsvorstand: Dr.-Ing. Michael Siedentop (Sprecher), Josef Fellner (Mitglied)
Sitz der Gesellschaft: Wangen i.A. – Registergericht: Amtsgericht Ulm HRA 620609 – Persönlich haftende Gesellschafterin: Diehl Verwaltungs-Stiftung – Sitz: Nürnberg – Registergericht: Amtsgericht Nürnberg HRA 11756 –
Vorstand: Dr.-Ing. E.h. Thomas Diehl (†) (Vorsitzender), Herr Dipl.-Wirtsch.-Ing. Wolfgang Weggen (stellvertretender Vorsitzender), Dipl.-Kfm. Claus Günther, Dipl.-Kfm. Frank Gutzeit, Dr.-Ing. Heinrich Schunk, Dr.-Ing. Michael Siedentop , Dipl.-Kfm. Dr.-Ing. Martin Sommer, Dipl.-Ing. (FH) Rainer von Borstel, Vorsitzender des Aufsichtsrates: Dr. Klaus Maier
___________________________________________________________________________________________________
Der Inhalt der vorstehenden E-Mail ist nicht rechtlich bindend. Diese E-Mail enthaelt vertrauliche und/oder rechtlich geschuetzte Informationen.
Informieren Sie uns bitte, wenn Sie diese E-Mail faelschlicherweise erhalten haben. Bitte loeschen Sie in diesem Fall die Nachricht. Jede unerlaubte Form der Reproduktion, Bekanntgabe, Aenderung, Verteilung und/oder Publikation dieser E-Mail ist strengstens untersagt.
The contents of the above mentioned e-mail is not legally binding. This e-mail contains confidential and/or legally protected information. Please inform us if you have received this e-mail by mistake and delete it in such a case. Each unauthorized reproduction, disclosure, alteration, distribution and/or publication of this e-mail is strictly prohibited.
_______________________________________________
ptxdist mailing list
ptxdist@pengutronix.de