3.4 Header Section

This is an optional section.

Summary

The Copyright and License notices for the DSC file are in the comments that start the file. The format for the comment section is:

## @file
# Abstract
#
# Description
#
# Copyright
#
# License
#
##

Developers will create this section manually (or with the help of usage enhancement tools). It is recommended that the developer maintain a text file that contains the Copyright and License information, which can then be copied into a new DSC file.

Prototype

<Header>      ::= <Comment>*
                  "##" <Space> [<Space>] "@file" <EOL>
                  [<Abstract>]
                  [<Description>]
                  <Copyright>+
                  "#" <EOL>
                  <License>+
                  "##" <EOL>
<Filename>    ::= <Word> "." <Extension>
<Abstract>    ::= "#" <MTS> <AsciiString> <EOL> ["#" <EOL>]
<Description> ::= ["#" <MTS> <AsciiString> <EOL>]+
                  ["#" <EOL>]
<Copyright>   ::= "#" <MTS> <CopyName> <Date> "," <CompInfo> <EOL>
<CopyName>    ::= ["Portions" <MTS>] "Copyright (c)" <MTS>
<Date>        ::= <Year> [<TS> {<DateList>} {<DateRange>}]
<Year>        ::= "2" (0-9)(0-9)(0-9)
<DateList>    ::= <CommaSpace> <Year> [<CommaSpace> <Year>]*
<DateRange>   ::= "-" <TS> <Year>
<CompInfo>    ::= (0x20 - 0x7e)* <MTS> "All rights reserved." [<TS> "<BR>"]
<License>     ::= ["#" <MTS> <AsciiString> <EOL>]+
                  ["#" <EOL>]

Example

## @file
# EFI/Framework Emulation Platform
#
# The Emulation Platform can be used to debug individual modules, prior
# to creating a real platform.
#
# Copyright (c) 2006 - 2007, 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.
#
##