1412427 - Clean up license blocks & mode lines in /gfx

Status: RESOLVED FIXED

(Core :: Graphics, enhancement, P3)

Description

[Daniel Holbert [:dholbert]]

As in bug 1412346, let's use mccr8's modeline.py script[1] to standardize our modelines in /gfx.

This requires a few manual helper-patches to fix up anomalous modelines/MPL-license-blocks that the script doesn't recognize.  I'll post those patches first, and then the automatically-generated patch.

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

Comment 1

[Daniel Holbert [:dholbert]]

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

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/194186/diff/#index_header
See other reviews: https://reviewboard.mozilla.org/r/194186/

Comment 2

[Daniel Holbert [:dholbert]]

Attachment: Bug 1412427 part 2: Move vim mode line below emacs mode line in a few gfx files, for consistency.

This patch doesn't modify the mode lines at all -- it just swaps their order,
and makes each one its own C++ comment, separate from the MPL boilerplate
comment.

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

Comment 3

[Daniel Holbert [:dholbert]]

Attachment: Bug 1412427 part 3: Replace 10 gfx usages of a particular non-standard emacs mode line with our standard mode line.

This patch was mostly[1] automatically generated. I found the files to be fixed
in this patch with the following command:
grep -r "C++; indent-tabs-mode:" gfx/

...and then I modified each of these files with the following script
(where $1 is the filename to be modified):
###
old="/\* -\*- Mode: C++; indent-tabs-mode: nil; c-basic-offset: 4 -\*- \*/"
new="/\* -\*- Mode: C++; tab-width: 8; indent-tabs-mode: nil; c-basic-offset: 2 -\*- \*/"

sed -i s%"^$old"%"$new"% $1
###

[1] NOTE: Nearly all of these files use 2-space indentation, so it's correct
(from a consistency perspective and a reflecting-reality perspective) that
we're reducing their "c-basic-offset: 4" down to "c-basic-offset: 2" here.  The
one exception is nsDeviceContext.h, which *does* actually use 4-space
indentation right now -- so I'm leaving that file with "c-basic-offset: 4" in
its mode line.  This manual change (reverting 1 character from the automated
process) is the only piece of this patch that isn't automated.

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

Comment 4

[Daniel Holbert [:dholbert]]

Attachment: Bug 1412427 part 4: Indent under-indented MPL boilerplate comments by 1 space, for consistency & alignment. (whitespace-only)

This patch was automatically generated. I found the files to be fixed in this
patch with the following command:
grep -r "^\* This Source Code" *

...and then I modified each of these files with the following script
(where $1 is the filename to be modified):
###
line1="\* This Source Code Form is subject to the terms of the Mozilla Public"
line2="\* License, v\. 2\.0\. If a copy of the MPL was not distributed with this"
line3="\* file, You can obtain one at http://mozilla\.org/MPL/2\.0/\. \*/"

# Insert 1 space at beginning:
sed -i s%"^$line1"%" $line1"% $1
sed -i s%"^$line2"%" $line2"% $1
sed -i s%"^$line3"%" $line3"% $1
###

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

Comment 5

[Daniel Holbert [:dholbert]]

Attachment: Bug 1412427 part 5: Deindent over-indented MPL boilerplate comments down to 1 space, for consistency & alignment. (whitespace-only)

This patch was automatically generated. I found the files to be fixed in this
patch with the following command:
grep -r "  \* This Source Code" *

...and then I modified each of these files with the following script
(where $1 is the filename to be modified):
###
line1=" \* This Source Code Form is subject to the terms of the Mozilla Public"
line2=" \* License, v\. 2\.0\. If a copy of the MPL was not distributed with this"
line3=" \* file, You can obtain one at http://mozilla\.org/MPL/2\.0/\. \*/"

# Strip off 1 space at beginning:
sed -i s%"^ $line1"%"$line1"% $1
sed -i s%"^ $line2"%"$line2"% $1
sed -i s%"^ $line3"%"$line3"% $1
###

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

Comment 6

[Daniel Holbert [:dholbert]]

Attachment: Bug 1412427 part 6: Remove stray "//" prefix before first line of MPL boilerplate comment, in some gfx source files.

This patch was automatically generated. I found the files to be fixed in this
patch with the following command:
grep -r "//  \* This Source Code" *

...and then I modified each of these files with the following script
(where $1 is the filename to be modified):
####
old="//  \* This Source Code Form is subject to the terms of the Mozilla Public"
new=" \* This Source Code Form is subject to the terms of the Mozilla Public"
sed -i s%"^$old"%"$new"% $1
####

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

Comment 7

[Daniel Holbert [:dholbert]]

Attachment: Bug 1412427 part 7: Manually fix up a few non-standard quirks in mode lines & MPL text, in gfx source files.

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

