commit 59d3cb4307b26c063dcdb86b8d42f59e78adaacb
author Stewart Smith <stewart@linux.vnet.ibm.com> Mon Feb 12 11:52:12 2018 +1100
committer Stewart Smith <stewart@linux.vnet.ibm.com> Mon Feb 26 14:30:46 2018 +1100
tree c4fdc6fcc65c1432686f50619b3e9151075b55d5
parent 2e9a07f5568ebedd3ece63f58ed1d5249638b5b9

doc: initial sphinx-based documentation support

The release-notes script now produces Markdown compatible with
pandoc to help convert it into RST for sphinx.

Actual documentation is fairly limited currently.

We use intersphinx to link to various sub-projects' docs.

A .travis.yml file is added to build+publish documentation
when new code is pushed to github.

Signed-off-by: Stewart Smith <stewart@linux.vnet.ibm.com>

openpower/scripts/release-notes

diff --git a/openpower/scripts/release-notes b/openpower/scripts/release-notes
index 33974d5..56a9ffb 100755
--- a/openpower/scripts/release-notes
+++ b/openpower/scripts/release-notes
@@ -114,11 +114,11 @@
     my $sth = $dbh->prepare($q) or die $!;
     $sth->execute($begin_release, $end_release);
     my $r;
-    print OUTPUT "## Removed platforms\n\n- ".$r->{p}."\n" if $r = $sth->fetchrow_hashref;
+    print OUTPUT "\n## Removed platforms\n\n- ".$r->{p}."\n" if $r = $sth->fetchrow_hashref;
     print OUTPUT "- ".$r->{p}."\n" while ($r = $sth->fetchrow_hashref);
 
     $sth->execute($end_release, $begin_release);
-    print OUTPUT "## New platforms\n\n- ".$r->{p}."\n" if $r = $sth->fetchrow_hashref;
+    print OUTPUT "\n## New platforms\n\n- ".$r->{p}."\n" if $r = $sth->fetchrow_hashref;
     print OUTPUT "- ".$r->{p}."\n" while($r = $sth->fetchrow_hashref);
 }
 
@@ -222,7 +222,7 @@
 {
     my $q = <<'SQL';
 select package as pk ,oldversion as o ,newversion as n, 
-	GROUP_CONCAT(platform) as ps
+	GROUP_CONCAT(platform,', ') as ps
 FROM package_upgrades 
 	GROUP BY package,oldversion,newversion
 ORDER BY package,platform
@@ -230,11 +230,17 @@
     my $sth = $dbh->prepare($q) or die $!;
     $sth->execute();
 
-    print OUTPUT "## Updated Packages\n\n";
+    print OUTPUT "\n## Updated Packages\n\n";
     print OUTPUT "Package | Old Version | New Version | Platforms\n";
-    print OUTPUT "--- | --- | --- | ---\n";
+    my $t;
+    my ($plen,$olen,$nlen,$platlen) = (3,3,3,3);
     while (my $r = $sth->fetchrow_hashref) {
-	print OUTPUT join(' | ',($r->{pk}, $r->{o}, $r->{n}, $r->{ps}))."\n" ;
+	$t.= join(' | ',($r->{pk}, $r->{o}, $r->{n}, $r->{ps}))."\n" ;
+	$plen = length($r->{pk}) if $plen < length($r->{pk});
+	$olen = length($r->{o}) if $olen < length($r->{o});
+	$nlen = length($r->{n}) if $nlen < length($r->{n});
+	$platlen = length($r->{ps}) if $platlen < length($r->{ps});
+
 	if ($r->{pk} eq 'machine-xml') {
 	    $old_level->{$r->{ps}."-xml"} = $r->{o};
 	    $new_level->{$r->{ps}."-xml"} = $r->{n};
@@ -243,6 +249,9 @@
 	    $new_level->{$r->{pk}} = $r->{n};
 	}
     }
+    print OUTPUT "-"x$plen." | "."-"x$olen." | "."-"x$nlen." | ".
+	"-"x$platlen."\n";
+    print OUTPUT $t;
 }
 
 {
@@ -314,7 +323,7 @@
     my $url = $repos->{$repo}->{REPO};
     my $dir = $repos->{$repo}->{DIR};
 
-    print OUTPUT "## Package: $repo\n";
+    print OUTPUT "\n## Package: $repo\n";
     print OUTPUT "[Repository]($url)\n";
     print OUTPUT "\n";
 
@@ -344,7 +353,7 @@
     {
         # No change identified.
         print "No changes: $repo\n";
-        print OUTPUT "No changes.\n";
+        print OUTPUT "No changes.\n\n";
         next;
     }
 
@@ -354,12 +363,13 @@
         print "Changes in $repo...\n";
         open(GITLOG, "cd $repo; git shortlog $old_level->{$package}...".
                      "$new_level->{$package} --no-merges --format=".
-                     "\"* [%h]($url/commit/%h) %s\" |");
+                     "\"- [%h]($url/commit/%h) %s\" |");
 
         while (my $logline = <GITLOG>)
         {
             chomp $logline;
             $logline =~ s/^[[:space:]]*//;
+            $logline =~ s/:$/:\n/;
             print OUTPUT "$logline\n";
         }
         close GITLOG;