mirror of
https://github.com/martinvonz/jj.git
synced 2024-12-28 15:34:22 +00:00
Docs: Add a FAQ
This answers some questions, which were repeatedly asked in Discord.
This commit is contained in:
parent
75636d626f
commit
8188dc42df
2 changed files with 101 additions and 0 deletions
|
@ -318,6 +318,8 @@ The best way to get started is probably to go through
|
|||
[Git comparison](docs/git-comparison.md), which includes a table of
|
||||
`jj` vs. `git` commands.
|
||||
|
||||
As you become more familiar with Jujutsu, the [FAQ](docs/FAQ.md) may help.
|
||||
|
||||
## Related work
|
||||
|
||||
There are several tools trying to solve similar problems as Jujutsu. See
|
||||
|
|
99
docs/FAQ.md
Normal file
99
docs/FAQ.md
Normal file
|
@ -0,0 +1,99 @@
|
|||
# Frequently asked questions
|
||||
|
||||
### Why does my branch not move to the new commit after `jj new/commit`?
|
||||
|
||||
If you're familiar with Git, you might expect the current branch to move forward
|
||||
when you commit. However Jujutsu does not have a concept of a "current branch".
|
||||
|
||||
To move branches, use `jj branch set`.
|
||||
|
||||
### I made a commit and `jj git push --all` says "Nothing changed" instead of pushing it. What do I do?
|
||||
|
||||
`jj git push --all` pushes all _branches_, not all revisions. You have two
|
||||
options:
|
||||
|
||||
* Using `jj git push --change` will automatically create a branch and push it.
|
||||
* Using `jj branch` commands to create or move a branch to either the commit
|
||||
you want to push or a descendant on it. Unlike Git, Jujutsu doesn't do this
|
||||
automatically (see previous question).
|
||||
|
||||
### Where is my commit, why is it not visible in `jj log`?
|
||||
|
||||
Is your commit visible with `jj log -r 'all()'`?
|
||||
|
||||
If yes, you should be aware that `jj log` only shows the revisions matching
|
||||
`revsets.log` by default. You can change it as described in [config] to show
|
||||
more revisions.
|
||||
|
||||
If not, the revision may have been abandoned (e.g because you used `jj abandon`
|
||||
, or because it's an obsolete version that's been rewritten with `jj rebase`,
|
||||
`jj describe`, etc) In that case, `jj log -r commit_id` should show the
|
||||
revision as "hidden". `jj new commit_id` or `jj edit commit_id` should make the
|
||||
revision visible again.
|
||||
|
||||
See [revsets] and [templates] for further guidance.
|
||||
|
||||
### Can I prevent Jujutsu from recording my unfinished work? I'm not ready to commit it.
|
||||
|
||||
Jujutsu automatically records new files in the current working-copy commit and
|
||||
doesn't provide a way to prevent that.
|
||||
|
||||
However, you can easily record intermediate drafts of your worrk. If you think
|
||||
you might want to go back to the current state of the working-copy commit,
|
||||
simply use `jj new`. There's no need for the commit to be "finished" or even
|
||||
have a description.
|
||||
|
||||
Then future edits will go into a new working-copy commit on top of the now
|
||||
former working-copy commit. Whenever your are happy with another set of edits,
|
||||
use `jj squash` to amend the previous commit.
|
||||
|
||||
For more options see the next question.
|
||||
|
||||
### Can I add a portion of the edits I made to a file, similarly to `git add -p` or `hg commit -i`?
|
||||
|
||||
At the moment the best options to partially add a file are: `jj split -i`,
|
||||
`jj amend -i` and `jj move -i`.
|
||||
|
||||
### Is there something like `git rebase --interactive` or `hg histedit`?
|
||||
|
||||
Not yet, you can check [this issue] for updates.
|
||||
|
||||
To reorder commits, it is for now recommended to rebase commits individually,
|
||||
which may require multiple invocations of `jj rebase -r` or `jj rebase -s`.
|
||||
|
||||
To squash or split commits, use `jj squash` and `jj split`.
|
||||
|
||||
### How can I keep my scratch files in the repository?
|
||||
|
||||
You can keep your notes and other scratch files in the repository, if you add
|
||||
a wildcard pattern to either the repos `gitignore` or your global `gitignore`.
|
||||
Something like `*.scratch` or `*.scratchpad` should do, after that rename the
|
||||
files you want to keep around to match the pattern.
|
||||
|
||||
If `$EDITOR` integration is important, something like `scratchpad.*` may be more
|
||||
helpful, as you can keep the filetype intact (it matches `scratchpad.md`,
|
||||
`scratchpad.rs` and more).
|
||||
|
||||
You can find more details on `gitignore` files [here][gitignore].
|
||||
|
||||
### How can I keep local changes around, but not use them for Pull Requests?
|
||||
|
||||
In general, you should create a commit, which incorporates your local changes.
|
||||
After that, one possible workflow is to rebase your pending PRs on top of the
|
||||
commit with the local changes. Then, just before pushing to a remote, use
|
||||
`jj rebase -s child_of_commit_with_local_changes -d main` to move the PRs back
|
||||
on top of `main`.
|
||||
|
||||
If you have several PRs, you can try `jj rebase -s all:commit_with_local_changes+ -d main`
|
||||
(note the `+`) to move them all at once.
|
||||
|
||||
An alternative workflow would be to rebase the commit with local changes on
|
||||
top of the PR you're working on and then do `jj new commit_with_local_changes`.
|
||||
You'll then need to use `jj new --before` to create new commits and `jj move --to`
|
||||
to move new changes into the correct commits.
|
||||
|
||||
[config]: ./config.md
|
||||
[gitignore]: https://git-scm.com/docs/gitignore
|
||||
[revsets]: ./revsets.md
|
||||
[templates]: ./templates.md
|
||||
[this issue]: https://github.com/martinvonz/jj/issues/1531
|
Loading…
Reference in a new issue