pgBackRest 1.2 commit log

v1.02: Bug Fix for Perl 5.22

commit   : bfaee7380d6aa0a4a4573df2a6a28581537d169b    
  
author   : David Steele <[email protected]>    
date     : Thu, 2 Jun 2016 11:10:24 -0400    
  
committer: David Steele <[email protected]>    
date     : Thu, 2 Jun 2016 11:10:24 -0400    

Click here for diff

* Fix usage of sprintf() due to new constraints in Perl 5.22. Parameters not referenced in the format string are no longer allowed. (Fixed by Adrian Vondendriesch.)  

M README.md
A doc/resource/exe.cache
M doc/xml/release.xml
M lib/pgBackRest/Version.pm

Added execution cache for document generation.

commit   : eaa981c5aae6b3d8a04fd2d518f180be0921ba4c    
  
author   : David Steele <[email protected]>    
date     : Thu, 2 Jun 2016 09:32:56 -0400    
  
committer: David Steele <[email protected]>    
date     : Thu, 2 Jun 2016 09:32:56 -0400    

Click here for diff

Added an execution cache so that documentation can be generated without setting up the full container environment. This is useful for packaging, keeps the documentation consistent for a release, and speeds up generation when no changes are made in the execution list.  

M README.md
M doc/doc.pl
M doc/lib/BackRestDoc/Common/DocExecute.pm
M doc/lib/BackRestDoc/Common/DocManifest.pm
M doc/lib/BackRestDoc/Common/DocRender.pm
M doc/lib/BackRestDoc/Custom/DocCustomRelease.pm
M doc/lib/BackRestDoc/Html/DocHtmlSite.pm
M doc/lib/BackRestDoc/Latex/DocLatex.pm
M doc/lib/BackRestDoc/Latex/DocLatexSection.pm
M doc/manifest.xml
M doc/xml/index.xml
M doc/xml/release.xml
M doc/xml/user-guide.xml
M test/lib/pgBackRestTest/Docker/ContainerTest.pm
M test/test.pl

Added a man page to document generation.

commit   : df6086bd24ce9d9322e5c048e5337719e9a43a0a    
  
author   : David Steele <[email protected]>    
date     : Thu, 2 Jun 2016 09:25:12 -0400    
  
committer: David Steele <[email protected]>    
date     : Thu, 2 Jun 2016 09:25:12 -0400    

Click here for diff

M doc/doc.pl
M doc/lib/BackRestDoc/Common/DocConfig.pm
M doc/xml/index.xml
M doc/xml/reference.xml
M doc/xml/release.xml
M lib/pgBackRest/Config/ConfigHelpData.pm

Some word smithing in the introduction.

commit   : 9a9f26a96f0365b0223231f74426602edb5caad9    
  
author   : David Steele <[email protected]>    
date     : Fri, 27 May 2016 18:36:25 -0400    
  
committer: David Steele <[email protected]>    
date     : Fri, 27 May 2016 18:36:25 -0400    

Click here for diff

M doc/xml/user-guide.xml

Replaced overzealous perl -cW check.

commit   : 174b16165b2cd555fd63a6516520900089d643ab    
  
author   : David Steele <[email protected]>    
date     : Thu, 26 May 2016 16:57:35 -0400    
  
committer: David Steele <[email protected]>    
date     : Thu, 26 May 2016 16:57:35 -0400    

Click here for diff

It failed on Perl 5.22 so replaced with with perl -cw.  

M doc/xml/release.xml
M test/test.pl

Improve log directory/file creation.

commit   : 379ab1b3533c525d87b2dacd34ac7d3a9796305e    
  
author   : David Steele <[email protected]>    
date     : Thu, 26 May 2016 15:04:18 -0400    
  
committer: David Steele <[email protected]>    
date     : Thu, 26 May 2016 15:04:18 -0400    

Click here for diff

Log directory create and file open now using FileCommon functions which produce more detailed error messages on failure.  

