1412346 - Clean up license blocks & mode lines in /layout

Status: RESOLVED FIXED

(Core :: Layout, defect, P5)

Description

[Daniel Holbert [:dholbert]]

mccr8 has a script[1] that can do some automated fixup of modelines in C++ files -- adding our standard modeline (with 2-space indent) for files that it detects as being Mozilla code (with MPL) and that it detects as being correctly 2-space indented.  (It's smart enough to know it should avoid adding a 2-space-indentation modeline to 4-space-indented files.)

I'm filing this bug on running that tool over /layout.  The patch-stack here will start out with fixes for a few anomalous things that cause the script to throw up its hands (e.g. missing or wrong license block), and then finally I'll post the automated patch itself.

[1] https://github.com/amccreight/moz-source-tools/blob/master/modeline.py

Comment 1

[Daniel Holbert [:dholbert]]

Attachment: Bug 1412346 part 1: Add standard mode line & MPL boilerplate to a few layout C++ files that are missing it entirely.

Note that I'm intentionally *not* leaving a blank line between the license
block and the "IWYU pragma" line, in nsDisplayItemTypesList.h. This matches the
prevailing style that I found in other files that have "IWYU pragma" lines.

I copied the boilerplate comment directly from the Coding Style MDN page:
https://developer.mozilla.org/en-US/docs/Mozilla/Developer_guide/Coding_Style#Mode_Line

Review commit: https://reviewboard.mozilla.org/r/194040/diff/#index_header
See other reviews: https://reviewboard.mozilla.org/r/194040/

Comment 2

[Daniel Holbert [:dholbert]]

Attachment: Bug 1412346 part 2: Split mode line into its own C++ comment & own line, in a few files within layout.

(This brings these lines into conformance with our standard style for mode
lines, and it's required in order for the modeline.py script to be able to
process these files.)

Review commit: https://reviewboard.mozilla.org/r/194042/diff/#index_header
See other reviews: https://reviewboard.mozilla.org/r/194042/

Comment 3

[Daniel Holbert [:dholbert]]

Attachment: Bug 1412346 part 3: Move a misplaced "IWYU pragma" comment down a few lines to match our convention and so mode line can be first.

Review commit: https://reviewboard.mozilla.org/r/194044/diff/#index_header
See other reviews: https://reviewboard.mozilla.org/r/194044/

Comment 4

[Daniel Holbert [:dholbert]]

Attachment: Bug 1412346 part 4: Update stale MPL license boilerplate on a few files in layout.

We have a fair number of files that have a particular stale version of the MPL
boilerplate.  (It was probably originally correct, and then the official
boilerplate changed, and the stale MPL boilerplate continued to propagate via
copypasting from neighboring files into newly-added files.)

This patch updates this stale MPL text (and *only* the MPL text) to the latest
version, which can be found at https://www.mozilla.org/en-US/MPL/headers/ and
https://developer.mozilla.org/en-US/docs/Mozilla/Developer_guide/Coding_Style#Mode_Line

Review commit: https://reviewboard.mozilla.org/r/194046/diff/#index_header
See other reviews: https://reviewboard.mozilla.org/r/194046/

Comment 5

[Daniel Holbert [:dholbert]]

Attachment: Bug 1412346 part 5: (automated patch) Switch a bunch of C++ files in layout to use our standard mode lines.

This patch was generated automatically by the "modeline.py" script, available
here: https://github.com/amccreight/moz-source-tools/blob/master/modeline.py

For every file that is modified in this patch, the changes are as follows:
 (1) The patch changes the file to use the exact C++ mode lines from the
     Mozilla coding style guide, available here:
https://developer.mozilla.org/en-US/docs/Mozilla/Developer_guide/Coding_Style#Mode_Line

 (2) The patch deletes any blank lines between the mode line & the MPL
     boilerplate comment.

 (3) If the file previously had the mode lines and MPL boilerplate in a
     single contiguous C++ comment, then the patch splits them into
     separate C++ comments, to match the boilerplate in the coding style.

Review commit: https://reviewboard.mozilla.org/r/194048/diff/#index_header
See other reviews: https://reviewboard.mozilla.org/r/194048/

Comment 6

[Jonathan Kew [:jfkthame]]

Comment on attachment 8922898 [details]
Bug 1412346 part 1: Add standard mode line & MPL boilerplate to a few layout C++ files that are missing it entirely.

https://reviewboard.mozilla.org/r/194040/#review199114

Comment 7

[Jonathan Kew [:jfkthame]]

Comment on attachment 8922899 [details]
Bug 1412346 part 2: Split mode line into its own C++ comment & own line, in a few files within layout.

https://reviewboard.mozilla.org/r/194042/#review199116

Comment 8

[Jonathan Kew [:jfkthame]]

Comment on attachment 8922900 [details]
Bug 1412346 part 3: Move a misplaced "IWYU pragma" comment down a few lines to match our convention and so mode line can be first.

https://reviewboard.mozilla.org/r/194044/#review199118

Comment 9

[Jonathan Kew [:jfkthame]]

Comment on attachment 8922901 [details]
Bug 1412346 part 4: Update stale MPL license boilerplate on a few files in layout.

https://reviewboard.mozilla.org/r/194046/#review199120

Comment 10

[Jonathan Kew [:jfkthame]]

Comment on attachment 8922902 [details]
Bug 1412346 part 5: (automated patch) Switch a bunch of C++ files in layout to use our standard mode lines.

https://reviewboard.mozilla.org/r/194048/#review199122

I'm sure you'll be pleased to know that I carefully checked every one of these files.... ;)

Comment 11

[Daniel Holbert [:dholbert]]

Thanks for the review! :D

I triggered a linux-builds-only Try run, to be sure I didn't screw something up with a comment-tweak, and I'm rebuilding locally as well. I'll go ahead and trigger autoland as soon as one or the other of those builds finishes.

Comment 12

[Pulsebot]

Pushed by [e-mail]:
https://hg.mozilla.org/integration/autoland/rev/2a807f9ddba9
part 1: Add standard mode line & MPL boilerplate to a few layout C++ files that are missing it entirely. r=jfkthame
https://hg.mozilla.org/integration/autoland/rev/b2388646f983
part 2: Split mode line into its own C++ comment & own line, in a few files within layout. r=jfkthame
https://hg.mozilla.org/integration/autoland/rev/423370b7b006
part 3: Move a misplaced "IWYU pragma" comment down a few lines to match our convention and so mode line can be first. r=jfkthame
https://hg.mozilla.org/integration/autoland/rev/d5056038d25e
part 4: Update stale MPL license boilerplate on a few files in layout. r=jfkthame
https://hg.mozilla.org/integration/autoland/rev/905239391e05
part 5: (automated patch) Switch a bunch of C++ files in layout to use our standard mode lines. r=jfkthame

Comment 13

[Sebastian Hengst [:aryx] (needinfo me if it's about an intermittent or backout)]

https://hg.mozilla.org/mozilla-central/rev/2a807f9ddba9
https://hg.mozilla.org/mozilla-central/rev/b2388646f983
https://hg.mozilla.org/mozilla-central/rev/423370b7b006
https://hg.mozilla.org/mozilla-central/rev/d5056038d25e
https://hg.mozilla.org/mozilla-central/rev/905239391e05