From e92aa3dfb4af9d1fcf9fc5e3e2776ca9544f6de2 Mon Sep 17 00:00:00 2001 From: sergiotarxz Date: Wed, 30 Mar 2022 02:19:13 +0200 Subject: [PATCH] Updating documentation. --- doc/lib/Peace/Model/Build.pm.html | 18 ++++++++++++++++++ doc/lib/Peace/Model/Release.pm.html | 8 +++----- 2 files changed, 21 insertions(+), 5 deletions(-) diff --git a/doc/lib/Peace/Model/Build.pm.html b/doc/lib/Peace/Model/Build.pm.html index 26b7ada..6c8ee6e 100644 --- a/doc/lib/Peace/Model/Build.pm.html +++ b/doc/lib/Peace/Model/Build.pm.html @@ -26,6 +26,8 @@
  • date_creation
  • release
  • arch
  • +
  • log
  • +
  • success
  • SEE ALSO
  • @@ -99,6 +101,22 @@ $build->arch($arch);

    Allows to set and retrieve the architecture attribute.

    +

    log

    + +
    my $log = $build->log;
    +
    +$build->log($log);
    + +

    Allows to set an retrieve the build log.

    + +

    success

    + +
    my $success = $build->success;
    +
    +$build->success($success);
    + +

    Allows to set and retrieve the build success status.

    +

    SEE ALSO

    Peace::Model::Release, Peace::DAO::Build

    diff --git a/doc/lib/Peace/Model/Release.pm.html b/doc/lib/Peace/Model/Release.pm.html index 89e2a97..0be06a5 100644 --- a/doc/lib/Peace/Model/Release.pm.html +++ b/doc/lib/Peace/Model/Release.pm.html @@ -71,13 +71,11 @@

    generate_build

    -

    my $result = $release->generate_build( arch => $arch );

    +

    my $build = $release->generate_build( arch => $arch );

    -

    my ($success, $output) = @result{'success', 'output'};

    +

    my $success = $build->success; my $log = $build->log;

    -

    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.

    - -

    The output log is thought to be human consumed, not automatically parsed.

    +

    Attempts to build a flatpak for the release and unconditionally returns a Peace::Model::Build object with the results of the build.

    uuid