svn commit: r428845 - in head/devel: . py-XStatic py-XStatic-Angular py-XStatic-Angular-Bootstrap py-XStatic-Angular-FileUpload py-XStatic-Angular-Gettext py-XStatic-Angular-Schema-Form py-XStatic-...

[Alexander Nusov]

Hello,

I agree that adding README content will not bring a lot of value but I'm going to make them more meaningful. 



XStatic-Angular-Bootstrap 2.2.0.0



current COMMENT: 

Angular-Bootstrap 2.2.0 (XStatic packaging standard)

proposed COMMENT:

XStatic package for angular-bootstrap 2.2.0 module


However I don't understand what do you mean for "Do not include the package name or version number of software." in this case,



You may notice that versioning for xstatic modules is a bit different

XStatic-Angular-Cookies 1.2.1.1 module bundles angular-cookies module (from npmjs.org) version 1.2.1. The last part (.1) is the xstatic thing.



What about:

XStatic package for AngularJS module for cookies?



But in frontend world for one task you may find a dozen of different modules.

angular-cookies

angular-cookie

ng-cookie

ng2-cookie



If we drop the javascript (npm) module name in COMMENT it would not be clear what npm module the port provides.





--

thanks,

alex


---- On Sun, 18 Dec 2016 17:26:28 +0300 Mathieu Arnold <mat at FreeBSD.org> wrote ----




Le 18/12/2016 à 14:52, Roman Bogorodskiy a écrit : 

> Mathieu Arnold wrote: 

> 

>> Le 18/12/2016 à 12:36, Roman Bogorodskiy a écrit : 

>>> +COMMENT=    Xstatic-angular-bootstrap 

>>> 

>>> Added: head/devel/py-XStatic-Angular-Bootstrap/pkg-descr 

>>> ============================================================================== 

>>> --- /dev/null    00:00:00 1970    (empty, because file is newly added) 

>>> +++ head/devel/py-XStatic-Angular-Bootstrap/pkg-descr    Sun Dec 18 11:36:26 2016    (r428845) 

>>> @@ -0,0 +1,3 @@ 

>>> +XStatic-Angular-Bootstrap 

>>> + 

>>> +WWW: http://pypi.python.org/pypi/XStatic-Angular-Bootstrap 

>>> +COMMENT=    Angular-fileupload 12.0.4 (xstatic packaging standard) 

>>> 

>>> Added: head/devel/py-XStatic-Angular-FileUpload/pkg-descr 

>>> ============================================================================== 

>>> --- /dev/null    00:00:00 1970    (empty, because file is newly added) 

>>> +++ head/devel/py-XStatic-Angular-FileUpload/pkg-descr    Sun Dec 18 11:36:26 2016    (r428845) 

>>> @@ -0,0 +1,3 @@ 

>>> +Angular-FileUpload 12.0.4 (XStatic packaging standard) 

>>> + 

>>> +WWW: http://pypi.python.org/pypi/XStatic-Angular-FileUpload 

>> ... 

>> 

>> I understand those were mechanically created, but all the COMMENT[1] and 

>> pkg-descr[2] files fall very short of our requirements. 

>> 

>> 1: 

>> https://www.freebsd.org/doc/en/books/porters-handbook/makefile-comment.html 

>> 

>> 2: https://www.freebsd.org/doc/en/books/porters-handbook/porting-desc.html 

> This is generally an information obtained from the corresponding Python 

> packages. E.g. for XStatic-Angular-FileUpload we only have: 

 

Let me quote one of the rules for COMMENT: 

 

2) Do not include the package name or version number of software. 

 

The fact that python does not enforce rules on their packages does not 

mean we do not. 

 

> We probably can add README contents to pkg-descr (I'm not sure it brings 

> a lot of value though, it looks likes it's more or less common for these 

> packages with only package name changed), but I'm not sure how can we 

> improve COMMENT. 

 

Please read the handbook links I gave you. COMMENT is a short, one line, 

description of the software. pkg-descr is a longer description, it 

should tell me what does, what it is, why it is usefull. 

Especially, I should not have to go to the web site to understand those 

things. 

 

 

-- 

Mathieu Arnold