[rfc][icedtea-web] Improvements for running the html-gen.sh script manually

[Jiri Vanek]

On 04/01/2015 12:34 PM, Jacob Wisor wrote:
> Hello there!
>
> I have come across a few problems while localizing IcedTea-Web for version 1.6.
> This patch improves running the html-gen.sh script manually. Okay to push?
>

The changes looks ok. Few nits inline which you may follow.

> Regards,
> Jacob
>
> html-gen.patch
>
>
> diff -r b7b28ec53a8b -r 239bf3e94c02 AUTHORS
> --- a/AUTHORS
> +++ b/AUTHORS
> @@ -10,7 +10,7 @@
>   Adam Domurad<adomurad at redhat.com>
>   Lukasz Dracz<ldracz at redhat.com>
>   Thomas Fitzsimmons<fitzsim at redhat.com>
> -Michał Górny <mgorny at gentoo.org  >
> +Michał Górny<mgorny at gentoo.org>
>   Mark Greenwood<mark at dcs.shef.ac.uk>
>   Peter Hatina<phatina at redhat.com>
>   Andrew John Hughes<ahughes at redhat.com>
> @@ -26,16 +26,16 @@
>   Thomas Meyer<thomas at m3y3r.de>
>   Kurt Miller<kurt at intricatesoftware.com>
>   Saad Mohammad<smohammad at redhat.com>
> -Martin Olsson<martin at minimum.se>
> +Martin Olsson<martin at minimum.se>
>   Fridrich Strba<fridrich.strba at suse.com>
>   Andrew Su<asu at redhat.com>
>   Joshua Sumali<jsumali at redhat.com>
>   Jiri Vanek<jvanek at redhat.com>
>   Mark Wielaard<mark at klomp.org>
> -Jacob Wisor<gitne at excite.co.jp>
> +Jacob Wisor<gitne at icedtea.classpath.org>
>   Man Lung Wong<mwong at redhat.com>
>
>   This project also includes code from the following projects:
>
>   OpenJDK<http://openjdk.java.net/>
> -Netx<http://jnlp.sourceforge.net/netx/>
> +NetX<http://jnlp.sourceforge.net/netx/>
> diff -r b7b28ec53a8b -r 239bf3e94c02 ChangeLog
> --- a/ChangeLog
> +++ b/ChangeLog
> @@ -1,3 +1,14 @@
> +2015-04-01  Jacob Wisor<gitne at icedtea.classpath.org>
> +
> +	* AUTHORS: Fix e-mail address formatting and update my e-mail address
> +	* ChangeLog: Update my e-mail address to reflect that in AUTHORS
> +	* Makefile.am: (stamps/netx-html-gen.stamp) Move creating the html-gen

Can you actually be contacted in this address?
Isnt more simple or even better to change the address in Authors?

> +	directory and copying of AUTHORS, COPYING, ChangeLog, and NEWS files into
> +	html-gen.sh script
> +	* html-gen.sh: Add automatic creating of the html-gen directory and copying
> +	of AUTHORS, COPYING, ChangeLog, and NEWS files when running the script
> +	manually
> +	
>   2015-03-31  Jiri Vanek<jvanek at redhat.com>
>
>   	* Messages.properties: (FILElogs) adapted to more suit current docs.
...
> diff -r b7b28ec53a8b -r 239bf3e94c02 Makefile.am
> --- a/Makefile.am
> +++ b/Makefile.am
> @@ -543,8 +543,6 @@
>
>   stamps/netx-html-gen.stamp:
>   	(cd $$NETX_SRCDIR/..; \
> -	mkdir -p html-gen; \
> -	cp AUTHORS NEWS COPYING ChangeLog html-gen/; \
>   	export HTML_GEN_DEBUG=true; \
>   	bash html-gen.sh; \
>   	unset HTML_GEN_DEBUG)
> diff -r b7b28ec53a8b -r 239bf3e94c02 html-gen.sh
> --- a/html-gen.sh
> +++ b/html-gen.sh
> @@ -1,7 +1,7 @@
>   #!/bin/bash
>
>   # html-gen.sh
> -#   Copyright (C) 2013  Red Hat
> +#   Copyright (C) 2015  Red Hat
>   #
>   # This file is part of IcedTea.
>   #
> @@ -45,16 +45,17 @@
>   # same directory as this script. These generated HTML documents are then used
>   # in the netx About Dialog, which can be invoked with "javaws -about".
>
> -# The only configuration option is the number of Changesets, and the files processed
> -# are hardcoded. To run the script manually, create a directory "html-gen" in the
> -# same directory as this script, containing files named AUTHORS, NEWS, ChangeLog,
> -# and COPYING. Note that these files WILL be modified in-place during the HTML
> -# "conversion" process. Setting the environment variable "HTML_GEN_DEBUG" to "true"
> -# will enable some output from the script, which may be useful if you encounter
> -# issues with this script's processing of an input file.
> -# The number of Changesets to process into the ChangeLog can be set by setting the
> -# environment variable HTML_GEN_CHANGESETS, or by passing an integer argument to
> -# the script. The parameter will take priority over the environment variable.
> +# The only configuration option is the number of Changesets, and the files
> +# processed are hardcoded. To run the script manually, change to this script's
> +# directory, where also the files AUTHORS, NEWS, ChangeLog, and COPYING are
> +# located.
> +# Note that these files WILL be modified in-place during the HTML "conversion"
> +# process. Setting the environment variable "HTML_GEN_DEBUG" to "true" will
> +# enable some output from the script, which may be useful if you encounter
> +# issues with this script's processing of an input file. The number of
> +# Changesets to process into the ChangeLog can be set by setting the environment
> +# variable HTML_GEN_CHANGESETS, or by passing an integer argument to the script.
> +# The parameter will take priority over the environment variable.
>
>   print_debug() {
>       if [ "$HTML_GEN_DEBUG" ]; then echo "$1"; fi
> @@ -71,7 +72,13 @@
>
>   start_time="$(date +%s.%N)"
>
> -cd html-gen
> +# Directory where generated HTML files are put out
> +HTML_GEN_DIR="html-gen"
> +if [ ! -d "$HTML_GEN_DIR" ]; then
> +    mkdir -p "$HTML_GEN_DIR"
Maybe die somewhere here if creation fails?

> +fi
> +cp -pf AUTHORS COPYING ChangeLog NEWS "$HTML_GEN_DIR"
And same here, if source files (Authors, News...) do not exists>

> +cd "$HTML_GEN_DIR"
>
>   print_debug "Generating HTML content for javaws -about for $REPO_URL. $CHANGESETS changesets, $NEWS_ITEMS news items"
>   print_debug "Starting sed substitutions"
>

Thank you!

J.