Mailing-List: contact derby-dev-help@db.apache.org; run by ezmlm
Precedence: bulk
Reply-To: <derby-dev@db.apache.org>
Received-SPF: pass (herse.apache.org: local policy)
Date: Mon, 18 Jun 2007 08:42:30 -0700
From: Rick Hillegas <Richard.Hillegas@Sun.COM>
Subject: Re: New lint tool for verifying that your release note can be
 digested
 by the build processes
In-reply-to: <20070617190638.GD17996@localhost.localdomain>
Sender: Richard.Hillegas@Sun.COM
To: derby-dev@db.apache.org
Message-id: <4676A7E6.90400@sun.com>
MIME-version: 1.0
Content-type: multipart/mixed; boundary="Boundary_(ID_6ZV5R06opf8A2+qRd3Sz0g)"
References: <467455DB.8040605@sun.com>
 <20070617190638.GD17996@localhost.localdomain>
User-Agent: Thunderbird 1.5.0.5 (X11/20060828)

This is a multi-part message in MIME format.

--Boundary_(ID_6ZV5R06opf8A2+qRd3Sz0g)
Content-type: text/plain; format=flowed; charset=ISO-8859-1
Content-transfer-encoding: 7BIT

Bernt M. Johnsen wrote:
>>>>>>>>>>>>> Rick Hillegas wrote (2007-06-16 14:27:55):
>>>>>>>>>>>>>                           
>> Before attaching a release note to a JIRA, please run the following lint 
>> tool on your release note. This will help us catch problems early on so 
>> that release generation will be easier:
>>
>>    java org.apache.derbyBuild.ReleaseNoteReader RELEASE_NOTE_FILE
>>
>> where RELEASE_NOTE_FILE is the name of the file which holds your release 
>> note. I have documented this extra lint step at 
>> http://wiki.apache.org/db-derby/ReleaseNoteProcess
>>     
>
> Re your release notes scrubbing: Should not this wiki page state that
> the release not file should be XHTML , and should'nt then the
> releaseNote file have the extension .xhmtl?
>
>   
Hi Bernt,

I took a releaseNote.html and converted it to releaseNote.xhtml as follows:

1) I added the following boilerplate to the beginning of the file:

<?xml version="1.0" encoding="utf-8"?>

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">


2) Then I changed the <html> tag to the following. This was the crucial 
step which convinced Firefox to display the file as html rather than as 
xml. I don't know if this will coax other browsers to do the same:

<html xmlns="http://www.w3.org/1999/xhtml">


The result was a file which:

A) Declared its namespace--always a good thing.

B) Displayed as html (and was accepted by the lint tool) provided that 
the syntax looked good.

C) Displayed as parser diagnostics (and flunked the lint tool) if I 
inserted broken syntax.


For the next release, I think that we could move to xhtml rather than 
html as the format for release notes. However, before making that 
change, I would like to feel confident that this xhtml displays as html 
in other browsers like Internet Explorer and Safari. That will help 
people write xhtml that looks right in addition to being safe for the 
SAX parser. I'm attaching my simple test file. I would appreciate 
feedback from people who pilot other browsers.

Thanks,
-Rick

--Boundary_(ID_6ZV5R06opf8A2+qRd3Sz0g)
Content-type: application/xhtml+xml; name=releaseNote.xhtml
Content-transfer-encoding: BASE64
Content-disposition: inline; filename=releaseNote.xhtml

