{"push_id":909028783,"size":3,"distinct_size":3,"ref":"refs/heads/2.11.x","head":"6792b57152e70fd818db84829c0fb3d8e3899c26","before":"cc90f7744d8f24404cf745def5ace6c41c618746","commits":[{"sha":"ceebe88cb73ce252e68d7d379fa5c90e15831753","author":{"email":"16a62443a5028415d77ae4907f0bac481d0a7ace@gmail.com","name":"Janek Bogucki"},"message":"Script to compare the current scaladoc with the parent commit's doc","distinct":true,"url":"https://api.github.com/repos/scala/scala/commits/ceebe88cb73ce252e68d7d379fa5c90e15831753"},{"sha":"006c0a4a343749f9a6a591e5cdec925effe1103a","author":{"email":"16a62443a5028415d77ae4907f0bac481d0a7ace@gmail.com","name":"Janek Bogucki"},"message":"Enhance scaladoc-diff tool for Ubuntu.\n\nTested on Ubuntu 14.04.3 LTS.\n\nSUMMARY\n\n   1. Use `set -e` to ensure ant failure bails script.\n   2. Make best effort to display scaladoc build diff.\n   3. Quiet output from git checkout.\n   4. Prefer plumbing over porcelain when getting hashes.\n   5. Use short hashes to enhance output readability.\n   6. Use branch name when available.\n   7. Ensure scaladoc copies are clean.\n   8. Remove redundant use of scaladoc-compare.\n   9. Improve message formatting.\n  10. Use $(...) instead of backticks for more legible code.\n  11. Pause after reporting missing old file.\n  12. Report missing new files.\n\nDETAILS\n\n1. Use `set -e` to ensure an ant failure bails the script. Turn off before\ndiff because diff returns an error code when the compared files differ,\nwhich is expected to be seen.\n\n2. Make best effort to display scaladoc build diff preferring graphical\nclients.\n\nopendiff is a Mac OS X command that opens a graphical diff display, meld\nis a graphical client for Ubuntu and other distros. On Ubuntu fallback to\ngvimdiff which will display graphically if possible otherwise in the\nconsole. Ultimately default to diff.\n\nCommand detection taken from,\n\n  http://stackoverflow.com/questions/592620/check-if-a-program-exists-from-a-bash-script\n\n3. Quiet output from git checkout to avoid detached head warning.\n\nThe user does not need to see the detached head warning when running this.\n\n4. Prefer plumbing over porcelain to avoid 'not found' error when getting\nSHA1s.\n\nCalling get-scala-commit-sha errors out on Ubuntu 14.04.3 with\nBash 4.3.11 with these messages,\n\n    tools/get-scala-commit-sha: 11: tools/get-scala-commit-sha: [[: not found\n    tools/get-scala-commit-sha: 17: tools/get-scala-commit-sha: Bad substitution\n\n5. Use short hashes to enhance output readability.\n\n6. Use branch name when available.\n\nIf the branch name is not used when the working directory is restored\nafter checkout out the parent commit we will be in a detached HEAD\nstate. Make a best effort to avoid that.\n\n7. Ensure scaladoc copies are clean.\n\nRemove previous copy of scaladoc to ensure consistent behaviour on runs\npast the first.\n\n8. Remove use of scaladoc-compare because the equivalent functionality is\nprovided when iterating the new files.\n\n9. Improve message formatting.\n\n10. Use $(...) instead of backticks for more legible code.\n\n11. Pause after reporting missing old file.\n\nWithout this pause it was easy to miss the message when we had this\nsequence of differences,\n\n * differing files\n * missing file\n * differing files\n\n12. Report missing new files.\n\nAlong with reporting new files with no corresponding old file report the\ncomplementary scenario.","distinct":true,"url":"https://api.github.com/repos/scala/scala/commits/006c0a4a343749f9a6a591e5cdec925effe1103a"},{"sha":"6792b57152e70fd818db84829c0fb3d8e3899c26","author":{"email":"25a3b6cc85a8cde49f8b0f9aa21c050bc04072d4@tisue.net","name":"Seth Tisue"},"message":"Merge pull request #4765 from janekdb/2.11.x-scaladoc-diff\n\nScript to compare the current scaladoc with the parent commit's doc","distinct":true,"url":"https://api.github.com/repos/scala/scala/commits/6792b57152e70fd818db84829c0fb3d8e3899c26"}]}