Document output format

kgryte · kgryte · commit c6fca87a7a24 · 2016-10-21T02:40:50.000-07:00
diff --git a/tools/git/scripts/additions_per_day b/tools/git/scripts/additions_per_day
@@ -1,6 +1,8 @@
 #!/usr/bin/env bash
 #
 # Prints the number of additions per day.
+#
+# <month> <day> <year> <additions>
 
 # Determine root directory:
 root="$(git rev-parse --show-toplevel)"
diff --git a/tools/git/scripts/additions_per_hour b/tools/git/scripts/additions_per_hour
@@ -1,6 +1,8 @@
 #!/usr/bin/env bash
 #
 # Prints the number of additions per hour.
+#
+# <hour> <additions>
 
 # Determine root directory:
 root="$(git rev-parse --show-toplevel)"
diff --git a/tools/git/scripts/additions_per_month b/tools/git/scripts/additions_per_month
@@ -1,6 +1,8 @@
 #!/usr/bin/env bash
 #
 # Prints the number of additions per month.
+#
+# <month> <year> <additions>
 
 # Determine root directory:
 root="$(git rev-parse --show-toplevel)"
diff --git a/tools/git/scripts/additions_per_weekday b/tools/git/scripts/additions_per_weekday
@@ -1,6 +1,8 @@
 #!/usr/bin/env bash
 #
 # Prints the number of additions per weekday.
+#
+# <weekday> <additions>
 
 # Determine root directory:
 root="$(git rev-parse --show-toplevel)"
diff --git a/tools/git/scripts/author_additions_per_day b/tools/git/scripts/author_additions_per_day
@@ -1,6 +1,8 @@
 #!/usr/bin/env bash
 #
 # Prints the number of additions per day per author.
+#
+# <month> <day> <year> <author_first_name> <author_last_name> <additions>
 
 # Determine root directory:
 root="$(git rev-parse --show-toplevel)"
diff --git a/tools/git/scripts/author_additions_per_month b/tools/git/scripts/author_additions_per_month
@@ -1,6 +1,8 @@
 #!/usr/bin/env bash
 #
 # Prints the number of additions per month per author.
+#
+# <month> <year> <author_first_name> <author_last_name> <additions>
 
 # Determine root directory:
 root="$(git rev-parse --show-toplevel)"
diff --git a/tools/git/scripts/author_additions_per_weekday b/tools/git/scripts/author_additions_per_weekday
@@ -1,6 +1,8 @@
 #!/usr/bin/env bash
 #
 # Prints the number of additions per weekday per author.
+#
+# <weekday> <author_first_name> <author_last_name> <additions>
 
 # Determine root directory:
 root="$(git rev-parse --show-toplevel)"
diff --git a/tools/git/scripts/author_commits_per_day b/tools/git/scripts/author_commits_per_day
@@ -1,6 +1,8 @@
 #!/usr/bin/env bash
 #
 # Prints the number of commits per day per author.
+#
+# <month> <day> <year> <author_first_name> <author_last_name> <number_of_commits>
 
 # Determine root directory:
 root="$(git rev-parse --show-toplevel)"
diff --git a/tools/git/scripts/author_commits_per_hour b/tools/git/scripts/author_commits_per_hour
@@ -1,6 +1,8 @@
 #!/usr/bin/env bash
 #
 # Prints the number of commits per hour per author.
+#
+# <hour> <author_first_name> <author_last_name> <number_of_commits>
 
 # Determine root directory:
 root="$(git rev-parse --show-toplevel)"
diff --git a/tools/git/scripts/author_commits_per_month b/tools/git/scripts/author_commits_per_month
@@ -1,6 +1,8 @@
 #!/usr/bin/env bash
 #
 # Prints the number of commits per month per author.
+#
+# <month> <year> <author_first_name> <author_last_name> <number_of_commits>
 
 # Determine root directory:
 root="$(git rev-parse --show-toplevel)"
