Skip to content

Commit

Permalink
Update branch command docs
Browse files Browse the repository at this point in the history
Update branch command docs to include details about support for patch
series and automatic push to remote. I also included a short reference
to the common use case for using the branch command so that users could
self identify and potentially dig deeper into the options and how it can
help them.

<!-- ps-id: 0d23a8e5-89bc-4030-b535-1ff7c2bd6ceb -->
  • Loading branch information
drewdeponte committed Mar 22, 2023
1 parent 71d5be6 commit 39c86b8
Showing 1 changed file with 10 additions and 6 deletions.
16 changes: 10 additions & 6 deletions src/cli.rs
Original file line number Diff line number Diff line change
Expand Up @@ -123,12 +123,16 @@ pub struct BackupStackCmdOpts {

#[derive(Debug, StructOpt)]
pub enum Command {
/// Your bridge back to the world of normal git and git concepts.
/// Basically a utility to help you create a normal git branch from a
/// patch or series of patches that is based on the patch stack base (e.g.
/// origin/main). Because this is a bridge back to the normal git concepts
/// like branches and commits it does no state tracking of these branches
/// inside of git patch stack.
/// Your bridge back to the world of normal git and git concepts. The branch command is a
/// utility to help you create a normal git branch from a patch or series of patches that is
/// based on the patch stack base (e.g. origin/main).
///
/// Because this is a bridge back to the normal git concepts like branches and commits it does
/// no state tracking of these branches.
///
/// It also has support for automatically pushing the branch to the remote. This is useful when
/// you are stuck working with a team that doesn't do the Patch Stack workflow but you still
/// want to do it locally.
Branch(BranchCmdOpts),
/// Create a request review branch on the patch stack base, cherry-pick
/// the specified patch onto it, & record association between patch &
Expand Down

0 comments on commit 39c86b8

Please sign in to comment.