update docs with new opt parameters

Signed-off-by: simonsan <14062932+simonsan@users.noreply.github.com>

crates/core/src/commands/check.rs

@@ -146,6 +146,8 @@ pub struct CheckOptions {
 /// # Arguments
 ///
 /// * `repo` - The repository to check
+/// * `opts` - The check options to use
+/// * `trees` - The trees to check
 ///
 /// # Errors
 ///

crates/core/src/commands/key.rs

@@ -32,17 +32,18 @@ pub struct KeyOptions {
 ///
 /// # Type Parameters
 ///
-/// * `P` - The progress bar type.
-/// * `S` - The state the repository is in.
+/// * `P` - The progress bar type
+/// * `S` - The state the repository is in
 ///
 /// # Arguments
 ///
-/// * `repo` - The repository to add the key to.
-/// * `pass` - The password to encrypt the key with.
+/// * `repo` - The repository to add the key to
+/// * `opts` - The key options to use
+/// * `pass` - The password to encrypt the key with
 ///
 /// # Errors
 ///
-/// * [`CommandErrorKind::FromJsonError`] - If the key could not be serialized.
+/// * [`CommandErrorKind::FromJsonError`] - If the key could not be serialized
 ///
 /// # Returns
 ///
@@ -62,13 +63,14 @@ pub(crate) fn add_current_key_to_repo<P, S: Open>(
 ///
 /// # Type Parameters
 ///
-/// * `P` - The progress bar type.
-/// * `S` - The state the repository is in.
+/// * `P` - The progress bar type
+/// * `S` - The state the repository is in
 ///
 /// # Arguments
 ///
-/// * `repo` - The repository to add the key to.
-/// * `pass` - The password to encrypt the key with.
+/// * `repo` - The repository to add the key to
+/// * `opts` - The key options to use
+/// * `pass` - The password to encrypt the key with
 ///
 /// # Returns
 ///
@@ -87,9 +89,10 @@ pub(crate) fn init_key<P, S>(
 ///
 /// # Arguments
 ///
-/// * `repo` - The repository to add the key to.
-/// * `pass` - The password to encrypt the key with.
-/// * `key` - The key to add.
+/// * `repo` - The repository to add the key to
+/// * `opts` - The key options to use
+/// * `pass` - The password to encrypt the key with
+/// * `key` - The key to add
 ///
 /// # Errors
 ///

crates/core/src/commands/prune.rs

@@ -666,12 +666,13 @@ impl PrunePlan {
     ///
     /// # Type Parameters
     ///
-    /// * `P` - The progress bar type.
-    /// * `S` - The state the repository is in.
+    /// * `P` - The progress bar type
+    /// * `S` - The state the repository is in
     ///
     /// # Arguments
     ///
-    /// * `repo` - The repository to get the `PrunePlan` for.
+    /// * `repo` - The repository to get the `PrunePlan` for
+    /// * `opts` - The `PruneOptions` to use
     ///
     /// # Errors
     ///
@@ -1165,6 +1166,7 @@ impl PrunePlan {
 ///
 /// * `repo` - The repository to prune
 /// * `opts` - The options for the pruning
+/// * `prune_plan` - The plan for the pruning
 ///
 /// # Errors
 ///

crates/core/src/commands/repair/snapshots.rs

@@ -85,6 +85,7 @@ pub(crate) struct RepairState {
 /// # Arguments
 ///
 /// * `repo` - The repository to repair
+/// * `opts` - The repair options to use
 /// * `snapshots` - The snapshots to repair
 /// * `dry_run` - Whether to actually modify the repository or just print what would be done
 pub(crate) fn repair_snapshots<P: ProgressBars, S: IndexedFull>(
@@ -179,6 +180,7 @@ pub(crate) fn repair_snapshots<P: ProgressBars, S: IndexedFull>(
 /// # Arguments
 ///
 /// * `be` - The backend to use
+/// * `opts` - The repair options to use
 /// * `packer` - The packer to use
 /// * `id` - The id of the tree to repair
 /// * `replaced` - A map of already replaced trees

crates/core/src/commands/restore.rs

@@ -98,15 +98,16 @@ pub struct RestoreStats {
 ///
 /// # Type Parameters
 ///
-/// * `P` - The progress bar type.
-/// * `S` - The type of the indexed tree.
+/// * `P` - The progress bar type
+/// * `S` - The type of the indexed tree
 ///
 /// # Arguments
 ///
-/// * `file_infos` - The restore information.
-/// * `repo` - The repository to restore.
-/// * `node_streamer` - The node streamer to use.
-/// * `dest` - The destination to restore to.
+/// * `file_infos` - The restore information
+/// * `repo` - The repository to restore
+/// * `opts` - The restore options
+/// * `node_streamer` - The node streamer to use
+/// * `dest` - The destination to restore to
 ///
 /// # Errors
 ///
@@ -329,8 +330,9 @@ pub(crate) fn collect_and_prepare<P: ProgressBars, S: IndexedFull>(
 ///
 /// # Arguments
 ///
-/// * `node_streamer` - The node streamer to use.
-/// * `dest` - The destination to restore to.
+/// * `node_streamer` - The node streamer to use
+/// * `opts` - The restore options to use
+/// * `dest` - The destination to restore to
 ///
 /// # Errors
 ///
@@ -350,18 +352,18 @@ fn restore_metadata(
                         break;
                     }
                     let (path, node) = dir_stack.pop().unwrap();
-                    set_metadata(opts, dest, &path, &node);
+                    set_metadata(dest, opts, &path, &node);
                 }
                 // push current path to the stack
                 dir_stack.push((path, node));
             }
-            _ => set_metadata(opts, dest, &path, &node),
+            _ => set_metadata(dest, opts, &path, &node),
         }
     }
 
     // empty dir stack and set metadata
     for (path, node) in dir_stack.into_iter().rev() {
-        set_metadata(opts, dest, &path, &node);
+        set_metadata(dest, opts, &path, &node);
     }
 
     Ok(())
@@ -371,17 +373,18 @@ fn restore_metadata(
 ///
 /// # Arguments
 ///
-/// * `dest` - The destination to restore to.
-/// * `path` - The path of the file or directory.
-/// * `node` - The node information of the file or directory.
+/// * `dest` - The destination to restore to
+/// * `opts` - The restore options to use
+/// * `path` - The path of the file or directory
+/// * `node` - The node information of the file or directory
 ///
 /// # Errors
 ///
 /// If the metadata could not be set.
 // TODO: Return a result here, introduce errors and get rid of logging.
 pub(crate) fn set_metadata(
-    opts: RestoreOptions,
     dest: &LocalDestination,
+    opts: RestoreOptions,
     path: &PathBuf,
     node: &Node,
 ) {