fb-contrib icon indicating copy to clipboard operation
fb-contrib copied to clipboard

Please update documentation

Open nkavian opened this issue 4 years ago • 4 comments

This page sends people, myself included, to the fb-contrib page. When I used it, it broke because I really needed to be using the sb-contrib.

It might help to update this so people stop creating new tickets complaining that bsel is out of date, etc.

http://fb-contrib.sourceforge.net/

nkavian avatar Aug 29 '21 04:08 nkavian

The SourceForge page isn't really maintained anymore; it points you toward the GitHub page, which mentions the different versions for FindBugs vs SpotBugs.

Which link in particular did you find problematic?

ThrawnCA avatar Aug 29 '21 23:08 ThrawnCA

Both links on that page which take you to the maven repository

image

Once I got there I copied/pasted the artifact, not knowing I should be using the sb-contrib version instead

image

It wasn't until I had bcel version issues that I then went through the github issues just to see and realize I need to switch to sb-contrib.

nkavian avatar Aug 30 '21 15:08 nkavian

Those links are correct for fb-contrib, though, and the page does say that it's meant to be used with FindBugs (not SpotBugs).

I suppose it wouldn't hurt for there to be some mention on the page that FindBugs itself is obsolete. But it's basically an unmaintained page.

ThrawnCA avatar Aug 31 '21 02:08 ThrawnCA

The way spotbugs is documented, the average person won't understand what is and is-not deprecated or obsolete.

Go to the repo page and search for the word obsolete, no match. The way everything is displayed, it's as if they're both alive and well.

image image

It's ironic. A tool that helps developers find subtle programming bugs itself is unclear how it can be used. Configuring maven was a nightmare too but that's for a different day.

nkavian avatar Aug 31 '21 05:08 nkavian