Skip to content

Commit 5aee657

Browse files
committed
colocation docs: reflow some paragraphs
There was an annoying extra line in the CLI help. I fixed up that and a few additional paragraphs. Fixup to c32b476
1 parent 5597ea2 commit 5aee657

File tree

3 files changed

+26
-29
lines changed

3 files changed

+26
-29
lines changed

cli/src/commands/git/clone.rs

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -78,9 +78,8 @@ pub struct GitCloneArgs {
7878
/// Disable colocation of the Jujutsu repo with the git repo
7979
///
8080
/// Prevent Git tools that are unaware of `jj` and regular Git commands from
81-
/// operating on the repo. The Git repository that stores most of the
82-
/// repo data will be hidden inside a sub-directory of the `.jj`
83-
/// directory.
81+
/// operating on the repo. The Git repository that stores most of the repo
82+
/// data will be hidden inside a sub-directory of the `.jj` directory.
8483
///
8584
/// See [colocation docs] for some minor advantages of non-colocated repos.
8685
///

cli/src/commands/git/init.rs

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -77,9 +77,8 @@ pub struct GitInitArgs {
7777
/// Disable colocation of the Jujutsu repo with the git repo
7878
///
7979
/// Prevent Git tools that are unaware of `jj` and regular Git commands from
80-
/// operating on the repo. The Git repository that stores most of the
81-
/// repo data will be hidden inside a sub-directory of the `.jj`
82-
/// directory.
80+
/// operating on the repo. The Git repository that stores most of the repo
81+
/// data will be hidden inside a sub-directory of the `.jj` directory.
8382
///
8483
/// See [colocation docs] for some minor advantages of non-colocated repos.
8584
///

docs/git-compatibility.md

Lines changed: 22 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -61,9 +61,9 @@ a comparison with Git, including how workflows are different, see the
6161
* **Submodules: No.** They will not show up in the working copy, but they will
6262
not be lost either.
6363
* **Partial clones: No.**
64-
* **Shallow clones: Kind of.** Shallow commits all have the virtual root commit as
65-
their parent. However, deepening or fully unshallowing a repository is currently not yet
66-
supported and will cause issues.
64+
* **Shallow clones: Kind of.** Shallow commits all have the virtual root commit
65+
as their parent. However, deepening or fully unshallowing a repository is
66+
currently not yet supported and will cause issues.
6767
* **git-worktree: No.** However, there's native support for multiple working
6868
copies backed by a single repo. See the `jj workspace` family of commands.
6969
* **Sparse checkouts: No.** However, there's native support for sparse
@@ -82,13 +82,13 @@ a `.jj` directory and a `.git` directory.
8282

8383
## Creating a repo backed by an existing Git repo
8484

85-
To create a Jujutsu repo backed by a Git repo you already have on disk, use
86-
`jj git init --git-repo=<path to Git repo> <name>`. The repo will work similar
87-
to a [Git worktree](https://git-scm.com/docs/git-worktree), meaning that the
88-
working copies files and the record of the working-copy commit will be separate,
89-
but the commits will be accessible in both repos. Use `jj git import` to update
90-
the Jujutsu repo with changes made in the Git repo. Use `jj git export` to
91-
update the Git repo with changes made in the Jujutsu repo.
85+
To create a Jujutsu repo backed by a Git repo you already have on disk, use `jj
86+
git init --git-repo=<path to Git repo> <name>`. The repo will work similar to a
87+
[Git worktree](https://git-scm.com/docs/git-worktree), meaning that the working
88+
copies files and the record of the working-copy commit will be separate, but the
89+
commits will be accessible in both repos. Use `jj git import` to update the
90+
Jujutsu repo with changes made in the Git repo. Use `jj git export` to update
91+
the Git repo with changes made in the Jujutsu repo.
9292

9393
## Creating a repo by cloning a Git repo
9494

@@ -97,16 +97,15 @@ To create a Jujutsu repo from a remote Git URL, use `jj git clone <URL>
9797
https://github.com/octocat/Hello-World` will clone GitHub's "Hello-World" repo
9898
into a directory by the same name.
9999

100-
By default, the remote repository will be named `origin`. You can use
101-
a name of your choice by adding `--remote <remote name>` to the `jj
102-
git clone` command.
100+
By default, the remote repository will be named `origin`. You can use a name of
101+
your choice by adding `--remote <remote name>` to the `jj git clone` command.
103102

104103
## <a name="co-located-jujutsugit-repos"></a>Colocated Jujutsu/Git repos
105104

106-
A colocated Jujutsu repo is a hybrid Jujutsu/Git repo. This is the default
107-
for Git-backed repositories created with `jj git init` or `jj git clone`.
108-
The Git repo and the Jujutsu repo then share the same working copy. Jujutsu will
109-
import and export from and to the Git repo on every `jj` command automatically.
105+
A colocated Jujutsu repo is a hybrid Jujutsu/Git repo. This is the default for
106+
Git-backed repositories created with `jj git init` or `jj git clone`. The Git
107+
repo and the Jujutsu repo then share the same working copy. Jujutsu will import
108+
and export from and to the Git repo on every `jj` command automatically.
110109

111110
This mode is very convenient when tools (e.g. build tools) expect a Git repo to
112111
be present.
@@ -144,13 +143,13 @@ Colocation can be disabled because it does have some disadvantages:
144143

145144
* In colocated repos with a very large number of branches or other refs, `jj`
146145
commands can get noticeably slower because of the automatic `jj git import`
147-
executed on each command. This can be mitigated by occasionally running `jj util
148-
gc` to speed up the import (that command includes packing the Git refs).
146+
executed on each command. This can be mitigated by occasionally running `jj
147+
util gc` to speed up the import (that command includes packing the Git refs).
149148

150-
* Git tools will have trouble with revisions that contain conflicted files. While
151-
`jj` renders these files with conflict markers in the working copy, they are
152-
stored in a non-human-readable fashion inside the repo. Git tools will often
153-
see this non-human-readable representation.
149+
* Git tools will have trouble with revisions that contain conflicted files.
150+
While `jj` renders these files with conflict markers in the working copy, they
151+
are stored in a non-human-readable fashion inside the repo. Git tools will
152+
often see this non-human-readable representation.
154153

155154
* When a `jj` branch is conflicted, the position of the branch in the Git repo
156155
will disagree with one or more of the conflicted positions. The state of that

0 commit comments

Comments
 (0)