mirror of
https://github.com/martinvonz/jj.git
synced 2024-12-25 05:29:39 +00:00
new: swap order of @ and main in doc comment
Some checks are pending
binaries / Build binary artifacts (push) Waiting to run
nix / flake check (push) Waiting to run
build / build (, macos-13) (push) Waiting to run
build / build (, macos-14) (push) Waiting to run
build / build (, ubuntu-latest) (push) Waiting to run
build / build (, windows-latest) (push) Waiting to run
build / build (--all-features, ubuntu-latest) (push) Waiting to run
build / Build jj-lib without Git support (push) Waiting to run
build / Check protos (push) Waiting to run
build / Check formatting (push) Waiting to run
build / Check that MkDocs can build the docs (push) Waiting to run
build / Check that MkDocs can build the docs with latest Python and uv (push) Waiting to run
build / cargo-deny (advisories) (push) Waiting to run
build / cargo-deny (bans licenses sources) (push) Waiting to run
build / Clippy check (push) Waiting to run
Codespell / Codespell (push) Waiting to run
website / prerelease-docs-build-deploy (ubuntu-latest) (push) Waiting to run
Scorecards supply-chain security / Scorecards analysis (push) Waiting to run
Some checks are pending
binaries / Build binary artifacts (push) Waiting to run
nix / flake check (push) Waiting to run
build / build (, macos-13) (push) Waiting to run
build / build (, macos-14) (push) Waiting to run
build / build (, ubuntu-latest) (push) Waiting to run
build / build (, windows-latest) (push) Waiting to run
build / build (--all-features, ubuntu-latest) (push) Waiting to run
build / Build jj-lib without Git support (push) Waiting to run
build / Check protos (push) Waiting to run
build / Check formatting (push) Waiting to run
build / Check that MkDocs can build the docs (push) Waiting to run
build / Check that MkDocs can build the docs with latest Python and uv (push) Waiting to run
build / cargo-deny (advisories) (push) Waiting to run
build / cargo-deny (bans licenses sources) (push) Waiting to run
build / Clippy check (push) Waiting to run
Codespell / Codespell (push) Waiting to run
website / prerelease-docs-build-deploy (ubuntu-latest) (push) Waiting to run
Scorecards supply-chain security / Scorecards analysis (push) Waiting to run
I followed the recommendation in the `jj new` doc to use `jj new main @` to make a merge commit and ended up with a merge commit that GitHub did not like. The PR diff included both the relevant changes from that branch plus everything I merged in. @papertigers pointed out that swapping the two args produces a merge commit GitHub understands better. Happy to add a line explaining that the order matters, but it might be too much detail for this spot. The linked doc https://martinvonz.github.io/jj/latest/working-copy/ also does not explain this.
This commit is contained in:
parent
fca92f1e16
commit
bf24be20ef
2 changed files with 3 additions and 3 deletions
|
@ -44,8 +44,8 @@ use crate::ui::Ui;
|
|||
/// the new commit. This can be avoided with `--no-edit`.
|
||||
///
|
||||
/// Note that you can create a merge commit by specifying multiple revisions as
|
||||
/// argument. For example, `jj new main @` will create a new commit with the
|
||||
/// `main` bookmark and the working copy as parents.
|
||||
/// argument. For example, `jj new @ main` will create a new commit with the
|
||||
/// working copy and the `main` bookmark as parents.
|
||||
///
|
||||
/// For more information, see
|
||||
/// https://martinvonz.github.io/jj/latest/working-copy/.
|
||||
|
|
|
@ -1392,7 +1392,7 @@ Create a new, empty change and (by default) edit it in the working copy
|
|||
|
||||
By default, `jj` will edit the new change, making the working copy represent the new commit. This can be avoided with `--no-edit`.
|
||||
|
||||
Note that you can create a merge commit by specifying multiple revisions as argument. For example, `jj new main @` will create a new commit with the `main` bookmark and the working copy as parents.
|
||||
Note that you can create a merge commit by specifying multiple revisions as argument. For example, `jj new @ main` will create a new commit with the working copy and the `main` bookmark as parents.
|
||||
|
||||
For more information, see https://martinvonz.github.io/jj/latest/working-copy/.
|
||||
|
||||
|
|
Loading…
Reference in a new issue