Closed GoogleCodeExporter closed 8 years ago
I've added better copyright and license bits.
Please don't mix two different changes together.
Your indent changes made it hard to read your copyright/license changes.
(Also, you mentioned GPL in two places rather than LGPL.)
Original comment by daniel.r...@gmail.com
on 5 Mar 2011 at 3:37
A look at SVN 224:
1) The order or sections is typically: COPYRIGHT, LICENSE and DESCRIPTION. See
at the bottom for suggestion.
2) Line "Copyright (C) 2007-2011 Dan Kegel <dank@kegel.com> et al"
The "et all" may be problematic. If mentioned, the Copyright holders should be
listed in the code, See FSF guidelines
http://www.gnu.org/prep/maintain/html_node/Copyright-Notices.html "...But if
contributors are not all assigning their copyrights to a single copyright
holder, it can easily happen that one file has several copyright holders. Each
contributor of nontrivial text is a copyright holder."
2) There are no paragraph breaks in "License". See
http://www.gnu.org/copyleft/gpl-howto.html for format.
> Your indent changes made it hard to read your copyright/license changes.
> (Also, you mentioned GPL in two places rather than LGPL.)
As mentioned, that followed the "white paper" layout suitable for sections
COPYRIGHT, LICENSE ... See below (if the patch were applied):
#!/bin/sh
#
# Copyright
#
# Copyright (C) 2010-2011 Dan Kegel <dank@kegel.com>
#
# License
#
# This program is free software; you can redistribute it and/or
# modify it under the terms of the GNU Lesser General Public
# License as published by the Free Software Foundation; either
# version 2 of the License, or (at your option) any later
# version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program. If not, see <http://www.gnu.org/licenses/>.
#
# Description
#
# A POSIX shell scropt to install help installing various WINE applications
# easily. See homepage <http://code.google.com/p/winetricks>.
#
# See also http://code.google.com/p/winezeug/wiki/ConvergedFrontends
#
# Compatibility and Standards
#
# This script, and the verbs it invokes, should follow these
# Coding standards:
#
# PORTABILITY
#
# - Portability matters, as this script is run on many operating systems
# - No bash, zsh, or csh extensions; only use features from
# the Posix standard shell and utilities; see
#
http://pubs.opengroup.org/onlinepubs/009695399/utilities/xcu_chap02.html
# - Prefer classic sh idioms as described in e.g.
# "Portable Shell Programming" by Bruce Blinn, ISBN: 0-13-451494-7
# - If there is no universally available program for a needed function,
# support the two most frequently available programs.
# e.g. fall back to wget if curl is not available; likewise, support
# both sha1sum and openssl.
# - When using unix commands like cp, put options before filenames so it
will
# work on systems like MacOSX. e.g. "rm -f foo.dat", not "rm foo.dat
-f"
#
# FORMATTING
#
# - Your terminal and editor must be configured for utf-8
# If you do not see an o with two dots over it here [ö], stop!
# - Do not use tabs in this file or any verbs.
# - Indent 4 spaces.
# - Try to keep line length below 80 (makes printing easier)
# - Open curly braces ('{') and 'then' at beginning of line,
# close curlies ('}') and 'fi' should line up with the matching { or if,
# cases aligned with 'case' and 'esac'. For instance,
#
# if test "$FOO" = "bar"
# then
# echo "FOO is bar"
# fi
# case "$FOO" of
# bar) echo "FOO is still bar" ;;
# esac
#
# COMMENTING
#
# - Comments should explain intent in English
# - Keep functions short and well named to reduce need for comments
#
# NAMING
#
# Public things defined by this script, for use by verbs:
# - Variables have uppercase names starting with W_
# - Functions have lowercase names starting with w_
#
# PRIVATE THINGS INTERNAL TO THIS SCRIPT, NOT FOR USE BY VERBS
#
# - Local variables have lowercase names starting with uppercase _W_
# - Global variables have uppercase names starting with WINETRICKS_
# - Functions have lowercase names starting with winetricks_
# - FIXME: A few verbs still use winetricks-private functions or
variables.
#
# INTERNATIONALIZATION / LOCALIZATION
#
# - Important or frequently used message should be internationalized
# so translations can be easily added. For example:
#
# case $LANG in
# de*) echo "Das ist die deutsche Meldung" ;;
# *) echo "This is the English message" ;;
# esac
Original comment by jari.aalto.fi@gmail.com
on 5 Mar 2011 at 3:59
Original issue reported on code.google.com by
jari.aalto.fi@gmail.com
on 4 Mar 2011 at 9:25Attachments: