git sw behavior contradicts documentation?

[sergej-koscejev]

git branchless switch --help says:

Arguments:
  [TARGET]
          The commit or branch to check out.

          If this is not provided, then interactive commit selection starts as if `--interactive` were passed.

But git branchless switch or git sw without target seems to re-check out the current commit and not start the interactive commit selection. I have to call git sw -i for interactive selection.

Is this some misconfiguration on my side or a bug?

[arxanas]

Hi, I think this is a bug in the documentation.

• At some point, I envisioned that you could attach/detach to the branch for the current commit when invoking without arguments.
  • The semantics might need to be worked out, particularly because there's some configuration option for auto-attaching behavior.
  • I'd be open to adjusting the semantics of the no-argument invocation.
• Generally, I think I've become less of a fan of automatic interactive behavior depending on the specific arguments. This sometimes causes scripts to hang when some argument array fails to be populated. Therefore, I'd be inclined to always require -i for interactive invocations.

I opened #1548 for this.

[claytonrcarter]

@sergej-koscejev Thanks for mentioning this. I've corrected the description for [TARGET] in #1647.

you could attach/detach to the branch for the current commit when invoking without arguments

This is the current behavior. git switch --detach will detach head at the current commit, and git switch will re-attach. The auto-attache behavior can be disabled with git config branchless.navigation.autoSwitchBranches false, but then git switch becomes sort of a no-op (I don't think it would do anything).

FWIW the test for this is test_switch_detach, at https://github.com/arxanas/git-branchless/blob/master/git-branchless/tests/test_navigation.rs#L1058-L1100