[16444] in Kerberos_V5_Development
Re: standardizing copyright/license notice delimiters in MIT source
daemon@ATHENA.MIT.EDU (Zhanna Tsitkova)
Thu Nov 4 12:03:36 2010
Message-Id: <C12470E5-DC1A-4C9E-8FA7-C306B55873F1@mit.edu>
From: Zhanna Tsitkova <tsitkova@mit.edu>
To: Will Fiveash <will.fiveash@oracle.com>
In-Reply-To: <20100921181242.GB16193@sun.com>
Mime-Version: 1.0 (Apple Message framework v930.3)
Date: Thu, 4 Nov 2010 12:03:31 -0400
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 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.
Thanks,
Zhanna
_______________________________________________
krbdev mailing list krbdev@mit.edu
https://mailman.mit.edu/mailman/listinfo/krbdev