M doc/xml/release.xml
M lib/pgBackRest/Common/Log.pm
M lib/pgBackRest/FileCommon.pm
M lib/pgBackRest/RestoreFile.pm

Add notes for Ubuntu 16.04 upgrade.

commit   : e4e885d602781afd42f78c74378af2e78e0a4d27    
  
author   : David Steele <[email protected]>    
date     : Thu, 26 May 2016 14:22:26 -0400    
  
committer: David Steele <[email protected]>    
date     : Thu, 26 May 2016 14:22:26 -0400    

Click here for diff

M doc/xml/release.xml

Fixed absolute paths that were used for the PDF logo.

commit   : cf344c144f6c12cca2950429ce61ae075f69d902    
  
author   : David Steele <[email protected]>    
date     : Thu, 26 May 2016 14:17:50 -0400    
  
committer: David Steele <[email protected]>    
date     : Thu, 26 May 2016 14:17:50 -0400    

Click here for diff

M doc/lib/BackRestDoc/Common/DocManifest.pm
M doc/lib/BackRestDoc/Latex/DocLatex.pm
M doc/manifest.xml
M doc/xml/release.xml

Fixed syntax in doc code that was not compatible with Perl 5.2X.

commit   : b19143b6eaf0a04f921c791a7e62e2aa4f367547    
  
author   : Adrian Vondendriesch <[email protected]>    
date     : Thu, 26 May 2016 14:07:29 -0400    
  
committer: David Steele <[email protected]>    
date     : Thu, 26 May 2016 14:07:29 -0400    

Click here for diff

M doc/lib/BackRestDoc/Custom/DocCustomRelease.pm
M doc/xml/release.xml

Upgrade doc/test VM to Ubuntu 16.04.

commit   : 28f1c927e715b55aa4b5dcba936a6f6c03d46ed5    
  
author   : David Steele <[email protected]>    
date     : Thu, 26 May 2016 14:03:32 -0400    
  
committer: David Steele <[email protected]>    
date     : Thu, 26 May 2016 14:03:32 -0400    

Click here for diff

* This will help catch Perl errors in the doc code since it is not run across multiple OSs like the core and test code.  
* It is to be hoped that a newer kernel will make Docker more stable.  

M .gitignore
M test/Vagrantfile

Fix usage of sprintf() for Perl 5.22.

commit   : 3d437d9278488d25b30da828a173042774c0e009    
  
author   : Adrian Vondendriesch <[email protected]>    
date     : Thu, 26 May 2016 11:23:52 -0400    
  
committer: David Steele <[email protected]>    
date     : Thu, 26 May 2016 11:23:52 -0400    

Click here for diff

Parameters not referenced in the format string are no longer allowed.  

M doc/xml/release.xml
M lib/pgBackRest/Common/String.pm

Next development cycle.

commit   : b1c779e606bf6d7e1a30c338694ae628fbac853b    
  
author   : David Steele <[email protected]>    
date     : Thu, 26 May 2016 11:04:19 -0400    
  
committer: David Steele <[email protected]>    
date     : Thu, 26 May 2016 11:04:19 -0400    

Click here for diff

M lib/pgBackRest/Version.pm

Fixed release version test when the current version is development.

commit   : bfec2d2f89a0e746d145bd896b8f9c4ba02dde9d    
  
author   : David Steele <[email protected]>    
date     : Thu, 26 May 2016 11:03:10 -0400    
  
committer: David Steele <[email protected]>    
date     : Thu, 26 May 2016 11:03:10 -0400    

Click here for diff

M test/test.pl

More detailed release notes.

commit   : c8d68bcf2d33b206634d0d537ef6d4bfb84229ba    
  
author   : David Steele <[email protected]>    
date     : Thu, 26 May 2016 10:34:10 -0400    
  
committer: David Steele <[email protected]>    
date     : Thu, 26 May 2016 10:34:10 -0400    

