[edk2] derailing into patch style discussion

Message ID 20180412181359.rvt2s4fhyuxmj465@bivouac.eciton.net
State New
Headers show
Series
  • [edk2] derailing into patch style discussion
Related show

Commit Message

Leif Lindholm April 12, 2018, 6:13 p.m.
Since you already have my r-b on the set, I'll pick up the style
topic, partly because I'm not sure if I've ever explained my
thinking publicly in words that anyone other than Ard understands.

On Thu, Apr 12, 2018 at 07:45:19PM +0200, Laszlo Ersek wrote:
> > Well, there are a couple of places where I could nitpick on

> > alphabetical sorting of includes,

> 

> And, believe me, you would have my total agreement :), but in such

> cases, there's always a fork in the road: (a) add a separate patch that

> first sorts the includes and [LibraryClasses], without functional

> changes, or (b) just stick with the existing disorder, and get in and

> out as surgically as possible. My personal preference is (a), but it has

> drawn disagreement -- even accusations of pedantry :) :) --, and/or

> suggestions to squash such patches with functional changes, in the past,

> so I trod more lightly now. Rest assured, I didn't *miss* those places,

> I just elected to close my eyes! ;)


Right :)

So, yes - I do strongly agree with the idea of keeping functionality
and style changes separate (ask Evan), so that wasn't exactly what I
was referring to.

In general my internal "optimal" situation is one where the purely
functional diff leaves the code in a (quite subjectively, since it's
still not conformant) better state on average than it was.

My subjective mark of optimal is that which would minimise any
subsequent patch that was _only_ a style cleanup.

To pick an example from this set (1/10):
+  ArmPlatformPkg/ArmPlatformPkg.dec
   EmbeddedPkg/EmbeddedPkg.dec
   MdePkg/MdePkg.dec
   MdeModulePkg/MdeModulePkg.dec
-  ArmPlatformPkg/ArmPlatformPkg.dec

instead of

[Packages]
-  MdePkg/MdePkg.dec
-  MdeModulePkg/MdeModulePkg.dec
   ArmPlatformPkg/ArmPlatformPkg.dec
   EmbeddedPkg/EmbeddedPkg.dec
+  MdePkg/MdePkg.dec
+  MdeModulePkg/MdeModulePkg.dec


Anyway, this is all an aside - I just thought I would give you an
insight into the mind of Leif.

/
    Leif
_______________________________________________
edk2-devel mailing list
edk2-devel@lists.01.org
https://lists.01.org/mailman/listinfo/edk2-devel

Comments

Laszlo Ersek April 12, 2018, 6:48 p.m. | #1
On 04/12/18 20:13, Leif Lindholm wrote:
> Since you already have my r-b on the set, I'll pick up the style

> topic, partly because I'm not sure if I've ever explained my

> thinking publicly in words that anyone other than Ard understands.

> 

> On Thu, Apr 12, 2018 at 07:45:19PM +0200, Laszlo Ersek wrote:

>>> Well, there are a couple of places where I could nitpick on

>>> alphabetical sorting of includes,

>>

>> And, believe me, you would have my total agreement :), but in such

>> cases, there's always a fork in the road: (a) add a separate patch that

>> first sorts the includes and [LibraryClasses], without functional

>> changes, or (b) just stick with the existing disorder, and get in and

>> out as surgically as possible. My personal preference is (a), but it has

>> drawn disagreement -- even accusations of pedantry :) :) --, and/or

>> suggestions to squash such patches with functional changes, in the past,

>> so I trod more lightly now. Rest assured, I didn't *miss* those places,

>> I just elected to close my eyes! ;)

> 

> Right :)

> 

> So, yes - I do strongly agree with the idea of keeping functionality

> and style changes separate (ask Evan), so that wasn't exactly what I

> was referring to.

> 

> In general my internal "optimal" situation is one where the purely

> functional diff leaves the code in a (quite subjectively, since it's

> still not conformant) better state on average than it was.

> 

> My subjective mark of optimal is that which would minimise any

> subsequent patch that was _only_ a style cleanup.

> 

> To pick an example from this set (1/10):

> diff --git a/Omap35xxPkg/InterruptDxe/InterruptDxe.inf

> b/Omap35xxPkg/InterruptDxe/InterruptDxe.inf

> index 6deb8c3f675c..61ad89af2758 100644

> --- a/Omap35xxPkg/InterruptDxe/InterruptDxe.inf

> +++ b/Omap35xxPkg/InterruptDxe/InterruptDxe.inf

> @@ -41,14 +41,14 @@ [LibraryClasses]

>    PrintLib

>    UefiDriverEntryPoint

>    IoLib

>    ArmLib

> 

>  [Protocols]

>  -  gHardwareInterruptProtocolGuid

>  -  gEfiCpuArchProtocolGuid

>  +  gHardwareInterruptProtocolGuid  ## PRODUCES

>  +  gEfiCpuArchProtocolGuid         ## CONSUMES ## NOTIFY

> 

> ---

> This one is pretty straightforward - without touching any non-modified

