[Lunar-commits] r23267 - moonbase/trunk/xfce4/xfce4

[Auke Kok]

Samuel Verstraete wrote:
> Author: elangelo
> Date: 2007-02-14 12:40:12 +0100 (Wed, 14 Feb 2007)
> New Revision: 23267
> 
> Modified:
>    moonbase/trunk/xfce4/xfce4/DETAILS
> Log:
> formatting
> gr,S>
> 
> 
> Modified: moonbase/trunk/xfce4/xfce4/DETAILS
> ===================================================================
> --- moonbase/trunk/xfce4/xfce4/DETAILS	2007-02-14 07:16:19 UTC (rev 23266)
> +++ moonbase/trunk/xfce4/xfce4/DETAILS	2007-02-14 11:40:12 UTC (rev 23267)
> @@ -6,7 +6,8 @@
>           ENTERED=20030715
>           UPDATED=20070121
>             SHORT="lightweight desktop environment based on GTK2"
> -PROFILE=yes
> +         PROFILE=yes
> +
>  cat << EOF


I don't like this at all

putting special flags indented underneath 'SHORT' etc. makes them less visible 
than if they were on the left margin.

Remember that if we put these special flags in a DETAILS file, we do so because 
we need to tag the module somehow with a 'well-known' flag. We really don't want 
to hide them between the usual parameters that are set in DETAILS files

consider a file that looks like this:



          SOURCE2_VFY=sha1:10190168bf948556afdfff46f87f9208402d810f
      SOURCE3_VFY=sha1:a7827270380e2fc968e7d722c84ef9eef82dc7a3
         WEB_SITE=http://www.gnu.org/software/libc
          ENTERED=20010922
          UPDATED=20051104
            PSAFE=no
            SHORT="C library for use with GNU/Hurd and GNU/Linux."
cat << EOF
glibc - Library for use with GNU/Hurd and GNU/Linux.
GNU C Library is one of the most important components of the GNU Hurd
and most modern Linux distributions. It is used by almost all C programs
and provides the most essential program interface.
EOF


the 'PSAFE' flag here already is listed ABOVE the SHORT line, it's on it's way 
to being forgotten alltogether. Not to mention that it's indented.

A better example:
           MODULE=autofs
          VERSION=4.1.4
           SOURCE=$MODULE-$VERSION.tar.bz2
       SOURCE_URL=ftp://ftp.kernel.org/pub/linux/daemons/$MODULE/v4/
       SOURCE_VFY=sha1:81b2cd238f04b990ed9d2b073ab7d8e01937b7f5
         WEB_SITE=http://www.goop.org/~jeremy/autofs/
          ENTERED=20040202
          UPDATED=20040921
            SHORT="Kernel userspace automounter."

PSAFE=no
cat << EOF
Kernel userspace automounter. You'll need kernel support for the v4 automounter
and setup ypbind, nis, ldap etc if you want to use that... check the exmaples.
EOF


but still not right.

I propose a new style:

[ all general DETAILS parameters, indented ]
[ special flags, left-aligned ]
[ empty line ]
[ description ]

thus:


           MODULE=autofs
          VERSION=4.1.4
           SOURCE=$MODULE-$VERSION.tar.bz2
       SOURCE_URL=ftp://ftp.kernel.org/pub/linux/daemons/$MODULE/v4/
       SOURCE_VFY=sha1:81b2cd238f04b990ed9d2b073ab7d8e01937b7f5
         WEB_SITE=http://www.goop.org/~jeremy/autofs/
          ENTERED=20040202
          UPDATED=20040921
            SHORT="Kernel userspace automounter."
PSAFE=no

cat << EOF
Kernel userspace automounter. You'll need kernel support for the v4 automounter
and setup ypbind, nis, ldap etc if you want to use that... check the exmaples.
EOF


You can't argue that this is extremely clear. We should definately start using 
this IMHO if not convert all of moonbase to be this way asap.

Auke