search

koalaman / shellcheck

ShellCheck, a static analysis tool for shell scripts
https://www.shellcheck.net
GNU General Public License v3.0
35.55k stars 1.74k forks source link

Documentation for SC3061 and others disapeared ? #2943

Open vic1707 opened 3 months ago

vic1707 commented 3 months ago

In shellcheck output https://www.shellcheck.net/wiki/SC3061 redirects to https://github.com/koalaman/shellcheck/wiki/SC3061 meaning that the doc page doesn't exist.

AFAIK this is linked to #2572 so I don't really know what happend here. Also found from the same issue that

Documentation disapeard. I'll try to edit that list with all missing docs.

Shellcheck output but I don't think it's really necessary

In uninstall.sh line 8:
    read -r
    ^--^ SC3061 (warning): In POSIX sh, read without a variable is undefined.

For more information:
  https://www.shellcheck.net/wiki/SC3061 -- In POSIX sh, read without a varia...

SC3061

brother commented 3 months ago

As I stated in #2572 we (the community) are able to edit the wiki to make it a good resource, that also covers adding the missing pages.

I do not know for sure that either of the mentioned pages have existed before but reading the git log of the wiki (yes you can clone it! see bottom right at the wiki pages) they seem to never have been there.

(As SC1085 was mentioned as missing back in 2022 a good guess is that it has never been added.)

I propose to close this issue and just move on. Possibly by adding the missing poage.

vic1707 commented 3 months ago

And since the issue was closed with https://github.com/koalaman/shellcheck/issues/2572#issuecomment-1301623041 stating that they were all added.

I think it is fair to assume those pages existed and disappeared which is why I opened a new issue 😉

I didn't know how to check the history of those pages either, therefore I couldn't check it, thanks for telling me.

brother commented 3 months ago

Read all the comments indeed....thanks, forgot they were indeed added.

Neither SC1085 nor SC3061 was in the main "full list" though and might have been overlooked.

vic1707 commented 3 months ago

Not a problem, as you said, they don't seem to be in the history and might have been overlooked. I'm not that good at bash and mostly rely on the lint's doc to help me fix my code, I have no clue (& laziness mixed with fear of misdirecting people to be fair) on how to fix nor write these 2 lint's doc. Do you have any hints to help me write those ?

Stikus commented 3 months ago

Is this issue about SC3016 (in title) or SC3061 (in comments)?

brother commented 3 months ago

SC3016 is present currently while SC3061 isn't.

If both were missing it was about both and half of the issue is by that done.

vic1707 commented 3 months ago

Both (3061 and 1085 ) weren't available at the time of writing the issue, I did a typo on the title, my bad 😞)