Re: [Xen-devel] [PATCH v3 2/8] OvmfPkg: introduce E820.h

[Wei Liu <wei.liu2@xxxxxxxxxx>]

On Thu, Nov 28, 2013 at 12:42:27AM +0000, Tian, Hot wrote:
> Below is quoted from the EDKII coding standard spec:
> 
Sorry I can understand the above paragraph, but I still cannot get the
expection for non-Intel copyright line.

> 7.3.2 Copyright Notice
> The first line of the last paragraph of the file description is made up of 
> the copyright

You seem to be expecting only one line of copyright notice?

> notice. The copyright notice must consist of the following text with the 
> FIRST and
> LAST symbols replaced with the year the file was created and the year the 
> file was last
> edited, respectively.
> Copyright (C) FIRST - LAST, Intel Corporation. All rights reserved.<BR>
> A file that has been created but not edited in subsequent years would have a 
> copyright
> notice with a single date, such as:
> Copyright (C) 2007, Intel Corporation. All rights reserved.<BR>
> If this file is subsequently edited, the copyright notice would be updated as 
> follows.
> Copyright (C) 2007 - 2010, Intel Corporation. All rights reserved.<BR>
> The FIRST - LAST format for the copyright date, as described above, is the 
> only
> format allowed. Do not use a comma separated list or keep updating a single 
> date.
> The <BR> at the end of the line is required. Since Doxygen uses XML for its 
> internal
> format, spaces and new lines are treated as a single space. The <BR> will 
> force
> Doxygen to start the following text, the license notice, on a new line.
> 

I mimic the pattern in OvmfPkg/VirtioBlkDxe/VirtioBlk.c and get.

/** @file

Copyright (c) 2013, Citrix Systems UK Ltd.
Copyright (c) 2006 - 2013, Intel Corporation. All rights reserved.<BR>

This program and the accompanying materials
are licensed and made available under the terms and conditions
of the BSD License which accompanies this distribution.  The
full text of the license may be found at
http://opensource.org/licenses/bsd-license.php

THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR
IMPLIED.

**/

Is the above one OK?

Wei.

> Thanks,
> Hot
> 
> -----Original Message-----
> From: Jordan Justen [mailto:jljusten@xxxxxxxxx] 
> Sent: Thursday, November 28, 2013 8:19 AM
> To: Wei Liu
> Cc: Konrad Rzeszutek Wilk; edk2-devel@xxxxxxxxxxxxxxxxxxxxx; xen-devel; Tian, 
> Hot; Justen, Jordan L
> Subject: Re: [Xen-devel] [PATCH v3 2/8] OvmfPkg: introduce E820.h
> 
> On Wed, Nov 27, 2013 at 4:22 AM, Wei Liu <wei.liu2@xxxxxxxxxx> wrote:
> > On Tue, Nov 26, 2013 at 02:47:13PM -0500, Konrad Rzeszutek Wilk wrote:
> >> On Tue, Nov 26, 2013 at 07:25:58PM +0000, Wei Liu wrote:
> >> > E820 definitions copied from IntelFrameworkModulePkg/Csm/
> >> > LegacyBiosDxe/LegacyBiosInterface.h.
> >> >
> >> > Contributed-under: TianoCore Contribution Agreement 1.0
> >> > Signed-off-by: Wei Liu <wei.liu2@xxxxxxxxxx>
> >> > Reviewed-by: Jordan Justen <jordan.l.justen@xxxxxxxxx>
> >> > ---
> >> >  OvmfPkg/Include/IndustryStandard/E820.h |   46 
> >> > +++++++++++++++++++++++++++++++
> >> >  1 file changed, 46 insertions(+)
> >> >  create mode 100644 OvmfPkg/Include/IndustryStandard/E820.h
> >> >
> >> > diff --git a/OvmfPkg/Include/IndustryStandard/E820.h 
> >> > b/OvmfPkg/Include/IndustryStandard/E820.h
> >> > new file mode 100644
> >> > index 0000000..e7e0c25
> >> > --- /dev/null
> >> > +++ b/OvmfPkg/Include/IndustryStandard/E820.h
> >> > @@ -0,0 +1,46 @@
> >> > +/** @file
> >> > +
> >> > +Copyright (c) 2006 - 2013, Intel Corporation. All rights reserved.<BR>
> >>
> >> <BR> ?
> >>
> >
> > Copy-n-paste error, phew.
> >
> > <BR> stands for new line in HTML. I have no idea how it came up in the
> > original header.
> 
> Actually Intel wants that appended to all Intel copyright lines in EDK II 
> files.
> 
> I'm not sure why, but I suspected something related to forcing a
> newline in doxygen.
> 
> Hot seems to keep an eye on it, so maybe he knows.
> 
> -Jordan
> 
> >> > +Copyright (c) 2013, Citrix Systems UK Ltd.
> >> > +
> >> > +This program and the accompanying materials
> >> > +are licensed and made available under the terms and conditions
> >> > +of the BSD License which accompanies this distribution.  The
> >> > +full text of the license may be found at
> >> > +http://opensource.org/licenses/bsd-license.php
> >> > +
> >> > +THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
> >> > +WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR 
> >> > IMPLIED.
> >> > +
> >> > +**/
> >> > +
> >> > +
> >> > +#ifndef __E820_H__
> >> > +#define __E820_H__
> >> > +
> >> > +#pragma pack(1)
> >> > +
> >> > +typedef enum {
> >> > +  EfiAcpiAddressRangeMemory   = 1,
> >> > +  EfiAcpiAddressRangeReserved = 2,
> >> > +  EfiAcpiAddressRangeACPI     = 3,
> >> > +  EfiAcpiAddressRangeNVS      = 4
> >>
> >> Odd, Linux also has E820_UNUSABLE
> >>
> >> should that be in there as well?
> >
> > The original header from where I copied these definitions doens't have
> > that and nobody is using that at the moment. I think we can add that in
> > later.
> >
> > Wei.
> >
> > _______________________________________________
> > Xen-devel mailing list
> > Xen-devel@xxxxxxxxxxxxx
> > http://lists.xen.org/xen-devel

_______________________________________________
Xen-devel mailing list
Xen-devel@xxxxxxxxxxxxx
http://lists.xen.org/xen-devel