Comment 8

[Daniel Holbert [:dholbert]]

Attachment: Bug 1412427 part 8: (automated patch) Switch a bunch of C++ files in gfx 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/194204/diff/#index_header
See other reviews: https://reviewboard.mozilla.org/r/194204/

Comment 9

[Daniel Holbert [:dholbert]]

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

Review request updated; see interdiff: https://reviewboard.mozilla.org/r/194186/diff/1-2/

Comment 10

[Daniel Holbert [:dholbert]]

Comment on attachment 8923000 [details]
Bug 1412427 part 2: Move vim mode line below emacs mode line in a few gfx files, for consistency.

Review request updated; see interdiff: https://reviewboard.mozilla.org/r/194188/diff/1-2/

Comment 11

[Daniel Holbert [:dholbert]]

Comment on attachment 8923001 [details]
Bug 1412427 part 3: Replace 10 gfx usages of a particular non-standard emacs mode line with our standard mode line.

Review request updated; see interdiff: https://reviewboard.mozilla.org/r/194190/diff/1-2/

Comment 12

[Daniel Holbert [:dholbert]]

Comment on attachment 8923002 [details]
Bug 1412427 part 4: Indent under-indented MPL boilerplate comments by 1 space, for consistency & alignment. (whitespace-only)

Review request updated; see interdiff: https://reviewboard.mozilla.org/r/194192/diff/1-2/

Comment 13

[Daniel Holbert [:dholbert]]

Comment on attachment 8923003 [details]
Bug 1412427 part 5: Deindent over-indented MPL boilerplate comments down to 1 space, for consistency & alignment. (whitespace-only)

Review request updated; see interdiff: https://reviewboard.mozilla.org/r/194194/diff/1-2/

Comment 14

[Daniel Holbert [:dholbert]]

Comment on attachment 8923004 [details]
Bug 1412427 part 6: Remove stray "//" prefix before first line of MPL boilerplate comment, in some gfx source files.

Review request updated; see interdiff: https://reviewboard.mozilla.org/r/194196/diff/1-2/

Comment 15

[Daniel Holbert [:dholbert]]

Comment on attachment 8923005 [details]
Bug 1412427 part 7: Manually fix up a few non-standard quirks in mode lines & MPL text, in gfx source files.

Review request updated; see interdiff: https://reviewboard.mozilla.org/r/194198/diff/1-2/

Comment 16

[Daniel Holbert [:dholbert]]

Hmm, I'm noticing that there's one generated file that's being modified by the final modeline.py-generated patch here: webrender_ffi_generated.h