diff --git a/tools/git/scripts/author_commits_per_weekday b/tools/git/scripts/author_commits_per_weekday
@@ -1,6 +1,8 @@
 #!/usr/bin/env bash
 #
 # Prints the number of commits per weekday per author.
+#
+# <weekday> <author_first_name> <author_last_name> <number_of_commits>
 
 # Determine root directory:
 root="$(git rev-parse --show-toplevel)"
diff --git a/tools/git/scripts/author_deletions_per_day b/tools/git/scripts/author_deletions_per_day
@@ -1,6 +1,8 @@
 #!/usr/bin/env bash
 #
-# Prints the number of deletions per day per author.
+# Prints the number of deletions per day per author
+#
+# <month> <day> <year> <author_first_name> <author_last_name> <deletions>.
 
 # Determine root directory:
 root="$(git rev-parse --show-toplevel)"
diff --git a/tools/git/scripts/author_deletions_per_month b/tools/git/scripts/author_deletions_per_month
@@ -1,6 +1,8 @@
 #!/usr/bin/env bash
 #
 # Prints the number of deletions per month per author.
+#
+# <month> <year> <author_first_name> <author_last_name> <deletions>
 
 # Determine root directory:
 root="$(git rev-parse --show-toplevel)"
diff --git a/tools/git/scripts/author_deletions_per_weekday b/tools/git/scripts/author_deletions_per_weekday
@@ -1,6 +1,8 @@
 #!/usr/bin/env bash
 #
 # Prints the number of deletions per weekday per author.
+#
+# <weekday> <author_first_name> <author_last_name> <deletions>
 
 # Determine root directory:
 root="$(git rev-parse --show-toplevel)"
diff --git a/tools/git/scripts/author_files_changed_per_day b/tools/git/scripts/author_files_changed_per_day
@@ -1,6 +1,8 @@
 #!/usr/bin/env bash
 #
 # Prints the number of files changed per day per author.
+#
+# <month> <day> <year> <author_first_name> <author_last_name> <files_changed>
 
 # Determine root directory:
 root="$(git rev-parse --show-toplevel)"
diff --git a/tools/git/scripts/author_files_changed_per_month b/tools/git/scripts/author_files_changed_per_month
@@ -1,6 +1,8 @@
 #!/usr/bin/env bash
 #
 # Prints the number of files changed per month per author.
+#
+# <month> <year> <author_first_name> <author_last_name> <files_changed>
 
 # Determine root directory:
 root="$(git rev-parse --show-toplevel)"
diff --git a/tools/git/scripts/author_files_changed_per_weekday b/tools/git/scripts/author_files_changed_per_weekday
@@ -1,6 +1,8 @@
 #!/usr/bin/env bash
 #
 # Prints the number of files changed per weekday per author.
+#
+# <weekday> <author_first_name> <author_last_name> <files_changed>
 
 # Determine root directory:
 root="$(git rev-parse --show-toplevel)"
diff --git a/tools/git/scripts/author_mean_shortstats b/tools/git/scripts/author_mean_shortstats
@@ -1,6 +1,8 @@
 #!/usr/bin/env bash
 #
 # Prints summary statistic averages per author.
+#
+# <author_first_name> <author_last_name> <avg_commits> <avg_files_changed> <avg_additions> <avg_deletions>
 
 # Determine root directory:
 root="$(git rev-parse --show-toplevel)"
diff --git a/tools/git/scripts/author_shortstats_per_day b/tools/git/scripts/author_shortstats_per_day
@@ -1,6 +1,8 @@
 #!/usr/bin/env bash
 #
 # Prints the summary statistics per day per author.
+#
+# <month> <day> <year> <author_first_name> <author_last_name> <num_commits> <files_changed> <additions> <deletions>
 
 # Determine root directory:
 root="$(git rev-parse --show-toplevel)"
