llvm.org GIT mirror llvm / ab2b10c
Don't attribute in file headers anymore. See llvmdev for the discussion of this change. git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@45409 91177308-0d34-0410-b5e6-96231b3b80d8 Chris Lattner 11 years ago
2 changed file(s) with 12 addition(s) and 30 deletion(s). Raw diff Collapse all Expand all
133133 //
134134 // The LLVM Compiler Infrastructure
135135 //
136 // This file was developed by <whoever started the file> and is distributed under
137 // the University of Illinois Open Source License. See LICENSE.TXT for details.
136 // This file is distributed under the University of Illinois Open Source
137 // License. See LICENSE.TXT for details.
138138 //
139139 //===----------------------------------------------------------------------===//
140140 //
145145
146146
147147
148

A few things to note about this particular format: The 'developed by' line

149 should be the name of the person or organization who initially contributed the
150 file. The "-*- C++
148

A few things to note about this particular format: The "-*- C++

151149 -*-" string on the first line is there to tell Emacs that the source file
152150 is a C++ file, not a C file (Emacs assumes .h files are C files by default).
153151 Note that this tag is not necessary in .cpp files. The name of the file is also
155153 file. This is important when printing out code and flipping though lots of
156154 pages.

157155
158

The next section in the file is a concise note that defines the license that

159 the file is released under. This makes it perfectly clear what terms the source
160 code can be distributed under.

156

The next section in the file is a concise note that defines the license

157 that the file is released under. This makes it perfectly clear what terms the
158 source code can be distributed under and should not be modified in any way.

161159
162160

The main body of the description does not have to be very long in most cases.

163161 Here it's only two lines. If an algorithm is being implemented or something
416416
417417

We believe in correct attribution of contributions to

418418 their contributors. However, we do not want the source code to be littered
419 with random attributions (this is noisy/distracting and revision control
420 keeps a perfect history of this anyway). As such, we follow these rules:

421
422
  • Developers who originate new files in LLVM should place their name at
  • 423 the top of the file per the
    424 Coding Standards.
    425
  • There should be only one name at the top of the file and it should be
  • 426 the person who created the file.
    427
  • Placing your name in the file does not imply
  • 428 href="#clp">copyright: it is only used to attribute the file to
    429 its original author.
    430
  • Developers should be aware that after some time has passed, the name at
  • 431 the top of a file may become meaningless as maintenance/ownership of files
    432 changes. Despite this, once set, the attribution of a file never changes.
    433 Revision control keeps an accurate history of contributions.
    434
  • Developers should maintain their entry in the
  • 435 CREDITS.txt
    436 file to summarize their contributions.
    437
  • Commit comments should contain correct attribution of the person who
  • 438 submitted the patch if that person is not the committer (i.e. when a
    439 developer with commit privileges commits a patch for someone else).
    440
    419 with random attributions "this code written by J Random Guy" (this is noisy
    420 and distracting. In practice, the revision control system keeps a perfect
    421 history of who change what, and the CREDITS.txt file describes higher-level
    422 contributions.

    423
    424

    Overall, please do not add contributor names to the source base.

    441425
    442426
    443427