(It's kind of a valid modification, in the sense that the generated file *is* mozilla code & has MPL boilerplate but no modeline.  But we probably shouldn't make that modification because it'll get stomped on if/when we regenerate the file).

I'll update the script to avoid making that modification.

Comment 17

[Daniel Holbert [:dholbert]]

Comment on attachment 8923006 [details]
Bug 1412427 part 8: (automated patch) Switch a bunch of C++ files in gfx to use our standard mode lines.

Review request updated; see interdiff: https://reviewboard.mozilla.org/r/194204/diff/1-2/

Comment 18

[Daniel Holbert [:dholbert]]

Attachment: list of files touched by first patches (parts 1-7)

For reference: here's a text file with a list of all the files touched by the non-modeline.py patches here (parts 1 through 7, the more easily-digestable patches).

Comment 19

[Daniel Holbert [:dholbert]]

Attachment: list of files touched by last patch (part 8)

...and here's a list of the files touched by the final modeline.py-generated patch (part 8).

Comment 20

[Daniel Holbert [:dholbert]]

I grepped all of the touched files (case-insensitive) for various strings, to screen for any other auto-generated files that aren't supposed to be touched, and I've convinced myself that I'm OK in that department.

Specifically, I grepped for: "generated", "this file", "manual", and "modify".  None of the matches looked like a "do not modify this file" comment of any sort.

Also, in case you're curious: I'm excluding all the 3rd-party GFX code via the "blacklist" mechanisms in modeline.py -- specifically here:
  https://github.com/amccreight/moz-source-tools/blob/master/modeline.py/#L43-L74

(The upper blacklist is for entire directory trees whose subdirs we want to exclude from consideration. The lower blacklist is more targeted, for just specific flat directories where we don't need to worry about subdirectories.)

Comment 21

[Jonathan Kew (:jfkthame)]

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

https://reviewboard.mozilla.org/r/194184/#review199468

This cleanup seems fine IMO, but given that it cuts across such a broad swath of gfx, much of which is entirely outside my area, I'd feel better if we got sign-off from someone like jrmuizel as overall gfx owner.

Jeff, are you happy to take over the review (or should I say rubber-stamping) of the patches here?

Comment 22

[Jeff Muizelaar [:jrmuizel]]

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

https://reviewboard.mozilla.org/r/194186/#review199514

Comment 23

[Jeff Muizelaar [:jrmuizel]]

Comment on attachment 8923000 [details]
Bug 1412427 part 2: Move vim mode line below emacs mode line in a few gfx files, for consistency.

https://reviewboard.mozilla.org/r/194188/#review199516

Comment 24

[Jeff Muizelaar [:jrmuizel]]

Comment on attachment 8923001 [details]
Bug 1412427 part 3: Replace 10 gfx usages of a particular non-standard emacs mode line with our standard mode line.

https://reviewboard.mozilla.org/r/194190/#review199518

Comment 25

[Jeff Muizelaar [:jrmuizel]]

Comment on attachment 8923002 [details]
Bug 1412427 part 4: Indent under-indented MPL boilerplate comments by 1 space, for consistency & alignment. (whitespace-only)

https://reviewboard.mozilla.org/r/194192/#review199520

Comment 26

[Jeff Muizelaar [:jrmuizel]]

Comment on attachment 8923003 [details]
Bug 1412427 part 5: Deindent over-indented MPL boilerplate comments down to 1 space, for consistency & alignment. (whitespace-only)

https://reviewboard.mozilla.org/r/194194/#review199522

Comment 27

[Jeff Muizelaar [:jrmuizel]]

Comment on attachment 8923004 [details]
Bug 1412427 part 6: Remove stray "//" prefix before first line of MPL boilerplate comment, in some gfx source files.

https://reviewboard.mozilla.org/r/194196/#review199524

Comment 28

[Jeff Muizelaar [:jrmuizel]]

Comment on attachment 8923005 [details]
Bug 1412427 part 7: Manually fix up a few non-standard quirks in mode lines & MPL text, in gfx source files.

https://reviewboard.mozilla.org/r/194198/#review199526

Comment 29

[Jeff Muizelaar [:jrmuizel]]

Comment on attachment 8923006 [details]
Bug 1412427 part 8: (automated patch) Switch a bunch of C++ files in gfx to use our standard mode lines.

https://reviewboard.mozilla.org/r/194204/#review199528

Comment 30

[Daniel Holbert [:dholbert]]

Thanks, Jonathan & Jeff!

Comment 31

[Pulsebot]

Pushed by [e-mail]:
https://hg.mozilla.org/integration/autoland/rev/2aa5c6679b01
part 1: Add standard mode line & MPL boilerplate to a few gfx C++ files that are missing it entirely. r=jrmuizel
https://hg.mozilla.org/integration/autoland/rev/3a5488e8ada3
part 2: Move vim mode line below emacs mode line in a few gfx files, for consistency. r=jrmuizel
https://hg.mozilla.org/integration/autoland/rev/af0eea7b7840
part 3: Replace 10 gfx usages of a particular non-standard emacs mode line with our standard mode line. r=jrmuizel
https://hg.mozilla.org/integration/autoland/rev/3684005dea8c
part 4: Indent under-indented MPL boilerplate comments by 1 space, for consistency & alignment. (whitespace-only) r=jrmuizel
https://hg.mozilla.org/integration/autoland/rev/85498bffcea6
part 5: Deindent over-indented MPL boilerplate comments down to 1 space, for consistency & alignment. (whitespace-only) r=jrmuizel
https://hg.mozilla.org/integration/autoland/rev/06fc09933385
part 6: Remove stray "//" prefix before first line of MPL boilerplate comment, in some gfx source files. r=jrmuizel
https://hg.mozilla.org/integration/autoland/rev/75d088de9aa9
part 7: Manually fix up a few non-standard quirks in mode lines & MPL text, in gfx source files. r=jrmuizel
https://hg.mozilla.org/integration/autoland/rev/5f74d2629241
part 8: (automated patch) Switch a bunch of C++ files in gfx to use our standard mode lines. r=jrmuizel

Comment 32

[Daniel Holbert [:dholbert]]

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

https://reviewboard.mozilla.org/r/194186/#review199608

Comment 33

[Sebastian Hengst [:aryx] (needinfo on intermittent or backout)]

https://hg.mozilla.org/mozilla-central/rev/2aa5c6679b01
https://hg.mozilla.org/mozilla-central/rev/3a5488e8ada3
https://hg.mozilla.org/mozilla-central/rev/af0eea7b7840
https://hg.mozilla.org/mozilla-central/rev/3684005dea8c
https://hg.mozilla.org/mozilla-central/rev/85498bffcea6
https://hg.mozilla.org/mozilla-central/rev/06fc09933385
https://hg.mozilla.org/mozilla-central/rev/75d088de9aa9
https://hg.mozilla.org/mozilla-central/rev/5f74d2629241