Re: Proper Copyright Year in PHP files now an automated QA tasks

Hb <[email protected]> Fri, 20 Feb 2009 23:20:06 +0100
Newsgroups gmane.comp.cms.xaraya.devel
Organization Xaraya
Message-ID <[email protected]>
Marcel van der Boom schrieb:
>> The RFC was updated accordingly from the existing
>> single year, to display a year range in the RFC at that time:
>> Revision cc044b0d0edd0a5439b2f3f3d2e338adf3888525

Header example in RFC 44 was changed 2005-10-07 to its current state with:
http://mt.xaraya.com/revision/info/cc044b0d0edd0a5439b2f3f3d2e338adf3888525

> I recall the text suggestions and discussion, but the php header as such
> must have slipped my attention back then. The inserted ranges are
> probably fine, but I'd suggest indeed changing the RFC to explicitly
> elaborate on the list of years vs ranges.

Header description in RFC 44 was changed 2005-10-09 to its current state with:
http://mt.xaraya.com/revision/info/37dd4200c82f2db21c626cfca2da24548183dccc


Proposed change to RFC 44, please check for meaning and grammar:

> --- rfc/rfc0044.xml     1f5fadd2221b90cca3a46e3850e6d551dcc0d8d6
> @@ -211,8 +211,8 @@
>        <t><spanx>File header</spanx>
>          <t>
>            This header is for all php files in the codebases. The
> -          package name and copyright year (or a list of years) should
> -          be updated as necessary.
> +          package name and copyright year (or a range of years) should
> +          be updated when the file changes.
>            <artwork>
>
> @@ -284,8 +284,8 @@
>      <section title="Xaraya coding style">
>        <t>
> -        This section deals with standards for coding php files
> -        in Xaraya
> +        This section deals with standards for coding in Xaraya. The formatting
> +        rules must not be applied to code imported from other publishers.
>        </t>
>
> @@ -304,8 +304,9 @@
>          <t><spanx>Indenting</spanx>
>            <t>
> -            Use an indent of 4 spaces. Do not use the tab character for
> -            indentation. Most editors will have a configuration option for this
> .
> +            Use indents of 4 spaces in code and of 2 spaces in template files.
> +            Do not use the tab character. Most editors will have a configuration
> +            option for this.
>            </t>
>
> @@ -316,8 +317,8 @@
>            <artwork>
>              list($p1,
> -                 $p2) = xarVarCleanFromInput('name',
> -                                             'module');
> +                 $p2) = xarBadExampleOnlyVisual('name',
> +                                                'module');
>            </artwork>
>
> @@ -328,18 +329,17 @@
>            <artwork>
> -            list($p1, $p2) = xarVarCleanFromInput('name', 'module');
> +            list($p1, $p2) = xarAllBracketsSameLine('name', 'module');
> 
>              list($p1, $p2) =
> -                xarVarCleanFromInput('name', 'module');
> +                xarBracketPairsSameLine('name', 'module');
> 
>              list(
> -                $p1, $p2, $p3, $p4
> -            ) = xarVarCleanFromInput(
> +                $p1, $p2, $p3
> +            ) = xarAllBracketsSameIndent(
>                  'name',
>                  'module',
> -                'a_really_long_token_indeed',
> -                'something_shorter'
> +                xarML('A really long token from a really long translateable string indeed which reaches the 120th column')
>              );
>
> @@ -356,6 +356,13 @@
>          </t>
> +        <t><spanx>Line lengths</spanx>
> +          <t>
> +            Line lengths depend on data. Normal lines should not extend 80
> +            columns widely, but translateable strings shouldn't be broken into
> +            different lines (see example above).
> +          </t>
> +        </t>
>          <t><spanx>Comments</spanx>