> lines, these _could_ be reordered alphabetically.

> 

> (Yes, that change may have functional side-effects, but only on

> undefined behaviour, so no different from rebasing to a version with

> newer BaseTools can give you.)

> 

> Where the minimum diff logic comes in is in situations like (6/10):

> diff --git a/ArmPlatformPkg/Drivers/NorFlashDxe/NorFlashDxe.inf

> b/ArmPlatformPkg/Drivers/NorFlashDxe/NorFlashDxe.inf

> index 812dafd065b2..c40ac27a6599 100644

> --- a/ArmPlatformPkg/Drivers/NorFlashDxe/NorFlashDxe.inf

> +++ b/ArmPlatformPkg/Drivers/NorFlashDxe/NorFlashDxe.inf

> @@ -28,12 +28,13 @@ [Sources.common]

>    NorFlashBlockIoDxe.c

> 

>  [Packages]

>    MdePkg/MdePkg.dec

>    MdeModulePkg/MdeModulePkg.dec

>    ArmPlatformPkg/ArmPlatformPkg.dec

> +  EmbeddedPkg/EmbeddedPkg.dec

> 

> ---

> Applying my "optimal" rule here would have meant inserting the new

> line before MdePkg/MdeModulePkg .decs instead. That way a cleanup

> patch would end up doing

> 

> [Packages]

> +  ArmPlatformPkg/ArmPlatformPkg.dec

>    EmbeddedPkg/EmbeddedPkg.dec

>    MdePkg/MdePkg.dec

>    MdeModulePkg/MdeModulePkg.dec

> -  ArmPlatformPkg/ArmPlatformPkg.dec

> 

> instead of

> 

> [Packages]

> -  MdePkg/MdePkg.dec

> -  MdeModulePkg/MdeModulePkg.dec

>    ArmPlatformPkg/ArmPlatformPkg.dec

>    EmbeddedPkg/EmbeddedPkg.dec

> +  MdePkg/MdePkg.dec

> +  MdeModulePkg/MdeModulePkg.dec

> 

> 

> Anyway, this is all an aside - I just thought I would give you an

> insight into the mind of Leif.


I do see the point -- basically, even if we don't imlement separate
cleanups, and just add the functional changes on top of whatever we
already have, if there are multiple ways to keep the functional changes
purely functional and focused, we had better select the one that at
least doesn't make the style worse. Using your [Packages] example, it's
possible *not* to increase the disorder, without actually sorting those
lines. I fully admit this eluded me -- I considered "messy" all-or-nothing.

I'll try to remember this next time. (It's honestly a bit difficult for
me, because if I take the time & effort to be considerate like this, I'd
mostly (though perhaps not always) just write the patch that cleans up
first.)

Thanks!
Laszlo
_______________________________________________
edk2-devel mailing list
edk2-devel@lists.01.org
https://lists.01.org/mailman/listinfo/edk2-devel

Patch

diff --git a/Omap35xxPkg/InterruptDxe/InterruptDxe.inf
b/Omap35xxPkg/InterruptDxe/InterruptDxe.inf
index 6deb8c3f675c..61ad89af2758 100644
--- a/Omap35xxPkg/InterruptDxe/InterruptDxe.inf
+++ b/Omap35xxPkg/InterruptDxe/InterruptDxe.inf
@@ -41,14 +41,14 @@  [LibraryClasses]
   PrintLib
   UefiDriverEntryPoint
   IoLib
   ArmLib

 [Protocols]
 -  gHardwareInterruptProtocolGuid
 -  gEfiCpuArchProtocolGuid
 +  gHardwareInterruptProtocolGuid  ## PRODUCES
 +  gEfiCpuArchProtocolGuid         ## CONSUMES ## NOTIFY

---
This one is pretty straightforward - without touching any non-modified
lines, these _could_ be reordered alphabetically.

(Yes, that change may have functional side-effects, but only on
undefined behaviour, so no different from rebasing to a version with
newer BaseTools can give you.)

Where the minimum diff logic comes in is in situations like (6/10):
diff --git a/ArmPlatformPkg/Drivers/NorFlashDxe/NorFlashDxe.inf
b/ArmPlatformPkg/Drivers/NorFlashDxe/NorFlashDxe.inf
index 812dafd065b2..c40ac27a6599 100644
--- a/ArmPlatformPkg/Drivers/NorFlashDxe/NorFlashDxe.inf
+++ b/ArmPlatformPkg/Drivers/NorFlashDxe/NorFlashDxe.inf
@@ -28,12 +28,13 @@  [Sources.common]
   NorFlashBlockIoDxe.c

 [Packages]
   MdePkg/MdePkg.dec
   MdeModulePkg/MdeModulePkg.dec
   ArmPlatformPkg/ArmPlatformPkg.dec
+  EmbeddedPkg/EmbeddedPkg.dec

---
Applying my "optimal" rule here would have meant inserting the new
line before MdePkg/MdeModulePkg .decs instead. That way a cleanup
patch would end up doing

[Packages]