Merge lp:~gesha/linaro-license-protection/build-info-doc into lp:~linaro-automation/linaro-license-protection/trunk

[Georgy Redkozubov]

This branch adds description of the BUILD-INFO.txt to the README

[Milo Casagrande (milo)]

Hello Georgy,

merge request looks good to me.

review: Approve

[Deepti B. Kalakeri (deeptik)]

Hello Gesha,

Changes looks fine. Just few typos:

18 +Build-Name: landing-snowball
19 + Would be a unique over all the builds of the same type. For now used as

>> Should be instead "Would be unique over all the builds of the same type. For now used as"

29 +OpenID-Launchpad-Teams: linaro
30 + LP team names members of are allowed to access protected files. No OpenID

>> Should be instead "LP team names, members of which are allowed to access protected files. No OpenID"

33 + Default to 'no' if not present. If the field is set to 'yes' then

>> Should be instead "Defaults to 'no' if not present. If the field is set to 'yes' then"

46 +If no BUILD-INFO,txt is found it falls back to per-file/per-directoryEULA

>> BUILD-INFO,txt should be instead BUILD-INFO.txt include dot instead comma. And "per-file/per-directoryEULA" should be "per-file/per-directory EULA " (missing space befor EULA)

38 +
39 +- If line begins with space character ' ' it is treated as a part of last found
40 +variable which turns as multiline variable and is appended to it.
41 +- Variable names are case insensitive.

Are the line 38 - 41 belong to the description of License-Text: EULA full text included in BUILD-INFO.txt?? If yes then we should remove the blank line present at line 38

Also, line 24 - 28 are not aligned properly when compared to other lines.

review: Needs Fixing

[Georgy Redkozubov (gesha)]

Deepti, thanks for review.
Typos are fixed.

>
> Are the line 38 - 41 belong to the description of License-Text: EULA full text
> included in BUILD-INFO.txt?? If yes then we should remove the blank line
> present at line 38

Lines 38-41 belong not only to License-Text field. It is general agreement, but now we have only that field that can have multiline text.

[lp:~gesha/linaro-license-protection/build-info-doc]

81. By Georgy Redkozubov on 2012-06-19

Fixed typos

[Deepti B. Kalakeri (deeptik)]

27 + then OpenID protection is used, otherwise simple Accept/Decline license
28 + page is displayed before accessing protected files.

Ah! seems like lines 27, 28 show above are still misaligned.

The line "LP team names, members of are allowed to access protected files. No OpenID" Should be
"LP team names, members of which are allowed to access protected files. No OpenID"

Otherwise looks good.

review: Needs Fixing

[Fathi Boudra (fboudra)]

Could you document which fields are mandatory and which fields are optional?

Also the format version deserves to be documented somewhere:
e.g. v0.1 Initial version. Support foo, bar, etc... fields.

I suggest to look at the following documents:
http://www.debian.org/doc/debian-policy/ch-controlfields.html
http://www.debian.org/doc/packaging-manuals/copyright-format/1.0/

review: Needs Fixing

[lp:~gesha/linaro-license-protection/build-info-doc]

82. By Georgy Redkozubov on 2012-06-19

Divided format into paragraphs. Separated fields description from example.

[Georgy Redkozubov (gesha)]

> 27 + then OpenID protection is used, otherwise simple Accept/Decline
> license
> 28 + page is displayed before accessing protected files.
>
> Ah! seems like lines 27, 28 show above are still misaligned.

No :) they both belong to line 26

>
> The line "LP team names, members of are allowed to access protected files. No
> OpenID" Should be
> "LP team names, members of which are allowed to access protected files. No
> OpenID"

fixed

>
> Otherwise looks good.

[Georgy Redkozubov (gesha)]

> Could you document which fields are mandatory and which fields are optional?
>
> Also the format version deserves to be documented somewhere:
> e.g. v0.1 Initial version. Support foo, bar, etc... fields.
>
> I suggest to look at the following documents:
> http://www.debian.org/doc/debian-policy/ch-controlfields.html
> http://www.debian.org/doc/packaging-manuals/copyright-format/1.0/

