From b22452767d33a017352b2423656bf4ddb0ff4b9b Mon Sep 17 00:00:00 2001 From: Luke Shumaker Date: Tue, 25 Nov 2014 23:08:35 -0500 Subject: more meta-documentation cleanup --- COPYING | 9 +++++++++ HACKING.md | 16 ++++++++++++++-- 2 files changed, 23 insertions(+), 2 deletions(-) create mode 100644 COPYING diff --git a/COPYING b/COPYING new file mode 100644 index 0000000..def2dff --- /dev/null +++ b/COPYING @@ -0,0 +1,9 @@ +Different parts of libretools are either the GNU General Public +License version 2 or 3; sometimes with, sometimes without the option +to use a later version of the license. Which one is specified on a +per-file basis; look at the source. In addition to a full copyright +and license statement, each file contains a "License:" line to make +searching easy. + +Full copies of the GNU General Public License versions 2 and 3 are +included as `COPYING-GPLv2` and `COPYING-GPLv3`, respectively. \ No newline at end of file diff --git a/HACKING.md b/HACKING.md index 6682538..f22752e 100644 --- a/HACKING.md +++ b/HACKING.md @@ -102,7 +102,7 @@ use-case for it). In the shebang, don't pass flags to bash, besides breaking `env` (above), it means people will make mistakes when debugging, and -running things with `bash FILENAME`. Instead, use `set` to adjust the +running things with `bash FILENAME`. Instead, use `set` to adjust the flags inside of the program. Obey `$TMPDIR`. It's usually as easy as passing `--tmpdir` to @@ -212,7 +212,7 @@ the better option, as otherwise you would have to use `seq` (calling an external), or `eval` (gross, easy to mess up royally). Indent comments like you would code; don't leave them at the beginning -of the line. Example: +of the line. Example: for item in "${list[@]}"; do if [[ $item == foo ]]; then @@ -234,3 +234,15 @@ doesn't have to go on the right side of a command: cat file | program # useless use of cat program < file # data flows right to left < file program # just right + +Copyright statements should look like + + # Copyright (C) YEARS NAME + +for most code, for 3rd-party code that has been imported, indent it a +bit: + + # Copyright (C) YEARS NAME + +Always put a line with `# License:` specifying the license of that +file. -- cgit v1.2.3-54-g00ecf