Hi Jody,
sure not a problem, I can back off the commit that does the massive change
and re-run the script later. When will you be done with the mbstyle bit?
Cheers
Andrea
On Sun, Feb 2, 2020 at 11:22 AM Jody Garnett <jody.garn...@gmail.com> wrote:
> I have been fixing some of that stuff for mbstyle by hand. So I would be
> pretty much assured a conflict.
>
> Can we coordinate and run your see after?
>
> On Sun, Feb 2, 2020 at 11:01 AM Andrea Aime <andrea.a...@geo-solutions.it>
> wrote:
>
>> Hi all,
>> the github dependabot opened a PR to upgrade checkstyle, as it has a
>> vulnerability... don't think we'd
>> be much affected, but the bot is going to be persistent and open new PRs
>> for it in the future, so I've
>> tried to fix it.
>>
>> There is however a catch... checkstyle changed enough that our current
>> rule set needed amending,
>> removing references to rules that have been deprecated and removed in the
>> meantime.
>> Checkstyle also became more strict, and it's now reporting dangling
>> undocumented parameters
>> (before it was reporting only dangling _documented_ parameters, ignoring
>> the undocumented ones).
>>
>> Went down the rabbit hole, and found myself fixing tens of errors per
>> module... too many to handle
>> by hand on a 120+ modules project. Also, I was fixing one time removing
>> the param, another time fixing
>> its name... inconsistent.
>>
>> Finding dangling params is hard, but finding undocumented ones is
>> easy.... while I was at it I run
>> seds to remove all undocumented params, returns, and throws tags as they
>> really add nothing (once
>> upon a time they were used by completion engines, before bytecode
>> libraries became widespread).
>> Here is the cleanup action:
>>
>> find . -name "*.java" -exec sed -E -i "/^.*@param\s\w+\s*$/d" {} \;
>> find . -name "*.java" -exec sed -E -i "/^.*@param\s*$/d" {} \;
>> find . -name "*.java" -exec sed -E -i "/^.*@return\s*$/d" {} \;
>> find . -name "*.java" -exec sed -E -i "/^.*@throws\s\w+\s*$/d" {} \;
>>
>> I did find one case where the param was on a line, and the description on
>> the next... and could surely
>> use a second pair of eyes to spot the few other cases where this might
>> also happened (I stared
>> at the diff for half an hour without spotting others):
>> https://github.com/geotools/geotools/pull/2781
>>
>> The ugly side... 1500+ files modified, there were a lot of undocumented
>> tags!
>>
>> If there are no objections, I'll merge this one and backport the changes
>> to the stable and maintenance
>> branches, to avoid backport nightmares in the next few months
>>
>> Cheers
>> Andrea
>>
>> == GeoServer Professional Services from the experts! Visit
>> http://goo.gl/it488V for more information. == Ing. Andrea Aime @geowolf
>> Technical Lead GeoSolutions S.A.S. Via di Montramito 3/A 55054 Massarosa
>> <https://www.google.com/maps/search/Via+di+Montramito+3%2FA%0D%0A55054++Massarosa?entry=gmail&source=g>
>> (LU) phone: +39 0584 962313 fax: +39 0584 1660272 mob: +39 339 8844549
>> http://www.geo-solutions.it http://twitter.com/geosolutions_it
>> ------------------------------------------------------- *Con riferimento
>> alla normativa sul trattamento dei dati personali (Reg. UE 2016/679 -
>> Regolamento generale sulla protezione dei dati “GDPR”), si precisa che ogni
>> circostanza inerente alla presente email (il suo contenuto, gli eventuali
>> allegati, etc.) è un dato la cui conoscenza è riservata al/i solo/i
>> destinatario/i indicati dallo scrivente. Se il messaggio Le è giunto per
>> errore, è tenuta/o a cancellarlo, ogni altra operazione è illecita. Le
>> sarei comunque grato se potesse darmene notizia. This email is intended
>> only for the person or entity to which it is addressed and may contain
>> information that is privileged, confidential or otherwise protected from
>> disclosure. We remind that - as provided by European Regulation 2016/679
>> “GDPR” - copying, dissemination or use of this e-mail or the information
>> herein by anyone other than the intended recipient is prohibited. If you
>> have received this email by mistake, please notify us immediately by
>> telephone or e-mail.*
>> _______________________________________________
>> GeoTools-Devel mailing list
>> GeoTools-Devel@lists.sourceforge.net
>> https://lists.sourceforge.net/lists/listinfo/geotools-devel
>>
> --
> --
> Jody Garnett
>
--
Regards, Andrea Aime == GeoServer Professional Services from the experts!
Visit http://goo.gl/it488V for more information. == Ing. Andrea Aime
@geowolf Technical Lead GeoSolutions S.A.S. Via di Montramito 3/A 55054
Massarosa (LU) phone: +39 0584 962313 fax: +39 0584 1660272 mob: +39 339
8844549 http://www.geo-solutions.it http://twitter.com/geosolutions_it
------------------------------------------------------- *Con riferimento
alla normativa sul trattamento dei dati personali (Reg. UE 2016/679 -
Regolamento generale sulla protezione dei dati “GDPR”), si precisa che ogni
circostanza inerente alla presente email (il suo contenuto, gli eventuali
allegati, etc.) è un dato la cui conoscenza è riservata al/i solo/i
destinatario/i indicati dallo scrivente. Se il messaggio Le è giunto per
errore, è tenuta/o a cancellarlo, ogni altra operazione è illecita. Le
sarei comunque grato se potesse darmene notizia. This email is intended
only for the person or entity to which it is addressed and may contain
information that is privileged, confidential or otherwise protected from
disclosure. We remind that - as provided by European Regulation 2016/679
“GDPR” - copying, dissemination or use of this e-mail or the information
herein by anyone other than the intended recipient is prohibited. If you
have received this email by mistake, please notify us immediately by
telephone or e-mail.*
_______________________________________________
GeoTools-Devel mailing list
GeoTools-Devel@lists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/geotools-devel
