database/pgbackrest
1
0
Fork 0
mirror of https://github.com/pgbackrest/pgbackrest.git synced 2025-12-24 14:18:01 +03:00
Code Activity

Rename BackRestDoc Perl module to pgBackRestDoc.

Browse Source 
This is consistent with the way BackRest and BackRest test were renamed way back in 18fd2523.

More modules will be moving to pgBackRestDoc soon so renaming now reduces churn later.
This commit is contained in:
David Steele
2020-03-10 15:41:56 -04:00
parent 36d4ab9bff
commit 731b862e6f
75 changed files with 287 additions and 287 deletions
Download Patch File Download Diff File Expand all files Collapse all files

95
doc/lib/pgBackRestDoc/Markdown/DocMarkdown.pm Normal file
View File

@@ -0,0 +1,95 @@
####################################################################################################################################
# DOC MARKDOWN MODULE
####################################################################################################################################
package pgBackRestDoc::Markdown::DocMarkdown;
use strict;
use warnings FATAL => qw(all);
use Carp qw(confess);
use Data::Dumper;
use Exporter qw(import);
our @EXPORT = qw();
use File::Basename qw(dirname);
use File::Copy;
use POSIX qw(strftime);
use Storable qw(dclone);
use pgBackRest::Version;
use pgBackRestTest::Common::ExecuteTest;
use pgBackRestDoc::Common::DocConfig;
use pgBackRestDoc::Common::DocManifest;
use pgBackRestDoc::Common::Log;
use pgBackRestDoc::Common::String;
use pgBackRestDoc::Markdown::DocMarkdownRender;
####################################################################################################################################
# CONSTRUCTOR
####################################################################################################################################
sub new
{
my $class = shift; # Class name
# Create the class hash
my $self = {};
bless $self, $class;
$self->{strClass} = $class;
# Assign function parameters, defaults, and log debug info
(
my $strOperation,
$self->{oManifest},
$self->{strXmlPath},
$self->{strMarkdownPath},
$self->{bExe}
) =
logDebugParam
(
__PACKAGE__ . '->new', \@_,
{name => 'oManifest'},
{name => 'strXmlPath'},
{name => 'strMarkdownPath'},
{name => 'bExe'}
);
# Return from function and log return values if any
return logDebugReturn
(
$strOperation,
{name => 'self', value => $self}
);
}
####################################################################################################################################
# process
#
# Generate the site html
####################################################################################################################################
sub process
{
my $self = shift;
# Assign function parameters, defaults, and log debug info
my $strOperation = logDebugParam(__PACKAGE__ . '->process');
foreach my $strRenderOutId ($self->{oManifest}->renderOutList(RENDER_TYPE_MARKDOWN))
{
my $oRenderOut = $self->{oManifest}->renderOutGet(RENDER_TYPE_MARKDOWN, $strRenderOutId);
my $strFile = "$self->{strMarkdownPath}/" . (defined($$oRenderOut{file}) ? $$oRenderOut{file} : "${strRenderOutId}.md");
&log(INFO, " render out: ${strRenderOutId}");
# Save the html page
$self->{oManifest}->storage()->put(
$strFile, $self->{oManifest}->variableReplace((new pgBackRestDoc::Markdown::DocMarkdownRender($self->{oManifest},
$strRenderOutId, $self->{bExe}))->process()));
}
# Return from function and log return values if any
logDebugReturn($strOperation);
}
1;