GitLab system status is available here and here

Commit c961c7e4 authored by Anthony Umemoto's avatar Anthony Umemoto
Browse files

v1.3.0 doc

parent 89677fb3
......@@ -49,18 +49,29 @@ If the correct URL is returned, then the repair should work.
## OPTIONS
`-v Display verbose program output.`<br>
`-s Silence commit and push summaries.`<br>
`-p preset Use preset gitmang options. Create a new preset if the name does not exist. Display all presets if no name is specified.`<br>
`-d dir The file path, from the current working directory, to the repository being managed.`<br>
`-D dir The file path, from the main directory, to the repository being managed (recommended for UNIX only).`<br>
`-b branch Begins gitmang in branch. Creates branch if it does not exist (default: master).`<br>
`-f freq The time interval in minutes between each commit (default: 5).`<br>
`-r reps The number of commits to be made before ending (defualt: 100).`<br>
`-R dir Repairs the corrupted repository dir (path from working directory), saving un-committed files.`<br>
`-B Keeps gm_repair_backup directory after repository repair. This can be used as a backup in case [-R dir] fails. gm_repair_backup is placed in the same directory the repaired repository is a child of.`<br>
`file1 ... File names that will be added to the commit list.`<br>
`-h Display program usage and synopsis.`
`-v` Display verbose program output.
`-s` Silence commit and push summaries.
`-p preset` Use preset gitmang options. Create a new preset if the name does not exist. Display all presets if no name is specified.
`-d dir` The file path, from the current working directory, to the repository being managed.
`-D dir` The file path, from the main directory, to the repository being managed (recommended for UNIX only).
`-b branch` Begins gitmang in branch. Creates branch if it does not exist (default: master).
`-f freq` The time interval in minutes between each commit (default: 5).
`-r reps` The number of commits to be made before ending (defualt: 100).
`-R dir` Repairs the corrupted repository dir (path from working directory), saving un-committed files.
`-B` Keeps gm_repair_backup directory after repository repair. This can be used as a backup in case [-R dir] fails. gm_repair_backup is placed in the same directory the repaired repository is a child of.
`file1 file2 ...` File names that will be added to the commit list.
`-h` Display program usage and synopsis.
## RUNTIME OPTIONS
......@@ -102,8 +113,6 @@ If you encounter a bug, please report it using this form: https://docs.google.co
### UNEXPECTED/UNWANTED BEHAVIORS
+ A commit is counted even if nothing is pushed. This is seen in the verbose output, and the program output.
### ARCHITECTURE
+ All variables are prepended with `gm_` to prevent overriding other global variables, but this is still possible since most of the script is not contained within a function.
......
......@@ -26,11 +26,12 @@ function gm_usage {
echo " A shell script that commits specified files at a regular interval."
echo ""
echo "USAGE"
echo " $ ./gitmang.sh [-vsBh] [-dDR dir] [-b branch] [-f freq] [-r reps] [file1 file2 ...]"
echo " $ ./gitmang.sh [-vsBh] [-p preset] [-dDR dir] [-b branch] [-f freq] [-r reps] [file1 file2 ...]"
echo ""
echo "OPTIONS"
echo " -v Display verbose program output."
echo " -s Silence commit and push summaries."
echo " -p preset Use preset gitmang options."
echo " -d dir The file path, from the current working directory, to the repository being managed."
echo " -D dir The file path, from the main directory, to the repository being managed."
echo " -b branch Begins gitmang in branch. Creates branch if it does not exist (default: master)."
......
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment