db/pgbackrest
1
0
Fork 0
mirror of https://github.com/pgbackrest/pgbackrest.git synced 2025-11-06 08:49:29 +02:00
Code Issues Releases Activity

README.md is now rendered by new Markdown code.

Browse Source
This commit is contained in:
David Steele
2016-04-16 11:55:23 -04:00
parent ad8ad11e4f
commit dee3e86ff8
8 changed files with 18 additions and 19 deletions
Download Patch File Download Diff File Expand all files Collapse all files

13
doc/doc.pl
View File

@@ -197,13 +197,6 @@ for my $strOutput (@stryOutput)
&log(INFO, "render ${strOutput} output");
if ($strOutput eq 'markdown' && $oManifest->isBackRest())
{
# Generate the markdown
docProcess("${strBasePath}/xml/index.xml", "${strBasePath}/../README.md", $oManifest);
docProcess("${strBasePath}/xml/change-log.xml", "${strBasePath}/../CHANGELOG.md", $oManifest);
}
if ($strOutput eq 'markdown')
{
my $oMarkdown =
@@ -216,6 +209,12 @@ for my $strOutput (@stryOutput)
);
$oMarkdown->process();
# Generate the change log using the old markdown code.
if ($oManifest->isBackRest())
{
docProcess("${strBasePath}/xml/change-log.xml", "${strBasePath}/../CHANGELOG.md", $oManifest);
}
}
elsif ($strOutput eq 'help' && $oManifest->isBackRest())
{

4
doc/lib/BackRestDoc/Common/DocRender.pm
View File

@@ -39,7 +39,7 @@ my $oRenderTag =
'b' => ['**', '**'],
'i' => ['_', '_'],
# 'bi' => ['_**', '**_'],
'ul' => ["\n", "\n"],
'ul' => ["\n", ""],
'ol' => ["\n", "\n"],
'li' => ['- ', "\n"],
'id' => ['`', '`'],
@@ -475,7 +475,7 @@ sub process
$strBuffer .= 'v' . $oDoc->paramGet('version') . ': ';
}
$strBuffer .= ($iDepth == 1 ? "{[project]}<br/>" : '') . $strTitle;
$strBuffer .= ($iDepth == 1 ? "{[project]} <br/> " : '') . $strTitle;
if (defined($oDoc->paramGet('date', false)))
{

6
doc/lib/BackRestDoc/Markdown/DocMarkdownRender.pm
View File

@@ -89,7 +89,7 @@ sub process
if (defined($oPage->paramGet('subtitle', false)))
{
$strMarkdown .= ' - ' . $oPage->paramGet('subtitle');
$strMarkdown .= ' <br/> ' . $oPage->paramGet('subtitle') . '';
}
# my $oHtmlBuilder = new BackRestDoc::Html::DocHtmlBuilder("{[project]} - Reliable PostgreSQL Backup",
@@ -155,7 +155,7 @@ sub process
# Render sections
foreach my $oSection ($oPage->nodeList('section'))
{
$strMarkdown .= "\n\n" . $self->sectionProcess($oSection, 1);
$strMarkdown = trim($strMarkdown) . "\n\n" . $self->sectionProcess($oSection, 1);
}
$strMarkdown .= "\n";
@@ -345,7 +345,7 @@ sub sectionProcess
# Add a subsection
elsif ($oChild->nameGet() eq 'section')
{
$strMarkdown .= "\n\n" . $self->sectionProcess($oChild, $iDepth + 1);
$strMarkdown = trim($strMarkdown) . "\n\n" . $self->sectionProcess($oChild, $iDepth + 1);
}
# Check if the child can be processed by a parent
else

1
doc/manifest.xml
View File

@@ -45,6 +45,7 @@
</render>
<render type="markdown">
<render-source key="index" file="../../../README.md"/>
<render-source key="test" file="../../../test/README.md"/>
</render>
</render-list>

7
doc/xml/index.xml
View File

@@ -42,8 +42,8 @@
<li>Restore delta option</li>
<li>Restore using timestamp/size or checksum</li>
<li>Restore remapping base/tablespaces</li>
<li>Support for <postgres/> >= 8.3</li>
</ul>Instead of relying on traditional backup tools like tar and rsync, <backrest/> implements all backup features internally and uses a custom protocol for communicating with remote systems. Removing reliance on tar and rsync allows for better solutions to database-specific backup issues. The custom remote protocol limits the types of connections that are required to perform a backup which increases security.</p>
<li>Support for <postgres/> >= 8.3</li></ul>
Instead of relying on traditional backup tools like tar and rsync, <backrest/> implements all backup features internally and uses a custom protocol for communicating with remote systems. Removing reliance on tar and rsync allows for better solutions to database-specific backup issues. The custom remote protocol limits the types of connections that are required to perform a backup which increases security.</p>
</section>
<section id="getting-started">
@@ -53,8 +53,7 @@
<ul>
<li><link page="{[backrest-page-user-guide]}">User guide</link> for Ubuntu 12.04 &amp; 14.04 / <postgres/> 9.4.</li>
<li><link page="{[backrest-page-command]}">Command reference</link> for command-line operations.</li>
<li><link page="{[backrest-page-configuration]}">Configuration reference</link> for creating rich <backrest/> configurations.</li>
</ul></p>
<li><link page="{[backrest-page-configuration]}">Configuration reference</link> for creating rich <backrest/> configurations.</li></ul></p>
</section>
<section id="contributing">