Re: [PATCH 5/5] gnu: Some cleanup based on lint checkers.

[Alex Kost]

Tremendous work!!  My admiration :-)

Eric Bavier (2014-10-24 09:19 +0400) wrote:

> This patch does not clean up all warning from 'guix lint' because:
>
> 1. Warnings about patch names are generated in cases where a single
> patch is used in several packages, or in packages that inherit from
> another.
>
> 2. Many descriptions begin with the package name in lowercase form,
> which triggers a warning about the description beginning with a
> lowercase letter.  In this patch I capitalised the package name if I
> could find a reference to the capital form on the package's home-page
> somewhere.  Many packages are quite insistent that the package always be
> referenced by the lowercase name, and I'm not sure how the description
> would be reworded, or whether it really needs to be.  We could add an
> exception to the description-starts-with-a-capital-letter rule for when
> the package name is the first word.
>
> 3. Some synopses begin with a numeral, triggering the capital-letter
> warning.

Perhaps the capital-letter linter should be adjusted for such a case.

> 4. Handling the pkg-config warnings should really have the builds
> tested.
>
> 5. I didn't really want to begin looking at the synopses and
> descriptions in xorg.scm...
>
> Comments welcome.  Nitpicks especially, since much of this is already
> quite nitpicky. ;)

[...]
> @@ -341,7 +341,7 @@ especially over Wi-Fi, cellular, and long-distance 
> links.")
>      (inputs `(("zlib" ,zlib)))
>      (synopsis "Small SSH server and client")
>      (description "Dropbear is a relatively small SSH server and
> -client. It runs on a variety of POSIX-based platforms. Dropbear is
> +client.  It runs on a variety of POSIX-based platforms.  Dropbear is
>  particularly useful for embedded systems, such as wireless routers.")   

There are also trailing spaces on the line above.  As it is the only
such line in “ssh.scm” I think it's OK to fix it in the same commit.

[...]
> @@ -543,7 +544,7 @@ help you implement simple HTTP servers.")
>      (home-page "https://banu.com/tinyproxy/";)
>      (synopsis "Light-weight HTTP/HTTPS proxy daemon")
>      (description "Tinyproxy is a light-weight HTTP/HTTPS proxy
> -daemon. Designed from the ground up to be fast and yet small, it is an ideal
> +daemon.  Designed from the ground up to be fast and yet small, it is an ideal
>  solution for use cases such as embedded deployments where a full featured 
> HTTP
>  proxy is required, but the system resources for a larger proxy are
>  unavailable.") 

Also a space here↑ but there are some more in “web.scm”.