diff --git a/tools/git/scripts/author_shortstats_per_month b/tools/git/scripts/author_shortstats_per_month
@@ -1,6 +1,8 @@
 #!/usr/bin/env bash
 #
 # Prints the summary statistics per month per author.
+#
+# <month> <year> <author_first_name> <author_last_name> <num_commits> <files_changed> <additions> <deletions>
 
 # Determine root directory:
 root="$(git rev-parse --show-toplevel)"
@@ -32,4 +34,4 @@ END {
 		print keys[1] OFS keys[2] OFS keys[3] OFS commits[k] OFS files[k] OFS additions[k] OFS deletions[k]
 	}
 }
-' | sort -k1n -k2M | awk '{print $2 OFS $1 OFS $3 OFS $4 OFS $5 OFS $6 OFS $7 OFS $8 OFS $9}'
+' | sort -k1n -k2M | awk '{print $2 OFS $1 OFS $3 OFS $4 OFS $5 OFS $6 OFS $7 OFS $8}'

Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,8 @@`
`1`	`1`	`#!/usr/bin/env bash`
`2`	`2`	`#`
`3`	`3`	`# Prints the number of additions per day.`
	`4`	`+#`
	`5`	`+# <month> <day> <year> <additions>`
`4`	`6`
`5`	`7`	`# Determine root directory:`
`6`	`8`	`root="$(git rev-parse --show-toplevel)"`
Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,8 @@`
`1`	`1`	`#!/usr/bin/env bash`
`2`	`2`	`#`
`3`	`3`	`# Prints the number of additions per hour.`
	`4`	`+#`
	`5`	`+# <hour> <additions>`
`4`	`6`
`5`	`7`	`# Determine root directory:`
`6`	`8`	`root="$(git rev-parse --show-toplevel)"`
Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,8 @@`
`1`	`1`	`#!/usr/bin/env bash`
`2`	`2`	`#`
`3`	`3`	`# Prints the number of additions per month.`
	`4`	`+#`
	`5`	`+# <month> <year> <additions>`
`4`	`6`
`5`	`7`	`# Determine root directory:`
`6`	`8`	`root="$(git rev-parse --show-toplevel)"`
Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,8 @@`
`1`	`1`	`#!/usr/bin/env bash`
`2`	`2`	`#`
`3`	`3`	`# Prints the number of additions per weekday.`
	`4`	`+#`
	`5`	`+# <weekday> <additions>`
`4`	`6`
`5`	`7`	`# Determine root directory:`
`6`	`8`	`root="$(git rev-parse --show-toplevel)"`
Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,8 @@`
`1`	`1`	`#!/usr/bin/env bash`
`2`	`2`	`#`
`3`	`3`	`# Prints the number of commits per day per author.`
	`4`	`+#`
	`5`	`+# <month> <day> <year> <author_first_name> <author_last_name> <number_of_commits>`
`4`	`6`
`5`	`7`	`# Determine root directory:`
`6`	`8`	`root="$(git rev-parse --show-toplevel)"`
Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,8 @@`
`1`	`1`	`#!/usr/bin/env bash`
`2`	`2`	`#`
`3`	`3`	`# Prints the number of commits per hour per author.`
	`4`	`+#`
	`5`	`+# <hour> <author_first_name> <author_last_name> <number_of_commits>`
`4`	`6`
`5`	`7`	`# Determine root directory:`
`6`	`8`	`root="$(git rev-parse --show-toplevel)"`
Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,8 @@`
`1`	`1`	`#!/usr/bin/env bash`
`2`	`2`	`#`
`3`	`3`	`# Prints the number of commits per month per author.`
	`4`	`+#`
	`5`	`+# <month> <year> <author_first_name> <author_last_name> <number_of_commits>`
`4`	`6`
`5`	`7`	`# Determine root directory:`
`6`	`8`	`root="$(git rev-parse --show-toplevel)"`