Click here for diff

Release notes are now broken into sections so that bugs, features, and refactors are clearly delineated.  An "Additional Notes" section has been added for changes to documentation and the test suite that do not affect the core code.  

M README.md
M doc/lib/BackRestDoc/Common/DocExecute.pm
M doc/lib/BackRestDoc/Common/DocRender.pm
M doc/lib/BackRestDoc/Custom/DocCustomRelease.pm
M doc/lib/BackRestDoc/Html/DocHtmlPage.pm
M doc/resource/html/default.css
M doc/xml/dtd/doc.dtd
M doc/xml/index.xml
M doc/xml/release.xml
M test/test.pl

Lists can now be used outside of p and text tags.

commit   : 0fb8bcbfb7107b83c345dac1858aab02eeeb4302    
  
author   : David Steele <[email protected]>    
date     : Thu, 26 May 2016 09:34:03 -0400    
  
committer: David Steele <[email protected]>    
date     : Thu, 26 May 2016 09:34:03 -0400    

Click here for diff

This allows for more flexible document structuring.  

M doc/lib/BackRestDoc/Common/Doc.pm
M doc/lib/BackRestDoc/Common/DocConfig.pm
M doc/lib/BackRestDoc/Html/DocHtmlElement.pm
M doc/lib/BackRestDoc/Html/DocHtmlPage.pm
M doc/lib/BackRestDoc/Markdown/DocMarkdownRender.pm
M doc/resource/html/default.css
M doc/xml/backlog.xml
M doc/xml/dtd/doc.dtd
M doc/xml/index.xml

Moved change log to website.

commit   : 5a85122841ff38bea5b7b3d02a5d8ace40a4e81f    
  
author   : Cynthia Shang <[email protected]>    
date     : Thu, 26 May 2016 09:20:55 -0400    
  
committer: David Steele <[email protected]>    
date     : Thu, 26 May 2016 09:20:55 -0400    

Click here for diff

The change log was the last piece of documentation to be rendered in Markdown only.  Wrote a converter so the document can be output by the standard renderers.  The change log will now be located on the website and has been renamed to "Releases".  

D CHANGELOG.md
M README.md
M doc/doc.pl
M doc/lib/BackRestDoc/Common/Doc.pm
M doc/lib/BackRestDoc/Common/DocExecute.pm
M doc/lib/BackRestDoc/Common/DocRender.pm
A doc/lib/BackRestDoc/Custom/DocCustomRelease.pm
M doc/lib/BackRestDoc/Html/DocHtmlPage.pm
M doc/manifest.xml
M doc/resource/html/default.css
M doc/xml/dtd/doc.dtd
M doc/xml/index.xml
R091 doc/xml/change-log.xml doc/xml/release.xml
M test/test.pl

Remove function constants and pass strings directly to logDebugParam().

commit   : e2094c3d312a69544cd144e4758508c7966075b8    
  
author   : David Steele <[email protected]>    
date     : Thu, 26 May 2016 09:09:42 -0400    
  
committer: David Steele <[email protected]>    
date     : Thu, 26 May 2016 09:09:42 -0400    

Click here for diff

The function names were only used once so creating constants for them was wasteful.  

M doc/lib/BackRestDoc/Common/Doc.pm
M doc/lib/BackRestDoc/Common/DocConfig.pm
M doc/lib/BackRestDoc/Common/DocExecute.pm
M doc/lib/BackRestDoc/Common/DocManifest.pm
M doc/lib/BackRestDoc/Common/DocRender.pm
M doc/lib/BackRestDoc/Html/DocHtmlBuilder.pm
M doc/lib/BackRestDoc/Html/DocHtmlElement.pm
M doc/lib/BackRestDoc/Html/DocHtmlPage.pm
M doc/lib/BackRestDoc/Html/DocHtmlSite.pm
M doc/lib/BackRestDoc/Latex/DocLatex.pm
M doc/lib/BackRestDoc/Latex/DocLatexSection.pm
M doc/lib/BackRestDoc/Markdown/DocMarkdown.pm
M doc/lib/BackRestDoc/Markdown/DocMarkdownRender.pm

