diff options
author | Laszlo Ersek <lersek@redhat.com> | 2018-03-15 14:57:39 +0100 |
---|---|---|
committer | Laszlo Ersek <lersek@redhat.com> | 2018-03-16 19:58:23 +0100 |
commit | fe1b9e8e085bede968958f494cba0be5ab3add99 (patch) | |
tree | 690556136c6b33a82c6dc908f19739c0b2361537 /BaseTools/Source/Python/AutoGen/IdfClassObject.py | |
parent | 1806451073c513805dc7c43ede8ec9bdf267b8ea (diff) | |
download | edk2-fe1b9e8e085bede968958f494cba0be5ab3add99.tar.gz edk2-fe1b9e8e085bede968958f494cba0be5ab3add99.tar.bz2 edk2-fe1b9e8e085bede968958f494cba0be5ab3add99.zip |
OvmfPkg/PlatformBootManagerLib: rejuvenate old-style function comments
The old-style "Routine Description: ..." comments use the leftmost column
and are placed between the parameter list and the function body. Therefore
they cause git-diff to produce bogus hunk headers that fail to name the
function being patched.
Convert these comment blocks to the current edk2 style. While at it, clean
them up too.
For PlatformBootManagerBeforeConsole() and
PlatformBootManagerAfterConsole(), copy the descriptions from the call
sites in "MdeModulePkg/Universal/BdsDxe/BdsEntry.c". They are more
detailed than the comments in the lib class header
"MdeModulePkg/Include/Library/PlatformBootManagerLib.h"; ArmVirtPkg
already uses these comments.
No functional changes.
Cc: Ard Biesheuvel <ard.biesheuvel@linaro.org>
Cc: Jordan Justen <jordan.l.justen@intel.com>
Contributed-under: TianoCore Contribution Agreement 1.1
Signed-off-by: Laszlo Ersek <lersek@redhat.com>
Reviewed-by: Ard Biesheuvel <ard.biesheuvel@linaro.org>
Tested-by: Gabriel Somlo <gsomlo@gmail.com>
Diffstat (limited to 'BaseTools/Source/Python/AutoGen/IdfClassObject.py')
0 files changed, 0 insertions, 0 deletions