[Geotools-devel] Copyright Headers and Graduation

[Adrian C. <ac...@gm...>]

Hey all,

The core modules of Geotools, those in modules/library/main all should
now read:

  (C) xxxx-2008, Open Source Geospatial Foundation (OSGeo)

so congratulations to everyone for the work!



Module maintainers should all have updated their review.txt files. Let's
get to it so we can graduate!



Cameron, 

we're probably late for your timeline and we just missed today's OSGeo
meeting but we're gunning for the next one. Not sure there's anything
for you to do but here's your heads up.

--adrian


Changing headers over from the old style is relatively easy. Here's my
workflow.

PREP

1) svn up
2) mvn clean install -Dmaven.test.skip=true
3) mv target target2
4) cp build/scm/cleanup/cleanup/target/cleanup-2.5-SNAPSHOT.jar\
       target2/binaries/.
5) alias gtclean 'java -jar target2/binaries/cleanup-2.5-SNAPSHOT.jar`


CLEAN:  for each module

A. gtclean --input path/to/module/head/
==> shows what is going to happen
A.1)look at all the files that aren't going to be handled cleanly
A.2)see if an extra line is needed before the (C) file, if so you will
need to use the --insertSpacerLine flag


B. gtclean --input path/to/module/head/ --write (--insertSpacerLine)
==> shows what it did
B.1 look at any files that have been mishandled.


C. gedit `find ./path/to/module/head/ -name "*\.java"`
==> look for duplicate headers, wierd copyrights
C.1 edit files as needed and note unusual stuff If there are (C) lines
left not handled by the script, we need to compare against
http://docs.codehaus.org/display/GEOTOOLS/GeoTools+Contributor+Status
their status.


D. gedit review.txt
==> compare to any wierd stuff you have found
D.1) remove all the notes to the effect that the headers were updated
leaving only the notices of unusual stuff, external copyrights.
D.2) save the changes


E. svn diff | less
==> let's see what we've done
E.1) look for any unusual edits, we should only be changing the headers
although there are occasional other changes like adding a newline at the
end of the file.


F. mvn clean install
Okay, I did skip the tests occasionally but you shouldn't, no way, don't
you dare.


G. svn ci -m "Some very pithy commit message"


There, doesn't that inspire everyone to go out and clean their modules?

--adrian