Bug 26692 - prepare-ChangeLog should bail out when missing EMAIL_ADDRESS or REAL_NAME
Summary: prepare-ChangeLog should bail out when missing EMAIL_ADDRESS or REAL_NAME
Status: RESOLVED FIXED
Alias: None
Product: WebKit
Classification: Unclassified
Component: Tools / Tests (show other bugs)
Version: 528+ (Nightly build)
Hardware: Mac OS X 10.5
: P2 Normal
Assignee: Nobody
URL:
Keywords:
Depends on:
Blocks:
 
Reported: 2009-06-24 14:08 PDT by Eric Seidel (no email)
Modified: 2009-07-01 16:31 PDT (History)
4 users (show)

See Also:


Attachments
First attempt (4.04 KB, patch)
2009-07-01 14:25 PDT, Eric Seidel (no email)
no flags Details | Formatted Diff | Diff
Now with more sanity checking (4.89 KB, patch)
2009-07-01 14:49 PDT, Eric Seidel (no email)
aroben: review+
Details | Formatted Diff | Diff

Note You need to log in before you can comment on or make changes to this bug.
Description Eric Seidel (no email) 2009-06-24 14:08:32 PDT
prepare-ChangeLog should bail out when missing EMAIL_ADDRESS or REAL_NAME

Right now it just dumps instructions into the template.  This causes people to post bad ChangeLogs and waste reviewer time.
Comment 1 Eric Seidel (no email) 2009-06-24 14:08:54 PDT
prepare-ChangeLog should take --name= and --email= arguments if it doesn't already.
Comment 2 Eric Seidel (no email) 2009-07-01 14:25:28 PDT
Created attachment 32141 [details]
First attempt
Comment 3 Eric Seidel (no email) 2009-07-01 14:26:28 PDT
The windows code path might still need some tweaking from one of the windows folks.  But this should at least get rid of one more source of needless reviewer timewaste (telling people to fix the names in their ChangeLogs). :)
Comment 4 Eric Seidel (no email) 2009-07-01 14:28:44 PDT
I'm not sure that adding --email= and --name= is actually worth it.  I am happy to remove them if the reviewer agrees.  It's very easy to do:
REAL_NAME="Eric Seidel" prepare-ChangeLog

or just as easy as:
prepare-ChangeLog --name="Eric Seidel"

I think we should be encouraging people to use the environment variables.  I initially added --name and --email because I wanted to leave flexibility if I was making prepare-ChangeLog fail more strictly.
Comment 5 Eric Seidel (no email) 2009-07-01 14:49:33 PDT
Created attachment 32144 [details]
Now with more sanity checking
Comment 6 Adam Roben (:aroben) 2009-07-01 15:33:16 PDT
Comment on attachment 32144 [details]
Now with more sanity checking

> @@ -94,6 +96,8 @@ sub normalizePath($);
>  # Project time zone for Cupertino, CA, US
>  my $changeLogTimeZone = "PST8PDT";
>  
> +my $name;
> +my $email_address;
>  my $gitCommit = 0;
>  my $gitIndex = "";

You've been infected (cleansed?) by Python. Please use interCaps for variable names.

r=me
Comment 7 Eric Seidel (no email) 2009-07-01 16:27:50 PDT
The script uses mixed variable naming styles.  email_address is historical... but I've changed it to emailAddress now.  Thanks for the review!
Comment 8 Eric Seidel (no email) 2009-07-01 16:31:41 PDT
Committing to http://svn.webkit.org/repository/webkit/trunk ...
	M	WebKitTools/ChangeLog
	M	WebKitTools/Scripts/prepare-ChangeLog
Committed r45455
http://trac.webkit.org/changeset/45455