Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Update the help text for the stack sync command #400

Merged
merged 2 commits into from
Aug 20, 2024
Merged

Update the help text for the stack sync command #400

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
b79cb84
Update the help text for the stack sync command
draftcode Aug 19, 2024
a6c08e4
Merge branch 'master' into update_docs
aviator-app[bot] Aug 20, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 5 additions & 3 deletions cmd/av/stack_sync.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,11 +53,13 @@ By default, this command will sync all branches starting at the root of the
stack and recursively rebasing each branch based on the latest commit from the
parent branch.

If the --all flag is given, this command will sync all branches in the repository.

If the --current flag is given, this command will not recursively sync dependent
branches of the current branch within the stack. This allows you to make changes
to the current branch before syncing the rest of the stack.

If the --trunk flag is given, this command will synchronize changes from the
If the --rebase-to-trunk flag is given, this command will synchronize changes from the
latest commit to the repository base branch (e.g., main or master) into the
stack. This is useful for rebasing a whole stack on the latest changes from the
base branch.
Expand Down Expand Up @@ -669,10 +671,10 @@ func init() {
_ = stackSyncCmd.Flags().
MarkDeprecated("no-fetch", "please use av stack restack for offline restacking")
stackSyncCmd.Flags().Bool("trunk", false,
"(deprecated; now av stack sync automatically restacks on the trunk branch without this option. Use av stack restack for stacking without the trunk branch) rebase the stack on the trunk branch",
"(deprecated; use --rebase-to-trunk to rebase all branches to trunk) rebase the stack on the trunk branch",
)
_ = stackSyncCmd.Flags().
MarkDeprecated("trunk", "now av stack sync automatically restacks on the trunk branch without this option. Use av stack restack for restacking without the trunk branch")
MarkDeprecated("trunk", "please use --rebase-to-trunk to rebase all branches to trunk")
stackSyncCmd.Flags().String("parent", "",
"(deprecated; use av stack adopt or av stack reparent) parent branch to rebase onto",
)
Expand Down
Loading