Inconsistent 'recommended library instance' comment format (Bugzilla Bug 1445)

[tianocore-issues]

This issue was created automatically with bugzilla2github

Bugzilla Bug 1445

Date: 2019-01-10T15:20:52+00:00
From: Felix <>
To: @BobCF
CC: yonghong.zhu

Last updated: 2019-01-10T19:05:51+00:00

[tianocore-issues]

Comment 6033

Date: 2019-01-10 15:20:52 +0000
From: Felix <>

• Industry Specification: ---
• Releases to Fix: EDK II Master
• Target OS: ---
• Bugzilla Assignee(s): @BobCF

INF specification contains inconsistent information about format of the 'recommended library instance' comment.
Different format is used in examples provided in sections 2.12 and 3.6.

According to section 2.12(https://edk2-docs.gitbooks.io/edk-ii-inf-specification/2_inf_overview/212_[libraryclasses]_section.html#212-libraryclasses-section)
"The comment, using the double hash "##" marks, specifies the module developer's recommended library instance."
The following example is provided:
LibraryClassName3 ## $(WORKSPACE)/Path/To/RecommendedLibInstanceName.inf

However, according to section 3.6 (https://edk2-docs.gitbooks.io/edk-ii-inf-specification/3_edk_ii_inf_file_format/36_[libraryclasses]_sections.html):

<SourceStmts> ::= [<RecInstanceCmt> <Filename> <EOL>] <TS> <Keyword>
[<Field2>] <EOL>
<RecInstanceCmt> ::= "##" <MTS> "@RecommendedInstance" <MTS>

The following example is provided:

@RecommendedInstance $(MDE)/BaseDebugLibNull/BaseDebugLibNull.inf

DebugLib

[tianocore-issues]

Comment 6035

Date: 2019-01-10 19:05:51 +0000
From: Yonghong Zhu <<yonghong.zhu>>

Bug scrub: Assign to module owner