Bug 843 - Need to remove unnecessary return statements in void functions of EDKII.

Bug 843 - Need to remove unnecessary return statements in void functions of EDKII.

[Mohammad Younas Khan Pathan]

Hi all,

I have updated the changes after removing all the unecessary return
statements in EDKII packages.

I have created EDKIIBug843 branch under master.
Also attached the changes here.

Please help to review and share your comments.

Thank you,
Younas khan.

Re: Bug 843 - Need to remove unnecessary return statements in void functions of EDKII.

[Laszlo Ersek]

Hello Younas,

On 06/06/18 10:28, Mohammad Younas Khan Pathan wrote:
> Hi all,
> 
> I have updated the changes after removing all the unecessary return
> statements in EDKII packages.
> 
> I have created EDKIIBug843 branch under master.
> Also attached the changes here.
> 
> Please help to review and share your comments.

please post your patches in-line for review -- please don't try to
attach them (to Bugzilla items or to emails); also don't paste them into
the email body. The edk2 development workflow uses the git toolset; that
set includes tools for formatting patches as emails, and for posting
those patch files as emails.

This is the official Wiki article:

https://github.com/tianocore/tianocore.github.io/wiki/EDK-II-Development-Process

And this is my personal take on the matter:

https://github.com/tianocore/tianocore.github.io/wiki/Laszlo's-unkempt-git-guide-for-edk2-contributors-and-maintainers

Thanks,
Laszlo

Re: Bug 843 - Need to remove unnecessary return statements in void functions of EDKII.

[Laszlo Ersek]

Hello Younas,

On 06/11/18 09:17, Mohammad Younas Khan Pathan wrote:
> Hi all,
> 
> Please find the differences updated below, review and share your comments:

(1) Please submit the patch according to the edk2 development process.

https://github.com/tianocore/tianocore.github.io/wiki/EDK-II-Development-Process

In particular, please don't paste a diff into whatever email client you
use (e.g. gmail web interface); please use "git send-email" (or another
tool that can send out pristine patches that were generated with "git
format-patch").

(2) You need to add your Contributed-by and Signed-off-by lines at the
end of the commit message. Please refer to "Contributions.txt" in the
project root directory. In general, please write an appropriate commit
message.

(3) Please don't update copyright notices in source code that don't
belong to you (or to your employer). For example, you update Intel
copyright notices in several spots, but you don't seem to have an
@intel.com email address.

(4) Please split the patch to one patch per top-level directory. For
example, you should have a separate patch for OvmfPkg.

(5) Preferably, if the goal is to remove useless "return" statements,
don't remove or add unrelated empty lines; for example in
"OptionRomPkg/UndiRuntimeDxe/Init.c". It's OK to remove adjacent empty
lines that had been clearly added, originally, to separate the "return"
statements from the rest of the code.

I suggest that we work on the OvmfPkg patch at first, to get your
environment and workflow set up. Once the OvmfPkg patch looks good in
all areas, you can submit the rest of the patches the same way.

Thanks
Laszlo

Re: Bug 843 - Need to remove unnecessary return statements in void functions of EDKII.

[Laszlo Ersek]

On 06/11/18 11:47, Laszlo Ersek wrote:
> On 06/11/18 09:17, Mohammad Younas Khan Pathan wrote:

> (4) Please split the patch to one patch per top-level directory. For
> example, you should have a separate patch for OvmfPkg.

This is required by our development workflow, but it's also required for
technical reasons. I'm just noticing that your posting (with message ID
<CAN9uzB=UhGhveKK4=F=jiwUmc_5QO+pmROvqcjiuBQtbHjyjRg@mail.gmail.com>)
hasn't even reached the list, and that's because the email was oversized
-- 855190 bytes. That's way beyond the limit.

If you split the changes with the right granularity, this won't be a
problem.

Thanks
Laszlo