From c950b9e903a2a8e19f95e3c90ca62c177bfb92db Mon Sep 17 00:00:00 2001 From: jolheiser Date: Sat, 3 Sep 2022 21:08:43 -0500 Subject: [PATCH] Update docs Signed-off-by: jolheiser --- DOCS.md | 78 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++- 1 file changed, 77 insertions(+), 1 deletion(-) diff --git a/DOCS.md b/DOCS.md index 1b097d4..c5e802b 100644 --- a/DOCS.md +++ b/DOCS.md @@ -6,8 +6,11 @@ git-ea is the base command git-ea ├─ backport ├─ branch +├─ cleanup ├─ frontport -└─ init +├─ ide +├─ init +└─ pr ``` @@ -31,6 +34,25 @@ git-ea **--version**: Print git-ea version +----- + +## cleanup + +cleanup removes named branches, or interactive if no arguments + + +``` +[--help] +``` +**Usage**: + +``` +cleanup [branches...] +``` + +**--help**: Show help + + ----- ## backport @@ -85,6 +107,8 @@ branch creates a new branch called `name` based on `base` [--b]=[value] [--base]=[value] [--help] +[--l] +[--list] [--nf] [--no-fetch] ``` @@ -103,6 +127,12 @@ branch --base [ref=main] **--help**: Show help +**--l**: --list + + +**--list**: List branches available + + **--nf**: --no-fetch @@ -144,6 +174,25 @@ frontport --from [release=latest] --to [release=main] **--to**="": Release to frontport to (ex: `main`, default: `main`) +----- + +## ide + +ide starts an IDE for `branch` + + +``` +[--help] +``` +**Usage**: + +``` +ide +``` + +**--help**: Show help + + ----- ## init @@ -165,3 +214,30 @@ init ----- +## pr + +pr pulls down a pull request for testing + + +``` +[--help] +[--i] +[--ide] +``` +**Usage**: + +``` +pr +``` + +**--help**: Show help + + +**--i**: --ide + + +**--ide**: Start an IDE for this PR + + +----- +