From 08f624fd4d3175816ee8bf431e42ff14e66587a5 Mon Sep 17 00:00:00 2001
From: Trevor Batley <trevorb@noreply.koozali.org>
Date: Fri, 2 Jun 2023 03:59:49 +0200
Subject: [PATCH] add in all optional parameters

---
 README.md | 32 +++++++++++++++++++++++++-------
 1 file changed, 25 insertions(+), 7 deletions(-)

diff --git a/README.md b/README.md
index 18312a9..3bd460c 100644
--- a/README.md
+++ b/README.md
@@ -15,36 +15,54 @@ copy current cvs version of a package across to git in new structure
 
 * \<repository\> repository (package) to be migrated (e.g. smeserver-yum)
 * \<organisation\> can ONLY be smeserver or smecontribs
+
+optional parameters, can appear in any order
+
 * \<local\> will migrate into your local GITEA (in config), otherwise remote GITEA
+* \<debug\> run in debug mode
 
 ## git-get-and-build-repo.sh
 bring down current git repository and run mockbuild
 
-    git-get-and-build.sh <organisation> <repository> [<local>]
+    git-get-and-build.sh <organisation> <repository> [<local> <debug>]
 
 * \<repository\> repository (package) to be built (e.g. smeserver-yum)
-* \<organisation\> can ONLY be smeserver or smecontribs
+* \<organisation\> can be any organisation or user on the remote GITEA instance
+
+optional parameters, can appear in any order
+
 * \<local\> will build from local GITEA (in config), otherwise from remote GITEA
+* \<debug\> run in debug mode
 
 ## git-migrate-repo.sh
 create mirror or copy of src.koozali.org repository in a local GITEA instance
 
-    git-migrate-repo.sh <repository> <organisation> [<copy|mirror> <target organisation>]
+    git-migrate-repo.sh <repository> <organisation> [<copy|mirror> <target organisation> <debug>]
 
 * \<repository\> repository (package) to be copied (e.g. smeserver-yum)
-* \<organisation\> can be any repository on the remote GITEA
+* \<organisation\> can be any organisation or user on the remote GITEA instance
+* \<debug\> run in debug mode
+
+optional parameters, can appear in any order
+
 * \<copy|mirror\> will create local repo as either a copy or a mirror of the remote repo (default = copy)
 * \<target organisation\> within your local GITEA, otherwise local user - must exist already
+* \<debug\> run in debug mode
 
 ## git-migrate-org.sh
 create mirrors of all repos for an organisation in a local GITEA instance
 
-    git-migrate-org.sh <organisation> [<copy|mirror> <review> <target organisation>]
+    git-migrate-org.sh <organisation> [<copy|mirror> <review> <target organisation> <debug>]
+
+* \<organisation\> can be any organisation or user on the remote GITEA instance
+
+optional parameters, can appear in any order
 
-* \<organisation\> can be any repository on the remote GITEA
 * \<copy|mirror\> will create local repos as either a copy or a mirror of the remote repos (default = copy)
 * \<review\> will just list the repos to be migrated, rather than doing it
 * \<target organisation\> within your local GITEA, otherwise local user - must exist already
+* \<debug\> run in debug mode
+* \<noisy\> show each repo being migrated
 
 ## rename-e-smith-pkg.sh
 Rename an e-smith package as smeserver and change relevant files
@@ -67,7 +85,7 @@ Parse a list of parameters and execute script with those parameters
 
     parse-list.sh <param file> <script> [<noisy> <additional> <additional> <additional>]
 
-* \<param file\> = name of file containing parameters
+* \<param file\> name of file containing parameters
 * \<script\> script to run (e.g. rename-e-smith-pkg.sh)
 
 optional params can appear in any order