Document autoclean and release log features

Signed-off-by: Laurent Bonnans <[email protected]>
advancedtelematic · Sep 6, 2019 · 3267861 · 3267861
1 parent 2a4b51c
commit 3267861
Show file tree

Hide file tree

Showing 5 changed files with 18 additions and 3 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -6,6 +6,11 @@ Our versioning scheme is `YEAR.N` where `N` is incremented whenever a new releas
 
 ## [??? (unreleased)]
 
+### Added
+
+- `GetInstallationLog` API method: [PR](https://github.com/advancedtelematic/aktualizr/pull/1318)
+- The aktualizr daemon will now automatically remove old downloaded targets to free up disk space: [PR](https://github.com/advancedtelematic/aktualizr/pull/1318)
+
 ## [2019.6] - 2019-08-21
 
 ### Added

diff --git a/actions.md b/actions.md
@@ -173,6 +173,7 @@ These are the primary actions that a user of libaktualizr can perform through th
   - [x] Store negative device installation result when an ECU installation failed (aktualizr_test.cc)
   - [x] Update is not in pending state anymore after failed installation (aktualizr_test.cc)
   - [x] Send AllInstallsComplete event after all installations are finished (aktualizr_test.cc)
+  - [x] Automatically remove old targets during installation cycles (aktualizr_test.cc)
 - [x] Send installation report
   - [x] Generate and send manifest (see below)
   - [x] Send PutManifestComplete event if send is successful (aktualizr_test.cc)

diff --git a/src/libaktualizr/primary/aktualizr.h b/src/libaktualizr/primary/aktualizr.h
@@ -83,7 +83,9 @@ class Aktualizr {
   std::future<result::Download> Download(const std::vector<Uptane::Target>& updates);
 
   /**
-   * Get log of installations
+   * Get log of installations. The log is indexed for every ECU and contains
+   * every change of versions ordered by time. It may contain duplicates in
+   * case of rollbacks.
    * @return installation log
    */
   struct InstallationLogEntry {

diff --git a/src/libaktualizr/primary/aktualizr_helpers.h b/src/libaktualizr/primary/aktualizr_helpers.h
@@ -4,8 +4,11 @@
 #include <memory>
 #include "aktualizr.h"
 
-// add as a signal handler to remove old targets just after an installation
-// completes
+/*
+ * Signal handler to remove old targets just after an installation completes
+ *
+ * To be attached with Aktualizr::SetSignalHandler
+ */
 void targets_autoclean_cb(Aktualizr &aktualizr, const std::shared_ptr<event::BaseEvent> &event);
 
 #endif  // AKTUALIZR_HELPERS_H_
diff --git a/src/libaktualizr/primary/aktualizr_test.cc b/src/libaktualizr/primary/aktualizr_test.cc
@@ -1332,6 +1332,10 @@ TEST(Aktualizr, DownloadListRemove) {
   EXPECT_EQ(targets.size(), 0);
 }
 
+/*
+ * Automatically remove old targets during installation cycles.
+ * Get log of installation.
+ */
 TEST(Aktualizr, TargetAutoremove) {
   TemporaryDirectory temp_dir;
   const boost::filesystem::path local_metadir = temp_dir / "metadir";