Updated docs based on your comments. Thanks.

[Fathi Boudra (fboudra)]

some nitpicking:
* Theme and License-Text are optional. They're required _only_ if License-Type is protected.
* BUILD-INFO.txt example isn't valid.
* I will re-order the fields for more clarity:
 - Files-Pattern
 - Build-Name
 - License-Type

review: Needs Fixing

[lp:~gesha/linaro-license-protection/build-info-doc]

83. By Georgy Redkozubov on 2012-06-20

Fixed BUILD-INFO.txt example. Updated description of fields.

[Georgy Redkozubov (gesha)]

> some nitpicking:
> * Theme and License-Text are optional. They're required _only_ if License-Type
> is protected.
> * BUILD-INFO.txt example isn't valid.
> * I will re-order the fields for more clarity:
> - Files-Pattern
> - Build-Name
> - License-Type

Good catch. Fixed.

[Fathi Boudra (fboudra)]

Ship it!

review: Approve

=== modified file 'README'
--- README	2012-05-18 08:29:13 +0000
+++ README	2012-06-20 11:52:12 +0000
@@ -106,6 +106,84 @@
 build steps, and not as publishing steps.
 
 
+Build-Info support
+------------------
+
+BUILD-INFO.txt format
+.....................
+
+Paragraphs
+..........
+
+ * Header paragraph
+ * Files paragraph
+
+Header paragraph (once)
+.......................
+
+The following fields may be present in a header paragraph:
+ * Format-Version: (required)
+    Version of the BUILD-INFO format.
+
+Files paragraph (repeatable)
+............................
+
+The following fields may be present in a files paragraph:
+ * Files-Pattern: (required, must be the first field in the paragraph)
+    Comma separated filename patterns that are specified using a simplified
+    shell glob syntax. Will be used to identify protected files.
+ * Build-Name: (optional)
+    Would be unique over all the builds of the same type. For now used as
+    a placeholder and will be ignored. To be added later by build services?
+ * License-Type: (required)
+    open - Open builds. No license page is displayed.
+    protected - EULA protected builds. If 'OpenID-Launchpad-Teams' is defined
+      then OpenID protection is used, otherwise simple Accept/Decline license
+      page is displayed before accessing protected files.
+ * Theme: (required only if License-Type is 'protected')
+    Acceptable values are: stericsson, samsung.
+    Theme name for selecting proper theming on download and license pages.
+ * OpenID-Launchpad-Teams: (optional)
+    LP team names, members of which are allowed to access protected files. No
+    OpenID protection if absent.
+ * Collect-User-Data: (optional)
+    Acceptable values are: yes, no.
+    Defaults to 'no' if not present. If the field is set to 'yes' then
+    Name and E-Mail (some other fields?) fields are asked to be filled. If it
+    will be needed in the future it could be expanded with
+    'Collect-User-Data-Fields' field later or any other approach.
+ * License-Text: (required only if License-Type is 'protected')
+     EULA full text included in BUILD-INFO.txt
+
+- If line begins with space character ' ' it is treated as a part of last found
+variable which turns as multiline variable and is appended to it.
+- Field names are case insensitive.
+- Fields order doesn't matter, except 'Files-Pattern'
+
+BUILD-INFO.txt example:
+.......................
+
+Format-Version: 0.1
+
+Files-Pattern: *.img, *.tar.bz2
+Build-Name: landing-snowball
+License-Type: protected
+Theme: stericsson
+License-Text: EULA full text displayed to user.
+ You should accept to download file.
+
+Files-Pattern: *.txt
+Bulid-Name: landing-snowball
+License-Type: open
+
+
+License protection script takes information from the BUILD-INFO.txt file placed
+in the same directory as artifacts, finds 'Files-Pattern' block corresponding
+to requested file and applies rules from that block to download procedure.
+If no BUILD-INFO.txt is found it falls back to per-file/per-directory EULA
+protection.
+
+
 Tests
 -----