PD94bWwgdmVyc2lvbj0iMS4wIiBlbmNvZGluZz0idXRmLTgiPz4KCjwhRE9DVFlQ
RSBodG1sIFBVQkxJQyAiLS8vVzNDLy9EVEQgWEhUTUwgMS4xLy9FTiIKImh0dHA6
Ly93d3cudzMub3JnL1RSL3hodG1sMTEvRFREL3hodG1sMTEuZHRkIj4KCjwhLS0K
ICBMaWNlbnNlZCB0byB0aGUgQXBhY2hlIFNvZnR3YXJlIEZvdW5kYXRpb24gKEFT
RikgdW5kZXIgb25lIG9yIG1vcmUKICBjb250cmlidXRvciBsaWNlbnNlIGFncmVl
bWVudHMuICBTZWUgdGhlIE5PVElDRSBmaWxlIGRpc3RyaWJ1dGVkIHdpdGgKICB0
aGlzIHdvcmsgZm9yIGFkZGl0aW9uYWwgaW5mb3JtYXRpb24gcmVnYXJkaW5nIGNv
cHlyaWdodCBvd25lcnNoaXAuCiAgVGhlIEFTRiBsaWNlbnNlcyB0aGlzIGZpbGUg
dG8geW91IHVuZGVyIHRoZSBBcGFjaGUgTGljZW5zZSwgVmVyc2lvbiAyLjAKICAo
dGhlICJMaWNlbnNlIik7IHlvdSBtYXkgbm90IHVzZSB0aGlzIGZpbGUgZXhjZXB0
IGluIGNvbXBsaWFuY2Ugd2l0aAogIHRoZSBMaWNlbnNlLiAgWW91IG1heSBvYnRh
aW4gYSBjb3B5IG9mIHRoZSBMaWNlbnNlIGF0CgogICAgICBodHRwOi8vd3d3LmFw
YWNoZS5vcmcvbGljZW5zZXMvTElDRU5TRS0yLjAKCiAgVW5sZXNzIHJlcXVpcmVk
IGJ5IGFwcGxpY2FibGUgbGF3IG9yIGFncmVlZCB0byBpbiB3cml0aW5nLCBzb2Z0
d2FyZQogIGRpc3RyaWJ1dGVkIHVuZGVyIHRoZSBMaWNlbnNlIGlzIGRpc3RyaWJ1
dGVkIG9uIGFuICJBUyBJUyIgQkFTSVMsCiAgV0lUSE9VVCBXQVJSQU5USUVTIE9S
IENPTkRJVElPTlMgT0YgQU5ZIEtJTkQsIGVpdGhlciBleHByZXNzIG9yIGltcGxp
ZWQuCiAgU2VlIHRoZSBMaWNlbnNlIGZvciB0aGUgc3BlY2lmaWMgbGFuZ3VhZ2Ug
Z292ZXJuaW5nIHBlcm1pc3Npb25zIGFuZAogIGxpbWl0YXRpb25zIHVuZGVyIHRo
ZSBMaWNlbnNlLgotLT4KPCEtLQogIFRFTVBMQVRFIEZPUiBDUkVBVElORyBBIFJF
TEVBU0UgTk9URSBGT1IgQSBTSUdOSUZJQ0FOVCBKSVJBIEVOVFJZCgogIFRoaXMg
aXMgYSBzdGFuZGFyZCBmb3JtIGZvciBmaWxsaW5nIGluIGEgcmVsZWFzZSBub3Rl
IGZvciBhCiAgc2lnbmlmaWNhbnQgaXNzdWUgbG9nZ2VkIGluIEpJUkEuIFRoaXMg
Y291bGQgYmUgYW4gaXNzdWUKICB3aGljaCBpbnRyb2R1Y2VzIGEgbmV3IGZlYXR1
cmUuIE9yIGl0IGNvdWxkIGJlIGFuIGlzc3VlCiAgd2hpY2ggY2hhbmdlcyBEZXJi
eSBpbiBhIHdheSB3aGljaCBicmVha3MgZXhpc3RpbmcKICBhcHBsaWNhdGlvbnMu
IEJ5IHVzaW5nIHRoaXMgc3RhbmRhcmQgZm9ybSwgeW91IGhlbHAgdGhlCiAgcmVs
ZWFzZSBtYW5hZ2VyIGdlbmVyYXRlIGRvY3VtZW50YXRpb24gZm9yIHRoZSBuZXh0
CiAgcmVsZWFzZS4KCiAgV2hlbiB5b3UgYXJlIGRvbmUgZmlsbGluZyBpbiB0aGlz
IGZvcm0sIGF0dGFjaCBpdCB0byB0aGUgYXBwcm9wcmlhdGUKICBKSVJBIGFzICJy
ZWxlYXNlTm90ZS5odG1sIi4gWW91IGNhbiBpbXByb3ZlIHlvdXIgcmVsZWFzZSBu
b3RlIGFzCiAgbWFueSB0aW1lcyBhcyB5b3UgbGlrZS4gVGhlIHJlbGVhc2UgbWFj
aGluZXJ5IHdpbGwgc2ltcGx5IHVzZSB0aGUKICBsYXN0IHZlcnNpb24gb2YgcmVs
ZWFzZU5vdGUuaHRtbCBhdHRhY2hlZCB0byB0aGUgSklSQS4KCiAgVGhpcyB0ZW1w
bGF0ZSBoYXMgdGhlIGZvbGxvd2luZyBzdGFuZGFyZCBzZWN0aW9ucy4gQnJhY2tl
dHMgbWFyawogIG9wdGlvbmFsIHNlY3Rpb25zLgoKICBTdW1tYXJ5IG9mIENoYW5n
ZQogIFN5bXB0b21zIFNlZW4gYnkgQXBwbGljYXRpb25zIEFmZmVjdGVkIGJ5IENo
YW5nZQogIFsgSW5jb21wYXRpYmlsaXRpZXMgd2l0aCBQcmV2aW91cyBSZWxlYXNl
IF0KICBSYXRpb25hbGUgZm9yIENoYW5nZQogIFsgQXBwbGljYXRpb24gQ2hhbmdl
cyBSZXF1aXJlZCBdCgogIEdvIHRocm91Z2ggdGhpcyB0ZW1wbGF0ZSBhbmQgcmVw
bGFjZSBhbGwgaW5zdGFuY2VzIG9mICI/Pz8/IiB3aXRoCiAgYXBwcm9wcmlhdGUg
dGV4dC4gUmVtb3ZlIHRoZSBvcHRpb25hbCBzZWN0aW9ucyBpZiB5b3UgZG9uJ3Qg
bmVlZCB0aGVtLgoKLS0+Cgo8aHRtbCB4bWxucz0iaHR0cDovL3d3dy53My5vcmcv
MTk5OS94aHRtbCI+Cjxib2R5PgoKPCEtLSAKICBTVU1NQVJJWkUgVEhFIElTU1VF
LiBUaGlzIGlzIGEgb25lIGxpbmUgc3VtbWFyeSBvZiB0aGUgaXNzdWUuCgogIEZv
ciBpbnN0YW5jZToKCiAgQXBwbGljYXRpb25zIG1heSBubyBsb25nZXIgb3BlbiB0
d28gSW5wdXRTdHJlYW1zIG9uIHRoZSBzYW1lIFJlc3VsdFNldCBjb2x1bW4uCi0t
PgoKPGg0PlN1bW1hcnkgb2YgQ2hhbmdlPC9oND4KPHA+Cj8/Pz8KPC9wPgoKCjxQ
PgpXaWxsIHRoaXMgd29yaz8KPC9QPgoKPCEtLSAKICBERVNDUklCRSBXSEFUIElU
IElTIFRIQVQgVEhFIFVTRVIgQUNUVUFMTFkgU0VFUyBXSEVOIFRIRSBQUk9CTEVN
IE9DQ1VSUy4KCiAgRm9yIGluc3RhbmNlOgoKICBJbiB0aGUgcHJldmlvdXMgcmVs
ZWFzZSwgYXBwbGljYXRpb25zIHdlcmUgYWJsZSB0byBvcGVuIHR3bwogIElucHV0
U3RyZWFtcyBvbiB0aGUgc2FtZSBjb2x1bW4uIERlcGVuZGluZyBvbiBob3cgdGhl
c2Ugc3RyZWFtcwogIGludGVyYWN0ZWQsIHRoZSB2YWx1ZSBzaXBob25lZCBvdXQg
b2YgdGhlIGNvbHVtbiB3YXMgZXJyYXRpYy4gTm93CiAgRGVyYnkgcmFpc2VzIGEg
U1FMRXhjZXB0aW9uIHdoZW4gdGhlIGFwcGxpY2F0aW9uIGF0dGVtcHRzIHRvIGNy
ZWF0ZQogIHRoZSBzZWNvbmQgSW5wdXRTdHJlYW0uCi0tPgoKPGg0PlN5bXB0b21z
IFNlZW4gYnkgQXBwbGljYXRpb25zIEFmZmVjdGVkIGJ5IENoYW5nZTwvaDQ+Cjxw
Pgo/Pz8/CjwvcD4KCgo8IS0tIAogIE9QVElPTkFMOiBERVNDUklCRSBJTkNPTVBB
VElCSUxJVElFUyBXSVRIIFBSRVZJT1VTIFJFTEVBU0UsIElGIEFOWS4KCiAgRm9y
IGluc3RhbmNlOgoKICBBcHBsaWNhdGlvbnMgd2hpY2ggb3BlbiB0d28gSW5wdXRT
dHJlYW1zIG9uIHRoZSBSZXN1bHRTZXQgY29sdW1uIG5vdwogIGZhaWwuCi0tPgoK
PGg0PkluY29tcGF0aWJpbGl0aWVzIHdpdGggUHJldmlvdXMgUmVsZWFzZTwvaDQ+
CjxwPgo/Pz8/CjwvcD4KCgo8IS0tIAogIERFU0NSSUJFIFdIWSBUSEUgQ0hBTkdF
IFdBUyBNQURFLgoKICBGb3IgaW5zdGFuY2U6CgogIFRoZSBwcmV2aW91cyBiZWhh
dmlvciB2aW9sYXRlZCB0aGUgSkRCQyBzdGFuZGFyZC4gVGhlIG5ldyBiZWhhdmlv
cgogIGlzIGNvcnJlY3QuCi0tPgoKPGg0PlJhdGlvbmFsZSBmb3IgQ2hhbmdlPC9o
ND4KPHA+Cj8/Pz8KPC9wPgoKCjwhLS0gCiAgT1BUSU9OQUw6IERFU0NSSUJFIEhP
VyBUTyBSRVZFUlQgVE8gVEhFIFBSRVZJT1VTIEJFSEFWSU9SIE9SCiAgT1RIRVJX
SVNFIEFWT0lEIFRIRSBJTkNPTVBBVElCSUxJVElFUyBJTlRST0RVQ0VEIEJZIFRI
SVMgQ0hBTkdFLgoKICBGb3IgaW5zdGFuY2U6CgogIFVzZXJzIG11c3QgcmVjb2Rl
IGFwcGxpY2F0aW9ucyB3aGljaCBvcGVuIG11bHRpcGxlIHN0cmVhbXMgb24gdGhl
IHNhbWUgY29sdW1uLgotLT4KCjxoND5BcHBsaWNhdGlvbiBDaGFuZ2VzIFJlcXVp
cmVkPC9oND4KPHA+Cj8/Pz8KPC9wPgoKCjwvYm9keT4KPC9odG1sPgo=

--Boundary_(ID_6ZV5R06opf8A2+qRd3Sz0g)--