Updated comments

This commit is contained in:
Trevor Batley 2023-06-21 16:53:28 +10:00
parent 7a7a68753a
commit b7188cbf4b
2 changed files with 8 additions and 1 deletions

View File

@ -77,7 +77,9 @@ optional parameters, can appear in any order
* \<organisation\> (any gitea organisation smeserver, smecontribs or user - defaults to smeserver) * \<organisation\> (any gitea organisation smeserver, smecontribs or user - defaults to smeserver)
* \<local\> will use parameters set for local repository else it will use remote * \<local\> will use parameters set for local repository else it will use remote
* \<force\> will automagically delete an existing repo, otherwise it will prompt * \<force\> will automagically delete an existing repo, otherwise it will prompt
* \<transfer\> will transfer the updated repository to the source org (need to be owner)
* \<debug\> run in debug mode * \<debug\> run in debug mode
* \<silent\> will suppress the finished Ok message
This works whether the repo and local files exist of not (it deletes them if necessary) This works whether the repo and local files exist of not (it deletes them if necessary)

View File

@ -1,23 +1,28 @@
#!/bin/bash #!/bin/bash
# #
# Rename an e-smith package as smeserver and change relevant files # Rename an e-smith package as smeserver and change relevant files
# Will migrate a repository from the source organisation into your work area and rename it as smeserver and do all changes there.
# If transfer is specified it will then transfer the new repository to the source organisation (you MUST be an owner to fo this)
# $1 = Module name e.g. e-smith-dnscache # $1 = Module name e.g. e-smith-dnscache
# $2-$5 can appear in any order and are optional # $2-$5 can appear in any order and are optional
# = Organisation (smeserver or user - defaults to smeserver) # = Organisation (smeserver or user - defaults to smeserver)
# = "local" will use parameters set for local repository else it will use remote # = "local" will use parameters set for local repository else it will use remote
# = "force" will automagically delete an existing repo, otherwise it will prompt # = "force" will automagically delete an existing repo, otherwise it will prompt
# = "transfer" will push completed package into source organisation (other wise leave in your area)
# = "debug" run in debug mode # = "debug" run in debug mode
# = "silent" suppress success message
# This works whether the repo and local files exist of not (it deletes them if necessary) # This works whether the repo and local files exist of not (it deletes them if necessary)
# #
if [[ -z $1 ]] ; then if [[ -z $1 ]] ; then
echo "Rename an e-smith package as smeserver and change relevant files" echo "Rename an e-smith package as smeserver and change relevant files"
echo "rename-e-smith-pkg.sh <modulename> [<organization> <local> <force> <debug> <silent>]" echo "rename-e-smith-pkg.sh <modulename> [<organization> <local> <force> <transfer> <debug> <silent>]"
echo "<modulename> = Module/package name (e.g. e-smith-dnscache)" echo "<modulename> = Module/package name (e.g. e-smith-dnscache)"
echo " can appear in any order and are optional" echo " can appear in any order and are optional"
echo " - <organisation> (any valid organisation - defaults to smeserver)" echo " - <organisation> (any valid organisation - defaults to smeserver)"
echo " - <local> will use parameters set for local repository, else it will use remote" echo " - <local> will use parameters set for local repository, else it will use remote"
echo " - <force> will automagically delete an existing repo, otherwise it will prompt" echo " - <force> will automagically delete an existing repo, otherwise it will prompt"
echo " - <transfer> will push completed package into source organisation (other wise leave in your area)"
echo " - <debug> run in debug mode" echo " - <debug> run in debug mode"
echo " - <silent> suppress success message" echo " - <silent> suppress success message"
exit 0 exit 0