From cbe048bb3ffb8f74752e4668957fbf105cedbf62 Mon Sep 17 00:00:00 2001
From: Rin Toshaka <rinpatch@sdf.org>
Date: Sun, 9 Dec 2018 20:17:35 +0100
Subject: [PATCH 1/2] Mix tasks: improve uploads.ex moduledoc
---
lib/mix/tasks/pleroma/uploads.ex | 14 ++++++++++----
1 file changed, 10 insertions(+), 4 deletions(-)
diff --git a/lib/mix/tasks/pleroma/uploads.ex b/lib/mix/tasks/pleroma/uploads.ex
index 0742ab378..d934bd6dc 100644
--- a/lib/mix/tasks/pleroma/uploads.ex
+++ b/lib/mix/tasks/pleroma/uploads.ex
@@ -6,11 +6,17 @@ defmodule Mix.Tasks.Pleroma.Uploads do
require Logger
@log_every 50
- @shortdoc "Migrate uploads from local to remote storage"
- @longdoc """
- Manages uploads
- ## Migrate uploads from local to remote storage
+ @shortdoc "Manages uploads"
+ @moduledoc """
+ Manages uploads.
+ ## Migrate uploads from local to remote storage
+ mix pleroma.uploads migrate_local TARGET_UPLOADER [OPTIONS...]
+ Options:
+ - `--delete` - delete local uploads after migrating them to the target uploader
+
+
+ A list of avalible uploaders can be seen in config.exs
"""
def run(["migrate_local", target_uploader | args]) do
From 993c8c8bd4e94985c647f4f9e927cbaa7148e6a0 Mon Sep 17 00:00:00 2001
From: rinpatch <rinpatch@sdf.org>
Date: Mon, 10 Dec 2018 08:03:17 +0300
Subject: [PATCH 2/2] Keep the shortdoc descriptive
---
lib/mix/tasks/pleroma/uploads.ex | 4 +---
1 file changed, 1 insertion(+), 3 deletions(-)
diff --git a/lib/mix/tasks/pleroma/uploads.ex b/lib/mix/tasks/pleroma/uploads.ex
index d934bd6dc..6ffc941c9 100644
--- a/lib/mix/tasks/pleroma/uploads.ex
+++ b/lib/mix/tasks/pleroma/uploads.ex
@@ -6,10 +6,8 @@ defmodule Mix.Tasks.Pleroma.Uploads do
require Logger
@log_every 50
- @shortdoc "Manages uploads"
+ @shortdoc "Migrates uploads from local to remote storage"
@moduledoc """
- Manages uploads.
-
## Migrate uploads from local to remote storage
mix pleroma.uploads migrate_local TARGET_UPLOADER [OPTIONS...]
Options: