Skip to content

Commit

Permalink
fix: update branch name from integration to workspace (#65)
Browse files Browse the repository at this point in the history
  • Loading branch information
polisherm authored Dec 29, 2024
1 parent cdaaace commit b28d3b0
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions content/docs/features/virtual-branches/integration-branch.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -30,13 +30,13 @@ To keep Git command output for things that look at the index and HEAD (such as `

For instance, if you have two files on Branch A and two files on Branch B, then `git status` will simply list four files as modified.

However, to help out, we also write out a branch with a custom commit message that tries to explain the state of things and what is happening. This is written to a branch we own called `gitbutler/integration` and you shouldn't touch it.
However, to help out, we also write out a branch with a custom commit message that tries to explain the state of things and what is happening. This is written to a branch we own called `gitbutler/workspace` and you shouldn't touch it.

If you run `git log`, the first commit should be our custom commit message and the tree of that commit is the union of all the committed work on all your applied virtual branches, as though they were all merged together into one (something stock Git can understand).

## Committing, Branching, Checking Out

However, if you try to use something that writes to HEAD, like `git commit` or `git checkout`, then you might have some headaches. By default, our client will simply overwrite the `gitbutler/integration` branch commit whenever something significant changes.
However, if you try to use something that writes to HEAD, like `git commit` or `git checkout`, then you might have some headaches. By default, our client will simply overwrite the `gitbutler/workspace` branch commit whenever something significant changes.

We won't touch the working directory in an unexpected way, so whatever you commit won't be lost, but the commit itself will be forgotten. Don't do branch stuff in stock Git while trying to use GitButler for now. We have ideas on how to make this somewhat doable in the future, but right now it's easier on everyone to stick with one or the other.

Expand Down

0 comments on commit b28d3b0

Please sign in to comment.