Skip site navigation (1)Skip section navigation (2)
Date:      Sun, 18 Dec 2016 17:51:03 +0300
From:      Alexander Nusov <alexander.nusov@nfvexpress.com>
To:        "Mathieu Arnold" <mat@FreeBSD.org>
Cc:        "Roman Bogorodskiy" <bogorodskiy@gmail.com>,  "Roman Bogorodskiy" <novel@FreeBSD.org>,  "" <ports-committers@freebsd.org>, "" <svn-ports-all@freebsd.org>,  "" <svn-ports-head@freebsd.org>
Subject:   Re: 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-...
Message-ID:  <159126a267f.e5a6cf2011970.2285015541543481905@nfvexpress.com>
In-Reply-To: <c689af30-28b1-b321-12c6-96d5d5c00b68@FreeBSD.org>
References:  <201612181136.uBIBaQLG037821@repo.freebsd.org> <56123f95-c5dc-1e3a-3db5-d87043949c45@FreeBSD.org> <20161218135215.GA48900@kloomba> <c689af30-28b1-b321-12c6-96d5d5c00b68@FreeBSD.org>

next in thread | previous in thread | raw e-mail | index | archive | help
Hello,

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



XStatic-Angular-Bootstrap 2.2.0.0



current COMMENT:=20

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 module=
s.

angular-cookies

angular-cookie

ng-cookie

ng2-cookie



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





--

thanks,

alex


---- On Sun, 18 Dec 2016 17:26:28 +0300 Mathieu Arnold &lt;mat@FreeBSD.org&=
gt; wrote ----




Le 18/12/2016 =C3=A0 14:52, Roman Bogorodskiy a =C3=A9crit :=20

&gt; Mathieu Arnold wrote:=20

&gt;=20

&gt;&gt; Le 18/12/2016 =C3=A0 12:36, Roman Bogorodskiy a =C3=A9crit :=20

&gt;&gt;&gt; +COMMENT=3D    Xstatic-angular-bootstrap=20

&gt;&gt;&gt;=20

&gt;&gt;&gt; Added: head/devel/py-XStatic-Angular-Bootstrap/pkg-descr=20

&gt;&gt;&gt; =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=
=3D=3D=3D=3D=3D=3D=3D=3D=20

&gt;&gt;&gt; --- /dev/null    00:00:00 1970    (empty, because file is newl=
y added)=20

&gt;&gt;&gt; +++ head/devel/py-XStatic-Angular-Bootstrap/pkg-descr    Sun D=
ec 18 11:36:26 2016    (r428845)=20

&gt;&gt;&gt; @@ -0,0 +1,3 @@=20

&gt;&gt;&gt; +XStatic-Angular-Bootstrap=20

&gt;&gt;&gt; +=20

&gt;&gt;&gt; +WWW: http://pypi.python.org/pypi/XStatic-Angular-Bootstrap=20

&gt;&gt;&gt; +COMMENT=3D    Angular-fileupload 12.0.4 (xstatic packaging st=
andard)=20

&gt;&gt;&gt;=20

&gt;&gt;&gt; Added: head/devel/py-XStatic-Angular-FileUpload/pkg-descr=20

&gt;&gt;&gt; =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=
=3D=3D=3D=3D=3D=3D=3D=3D=20

&gt;&gt;&gt; --- /dev/null    00:00:00 1970    (empty, because file is newl=
y added)=20

&gt;&gt;&gt; +++ head/devel/py-XStatic-Angular-FileUpload/pkg-descr    Sun =
Dec 18 11:36:26 2016    (r428845)=20

&gt;&gt;&gt; @@ -0,0 +1,3 @@=20

&gt;&gt;&gt; +Angular-FileUpload 12.0.4 (XStatic packaging standard)=20

&gt;&gt;&gt; +=20

&gt;&gt;&gt; +WWW: http://pypi.python.org/pypi/XStatic-Angular-FileUpload=
=20

&gt;&gt; ...=20

&gt;&gt;=20

&gt;&gt; I understand those were mechanically created, but all the COMMENT[=
1] and=20

&gt;&gt; pkg-descr[2] files fall very short of our requirements.=20

&gt;&gt;=20

&gt;&gt; 1:=20

&gt;&gt; https://www.freebsd.org/doc/en/books/porters-handbook/makefile-com=
ment.html=20

&gt;&gt;=20

&gt;&gt; 2: https://www.freebsd.org/doc/en/books/porters-handbook/porting-d=
esc.html=20

&gt; This is generally an information obtained from the corresponding Pytho=
n=20

&gt; packages. E.g. for XStatic-Angular-FileUpload we only have:=20

=20

Let me quote one of the rules for COMMENT:=20

=20

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

=20

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

mean we do not.=20

=20

&gt; We probably can add README contents to pkg-descr (I'm not sure it brin=
gs=20

&gt; a lot of value though, it looks likes it's more or less common for the=
se=20

&gt; packages with only package name changed), but I'm not sure how can we=
=20

&gt; improve COMMENT.=20

=20

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

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

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

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

things.=20

=20

=20

--=20

Mathieu Arnold=20

=20

=20









Want to link to this message? Use this URL: <https://mail-archive.FreeBSD.org/cgi/mid.cgi?159126a267f.e5a6cf2011970.2285015541543481905>