[pacman-dev] Useless comments...

[Kevin Barry]

@@ -1,2 +1,3 @@
+# Check to see if you want to read a semi rant
 if (you don't want to read a semi rant)
     exit 0;


On Sun, Mar 8, 2009 at 2:06 AM, Allan McRae <allan at archlinux.org> wrote:
> Hi,
>
> if (you don't want to read a semi rant)
>   exit 0;
>
> I have noticed a number of useless comments in makepkg and have decided that
> they are worse than no comments.  Examples:
>
> 1)  This inspired the rant!
>
>   download_sources
>   # we can only check checksums if we have all files
>   check_checksums
>
> Huh, why are we not checking for all files then?  Because download_sources
> exits when it fails...
>
> 2)  and there are a lot of these:
>
>   # fix flyspray feature request #2978
>   # fix flyspray bug #5923
>   # Fixes FS#10039
>   # fix flyspray #6246
>   #fix flyspray feature request #5223
>   # fix flyspray bug #5973
>
> and I am guilty here...  but I was at the airport with no internet access so
> I had no idea if these are important.  And most of these appeared to be
> non-obscure features/fixes so did not need a comment justifying their
> inclusion.
>
> 3) overly obvious comments
>
>   # do we have a changelog?
>   if [ -f "$startdir/ChangeLog" ]; then
>
> If you do not understand that test, then leave the code alone...
>
>
> I will patch these out eventually but I like to share my frustration.  I am
> just a generous guy!
>
> Allan
>
>
>
>
> _______________________________________________
> pacman-dev mailing list
> pacman-dev at archlinux.org
> http://www.archlinux.org/mailman/listinfo/pacman-dev
>