[16447] in Kerberos_V5_Development
Re: standardizing copyright/license notice delimiters in MIT source
daemon@ATHENA.MIT.EDU (Will Fiveash)
Thu Nov 4 17:34:26 2010
Date: Thu, 4 Nov 2010 16:32:57 -0500
From: Will Fiveash <will.fiveash@oracle.com>
To: Zhanna Tsitkova <tsitkova@mit.edu>
Message-ID: <20101104213257.GA6278@sun.com>
Mail-Followup-To: Zhanna Tsitkova <tsitkova@mit.edu>,
"krbdev@MIT.EDU" <krbdev@mit.edu>
MIME-Version: 1.0
Content-Disposition: inline
In-Reply-To: <C12470E5-DC1A-4C9E-8FA7-C306B55873F1@mit.edu>
Cc: "krbdev@MIT.EDU" <krbdev@mit.edu>
Content-Type: text/plain; charset="us-ascii"
Content-Transfer-Encoding: 7bit
Errors-To: krbdev-bounces@mit.edu
On Thu, Nov 04, 2010 at 12:03:31PM -0400, Zhanna Tsitkova wrote:
> On Sep 21, 2010, at 2:12 PM, Will Fiveash wrote:
>
> >
> >/* -*- mode: c; c-basic-offset: 4; indent-tabs-mode: nil -*- */
> >/* prototype/prototype.c */
>
>
> I suggest to add a short comment stating the purpose of the file into the
> second line, i.e :
>
> /* prototype/prototype.c - Short Description */
>
>
> For example, in krb5.hin we currently have
>
> /* -*- mode: c; c-basic-offset: 4; indent-tabs-mode: nil -*- */
> /* include/krb5.h
> ...
> .... LONG COPYRIGHTS...
> *
> * General definitions for Kerberos version 5.
> */
>
>
> it would change to:
>
> /* -*- mode: c; c-basic-offset: 4; indent-tabs-mode: nil -*- */
> /* include/krb5.h - General definitions for Kerberos version 5
> ...
> .... LONG COPYRIGHTS...
> *
> */
>
> One should notice that some of the files do have the-purpose-of-the-file
> comments somewhere in the file body (similar to krb5.hin). Others don't. I
> think it is very useful to have it on the very top of the file in the close
> proximity of the file name itself.
>
> The whole line should end before the 90th (or so) column.
>
> More detailed description of the file purpose may follow the copyrights
> statements.
As long as:
1. The first copyright block always starts in the third comment block
from the top.
2. Each unique copyright follows it in its own (/*, */ delineated)
comment block.
3. Each copyright block contains the word "copyright".
then I don't have a problem with your suggestion.
--
Will Fiveash
Oracle
http://opensolaris.org/os/project/kerberos/
Sent using mutt, a sweet, text based e-mail app <http://www.mutt.org/>
_______________________________________________
krbdev mailing list krbdev@mit.edu
https://mailman.mit.edu/mailman/listinfo/krbdev
