Date: Thu, 9 Aug 2018 08:29:36 -0600 From: Adam Weinberger <adamw@adamw.org> To: feld@feld.me Cc: zi@freebsd.org, mat@freebsd.org, ports-committers@freebsd.org, svn-ports-all@freebsd.org, svn-ports-head@freebsd.org Subject: Re: svn commit: r476670 - in head/devel: . rubygem-solve Message-ID: <CAP7rwcj63DtLhA0r_eZ6HafYJiPfTR6u6GG3eqOd=DSmWa7d=g@mail.gmail.com> In-Reply-To: <8632EEE8-AFFE-4BE6-8E58-CE83F7C9036E@feld.me> References: <201808081953.w78Jr68X078029@repo.freebsd.org> <CAP7rwciJj9U0TOEvnwSCc2hCWh_NF44pPjHfmQRu8MGCYq24AA@mail.gmail.com> <20180808202929.GA63276@exodus.zi0r.com> <20180808213446.gktmjqcyrfhjkrlk@atuin.in.mat.cc> <20180808215702.GB52659@exodus.zi0r.com> <CAP7rwcimLHj2eAYYfXAd609N=14RT8_SJFU2H1qZFk9Yk05sbg@mail.gmail.com> <8632EEE8-AFFE-4BE6-8E58-CE83F7C9036E@feld.me>
next in thread | previous in thread | raw e-mail | index | archive | help
On Thu, Aug 9, 2018 at 6:30 AM Mark Felder <feld@feld.me> wrote: > > > > > On Aug 8, 2018, at 17:18, Adam Weinberger <adamw@adamw.org> wrote: > > > > On Wed, Aug 8, 2018 at 3:57 PM Ryan Steinmetz <zi@freebsd.org> wrote: > >> > >> > >> On (08/08/18 23:34), Mathieu Arnold wrote: > >>>>> Ryan, > >>>>> > >>>>> You've just added a number of ports with uninformative pkg-descrs, = and > >>>>> unhelpful COMMENT strings. These aren't merely formalities. Users > >>>>> should be able to read the pkg-descr and understand if it's the rig= ht > >>>>> package for them, and COMMENT is the first target for searches. > >>>>> Please, go back over them and, at the very least, expand the pkg-de= scr > >>>>> files with more information. As a general rule, pkg-descr should NE= VER > >>>>> be the same text as the COMMENT. > >>>> > >>>> Adam, > >>>> > >>>> These are the description strings from authors of the code. They ca= me from > >>>> either rubygems.org and/or the gem source repository. For example, = in the > >>>> case of rubygem-solve: > >>>> > >>>> https://rubygems.org/gems/solve > >>>> > >>>> https://github.com/berkshelf/solve > >>>> > >>>> If you have any specific things you would like to see added to any o= f the > >>>> individual ports, please let me know. > >>> > >>> pkg-descr must contain sentences, something that can be read. It must= at > >>> least be two lines long, so that it is descriptive enough. The fact > >>> that upstream is crappy does not mean you can put he same crap in the > >>> ports tree. It is your job as committer to make sure that ports conf= orm > >>> to our policies and requirements. If upstream does not provide a bet= ter > >>> decription, create one, basd on your knowledge of the software. > >> > >> > >> https://svnweb.freebsd.org/ports/head/devel/p5-Data-Serializer-Sereal/= pkg-descr?revision=3D401986&view=3Dmarkup > >> > >> https://svnweb.freebsd.org/ports/head/net/rubygem-epp-client-afnic/pkg= -descr?revision=3D380380&view=3Dmarkup > >> > >> https://svnweb.freebsd.org/ports/head/net/rubygem-epp-client-smallregi= stry/pkg-descr?view=3Dmarkup > >> > >> https://svnweb.freebsd.org/ports/head/net/rubygem-epp-client-secdns/pk= g-descr?revision=3D380380&view=3Dmarkup > > > > Ryan, what exactly is it that you're arguing in favour of here? All I > > requested was for you to please add some helpful information in the > > descrs where possible. So far you've argued that uninformative descrs > > are okay as long as you copied it from someone else, and that > > uninformative descrs are okay because you're not the only one who does > > it. > > > > I'm trying to get people on board with fixing what's been an ongoing > > problem in our ports. You've agreed with the problem, but not the > > solution. If you have another solution to terse descrs that's > > different from putting more information in descrs, I'm eager to hear > > it. > > > > Adam, please stop. You cannot honestly expect committers to invent descri= ptions for ports that have zero documentation. I have plenty of ports mysel= f that only exist in the tree because I had to chase dependencies for the s= oftware I intended to port. Most of these are libraries that have non-descr= ipt or "too-clever" names and of which I have no idea what their function i= s. It is not my responsibility nor the responsibility of any committer to f= ix this problem. Okay, heard. I'll drop it. I don't think that copying and pasting the first sentence or two of the documentation that every module/library provides on the WWW is onerous, but if it's not our responsibility then it's not our responsibility. # Adam --=20 Adam Weinberger adamw@adamw.org https://www.adamw.org
Want to link to this message? Use this URL: <https://mail-archive.FreeBSD.org/cgi/mid.cgi?CAP7rwcj63DtLhA0r_eZ6HafYJiPfTR6u6GG3eqOd=DSmWa7d=g>