280656 - Remove UTF-8 BOMs from source files

Status: RESOLVED FIXED

(SeaMonkey :: General, defect)

Description

[Simon Montagu :smontagu]

UTF-8 BOMs (EF BB BF) at the beginning of source files are not good. Among other
problems they prevent LXR from indexing files. Example:
http://lxr.mozilla.org/seamonkey/find?string=bug41262 finds all files from
bug41262-1.html to bug41262-6.html, except for bug41262-2.html.

Comment 1

[Simon Montagu :smontagu]

Attachment: Remove the BOMs

Comment 2

[Jungshik Shin]

Comment on attachment 173077 [details] [diff] [review]
Remove the BOMs

r=jshin
Perhaps, we have to document very clearly that UTF-8 BOM is not welcome in the
tree. (Windows users are prone to commit this mistake.)  In addition, an
automatic 'sanitizer' would be handy (how? hacking cvs server running at
cvs.mozilla.org or ...)

Comment 3

[Brendan Eich [:brendan]]

Comment on attachment 173077 [details] [diff] [review]
Remove the BOMs

rs=me on any such future changes.

/be

Comment 4

[Simon Montagu :smontagu]

Thanks for reviews, fix checked in.

(In reply to comment #2)
> Perhaps, we have to document very clearly that UTF-8 BOM is not welcome in the
> tree. (Windows users are prone to commit this mistake.)

We should certainly something like "don't save source files as UTF-8 from
Windows Notepad" to the docs at http://www.mozilla.org/hacking/

Comment 5

[Jungshik Shin]

For those who may come to this bug in the future: bug 280789 was filed for the
documentation.