sergiotarxz/Peace
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Updating documentation.

Browse Source
This commit is contained in:
sergiotarxz 2022-03-30 02:19:13 +02:00
parent e67a4cf593
commit e92aa3dfb4
2 changed files with 21 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
doc/lib/Peace/Model/Build.pm.html
View File

@ -26,6 +26,8 @@
<li><a href="#date_creation">date_creation</a></li>
<li><a href="#release">release</a></li>
<li><a href="#arch">arch</a></li>
<li><a href="#log">log</a></li>
<li><a href="#success">success</a></li>
</ul>
</li>
<li><a href="#SEE-ALSO">SEE ALSO</a></li>
@ -99,6 +101,22 @@ $build-&gt;arch($arch);</code></pre>
<p>Allows to set and retrieve the architecture attribute.</p>
<h2 id="log">log</h2>
<pre><code>my $log = $build-&gt;log;
$build-&gt;log($log);</code></pre>
<p>Allows to set an retrieve the build log.</p>
<h2 id="success">success</h2>
<pre><code>my $success = $build-&gt;success;
$build-&gt;success($success);</code></pre>
<p>Allows to set and retrieve the build success status.</p>
<h1 id="SEE-ALSO">SEE ALSO</h1>
<p><a href="Release.pm.html">Peace::Model::Release</a>, <a href="https://metacpan.org/pod/Peace::DAO::Build">Peace::DAO::Build</a></p>

8
doc/lib/Peace/Model/Release.pm.html
View File

@ -71,13 +71,11 @@
<h2 id="generate_build">generate_build</h2>
<p>my $result = $release-&gt;generate_build( arch =&gt; $arch );</p>
<p>my $build = $release-&gt;generate_build( arch =&gt; $arch );</p>
<p>my ($success, $output) = @result{&#39;success&#39;, &#39;output&#39;};</p>
<p>my $success = $build-&gt;success; my $log = $build-&gt;log;</p>
<p>Generates a build for a given arch of the release and returns the success status, any false value failed, any true value succeded and the output which combines stdout and stderr from the ran commands and some application specific data about whats being done.</p>
<p>The output log is thought to be human consumed, not automatically parsed.</p>
<p>Attempts to build a flatpak for the release and unconditionally returns a <a href="Build.pm.html">Peace::Model::Build</a> object with the results of the build.</p>
<h2 id="uuid">uuid</h2>