Added Ubuntu 16.04 and Debian 8 to regression tests.

commit   : e7d4a25d6a5613b89e3186517f6d4888b3ed9faa    
  
author   : David Steele <[email protected]>    
date     : Tue, 24 May 2016 08:17:13 -0400    
  
committer: David Steele <[email protected]>    
date     : Tue, 24 May 2016 08:17:13 -0400    

Click here for diff

Also added some new fields to make container generation simpler for distros that share a common package base.  

M test/lib/pgBackRestTest/Common/VmTest.pm
M test/lib/pgBackRestTest/Docker/ContainerTest.pm
M test/test.pl

Moved version checking code so it doesn't run in containers.

commit   : f2a14a06e5a3b9b702cdbcf5f7cfdfb0acfa6e51    
  
author   : David Steele <[email protected]>    
date     : Mon, 23 May 2016 20:04:36 -0400    
  
committer: David Steele <[email protected]>    
date     : Mon, 23 May 2016 20:04:36 -0400    

Click here for diff

The required modules were not loaded so errors were occurring during regression tests.  

M test/test.pl

Test release version using change-log.xml instead of CHANGELOG.md.

commit   : c604b6e657a0ff195d291d6b7f972ef02f508011    
  
author   : David Steele <[email protected]>    
date     : Mon, 23 May 2016 19:33:02 -0400    
  
committer: David Steele <[email protected]>    
date     : Mon, 23 May 2016 19:33:02 -0400    

Click here for diff

This is in preparation for moving the change log to the website and removing it from Github.  

M doc/doc.pl
M doc/lib/BackRestDoc/Common/Doc.pm
M test/test.pl

Initialize local variable variable immediately, per Perl Critic.

commit   : 3af48f1d7818287d9e4443748becc63b86958ab7    
  
author   : David Steele <[email protected]>    
date     : Fri, 20 May 2016 11:18:51 -0400    
  
committer: David Steele <[email protected]>    
date     : Fri, 20 May 2016 11:18:51 -0400    

Click here for diff

M doc/lib/BackRestDoc/Common/Doc.pm

Closed #195: Added type from source node in manifest.xml.

commit   : c9632e987437031d40765019bd6ee279cb101197    
  
author   : Cynthia Shang <[email protected]>    
date     : Thu, 19 May 2016 17:10:34 -0400    
  
committer: David Steele <[email protected]>    
date     : Thu, 19 May 2016 17:10:34 -0400    

Click here for diff

This parameter `allows the doc code to determine if special handling is needed for the xml document.  

M doc/lib/BackRestDoc/Common/Doc.pm
M doc/lib/BackRestDoc/Common/DocManifest.pm
M doc/lib/BackRestDoc/Common/DocRender.pm

Closed #193: Fix perl warnings in doc/ tree.

commit   : 3a309256fa9547f8a26fe0563a873a5be1385c2f    
  
author   : Christoph Berg <[email protected]>    
date     : Thu, 19 May 2016 10:25:04 -0400    
  
committer: David Steele <[email protected]>    
date     : Thu, 19 May 2016 10:25:04 -0400    

Click here for diff

Somewhere between perl 5.14 and 5.20, constructs like this:  
    perl -e '$a = {}; keys $a'  
started to throw warnings:  
    keys on reference is experimental at -e line 1.  
  
Fix by adding a bunch of %{} and @{} casts.  

M doc/lib/BackRestDoc/Common/Doc.pm
M doc/lib/BackRestDoc/Common/DocConfig.pm
M doc/lib/BackRestDoc/Common/DocExecute.pm
M doc/lib/BackRestDoc/Common/DocManifest.pm
M doc/lib/BackRestDoc/Common/DocRender.pm