mirror of
https://github.com/jj-vcs/jj.git
synced 2025-12-23 06:01:01 +00:00
docs: fix MD012 markdown lint
[MD012](https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md012.md): Multiple consecutive blank lines
This commit is contained in:
xtqqczze
parent
a88b119e4d
commit
f357791541
20 changed files with 0 additions and 50 deletions
|
|
@ -877,7 +877,6 @@ Thanks to the people who made this release happen!
|
|||
* Vincent Ging Ho Yim (@cenviity)
|
||||
* Yuya Nishihara (@yuja)
|
||||
|
||||
|
||||
## [0.30.0] - 2025-06-04
|
||||
|
||||
### Release highlights
|
||||
|
|
@ -1916,7 +1915,6 @@ Thanks to the people who made this release happen!
|
|||
|
||||
* `jj config unset <TABLE-NAME>` no longer removes a table (such as `[ui]`.)
|
||||
|
||||
|
||||
### Contributors
|
||||
|
||||
Thanks to the people who made this release happen!
|
||||
|
|
@ -4387,7 +4385,6 @@ No changes, only trying to get the automated build to work.
|
|||
|
||||
Last release before this changelog started.
|
||||
|
||||
|
||||
[unreleased]: https://github.com/jj-vcs/jj/compare/v0.36.0...HEAD
|
||||
[0.36.0]: https://github.com/jj-vcs/jj/compare/v0.35.0...v0.36.0
|
||||
[0.35.0]: https://github.com/jj-vcs/jj/compare/v0.34.0...v0.35.0
|
||||
|
|
|
|||
|
|
@ -54,7 +54,6 @@ exclusively limited to):
|
|||
- Practicing transparency in the project, communicating decisions and their
|
||||
rationale when appropriate.
|
||||
|
||||
|
||||
This is not an exhaustive list, nor is it intended that every Maintainer does
|
||||
each and every one of these individual tasks to equal amounts. Rather this is
|
||||
only a guideline for what Maintainers are expected to conceptually do.
|
||||
|
|
|
|||
|
|
@ -489,7 +489,6 @@ $ jj diff --from b80 --to @- # No output means these are identical
|
|||
$ jj diff --from 31a --to @ # No output means these are identical
|
||||
```
|
||||
|
||||
|
||||
### How do I resume working on an existing change?
|
||||
|
||||
There are two ways to resume working on an earlier change: `jj new` then `jj squash`,
|
||||
|
|
|
|||
|
|
@ -1,6 +1,5 @@
|
|||
# Bookmarks
|
||||
|
||||
|
||||
## Introduction
|
||||
|
||||
Bookmarks are named pointers to revisions (just like branches are in Git). You
|
||||
|
|
@ -131,7 +130,6 @@ This command omits local Git-tracking bookmarks by default.
|
|||
|
||||
You can see if a specific bookmark is tracked with `jj bookmark list --tracked <bookmark name>`.
|
||||
|
||||
|
||||
### Automatic tracking of bookmarks & `auto-track-bookmarks` option
|
||||
|
||||
There are two situations where `jj` tracks bookmarks automatically. `jj git
|
||||
|
|
@ -199,7 +197,6 @@ makes several safety checks.
|
|||
[^known-issue]: See "A general note on safety" in
|
||||
<https://git-scm.com/docs/git-push#Documentation/git-push.txt---no-force-with-lease>
|
||||
|
||||
|
||||
## Conflicts
|
||||
|
||||
Bookmarks can end up in a conflicted state. When that happens, `jj status` will
|
||||
|
|
|
|||
|
|
@ -12,7 +12,6 @@
|
|||
|
||||
If you see a significant difference, feel free to file a bug, or a PR to note the difference here.
|
||||
|
||||
|
||||
{%
|
||||
include-markdown "../cli/tests/cli-reference@.md.snap"
|
||||
rewrite-relative-urls=false
|
||||
|
|
|
|||
|
|
@ -2,7 +2,6 @@
|
|||
|
||||
These are the config settings available to jj/Jujutsu.
|
||||
|
||||
|
||||
## Config files and TOML
|
||||
|
||||
`jj` loads several types of config settings:
|
||||
|
|
@ -73,7 +72,6 @@ then use whichever suits you in your config. If you mix dotted keys and headings
|
|||
That's probably enough TOML to keep you out of trouble but the [syntax guide] is
|
||||
very short if you ever need to check.
|
||||
|
||||
|
||||
## User settings
|
||||
|
||||
```toml
|
||||
|
|
@ -494,7 +492,6 @@ you can add this to your config:
|
|||
config_list = "builtin_config_list_detailed"
|
||||
```
|
||||
|
||||
|
||||
## Log
|
||||
|
||||
### Default revisions
|
||||
|
|
@ -808,7 +805,6 @@ show-ruler = true # (default)
|
|||
show-ruler = false
|
||||
```
|
||||
|
||||
|
||||
### Processing contents to be paged
|
||||
|
||||
If you'd like to pass the output through a formatter e.g.
|
||||
|
|
@ -974,7 +970,6 @@ diff-editor = ["/path/to/binary", "--be-helpful", "$left", "$right"]
|
|||
diff-editor = "binary"
|
||||
```
|
||||
|
||||
|
||||
### Experimental 3-pane diff editing
|
||||
|
||||
We offer two special "3-pane" diff editor configs:
|
||||
|
|
@ -1030,7 +1025,6 @@ With that configuration, you should be able to simply `ssh myhost`.
|
|||
|
||||
</details>
|
||||
|
||||
|
||||
Setting either `ui.diff-editor = "meld-3"` or `ui.diff-editor = "diffedit3"`
|
||||
will result in the diff editor showing 3 panes: the diff on the left and right,
|
||||
and an editing pane in the middle. This allow you to see both sides of the
|
||||
|
|
|
|||
|
|
@ -1,6 +1,5 @@
|
|||
# First-class conflicts
|
||||
|
||||
|
||||
## Introduction
|
||||
|
||||
Conflicts happen when Jujutsu can't figure out how to merge different changes
|
||||
|
|
@ -18,7 +17,6 @@ logical representation of the conflict, not conflict *markers*; rebasing a
|
|||
conflict doesn't result in a nested conflict markers (see
|
||||
[technical doc](technical/conflicts.md) for how this works).
|
||||
|
||||
|
||||
## Advantages
|
||||
|
||||
The deeper understanding of conflicts has many advantages:
|
||||
|
|
@ -53,7 +51,6 @@ The deeper understanding of conflicts has many advantages:
|
|||
For information about how conflicts are handled in the working copy, see
|
||||
[here](working-copy.md#conflicts).
|
||||
|
||||
|
||||
## Conflict markers
|
||||
|
||||
Conflicts are "materialized" using *conflict markers* in various contexts. For
|
||||
|
|
|
|||
|
|
@ -1,6 +1,5 @@
|
|||
# How to Contribute
|
||||
|
||||
|
||||
## Policies
|
||||
|
||||
We'd love to accept your patches and contributions to this project. There are
|
||||
|
|
@ -203,7 +202,6 @@ These are listed roughly in order of decreasing importance.
|
|||
On Linux, you may be able to speed up `nextest` even further by using
|
||||
the `mold` linker, as explained below.
|
||||
|
||||
|
||||
### Configuring `jj fix` to run `rustfmt`
|
||||
|
||||
Run this in the jj repo:
|
||||
|
|
@ -558,7 +556,6 @@ served from. This bug should now be fixed, but if you are not serving the site
|
|||
from <https://docs.jj-vcs.dev/> and something fails weirdly, you might want
|
||||
to adjust the `site_url` to something like `https://jjfan.github.io/jj`.
|
||||
|
||||
|
||||
## Modifying protobuffers (this is not common)
|
||||
|
||||
Occasionally, you may need to change the `.proto` files that define jj's data
|
||||
|
|
|
|||
|
|
@ -76,7 +76,6 @@ $ jj rebase -r C -o A
|
|||
$ jj rebase -r C -o B # Takes us back to the state above
|
||||
```
|
||||
|
||||
|
||||
#### Reverting the parent commit should be a no-op
|
||||
|
||||
Patches should be reversible so you can make a change and then revert it, and
|
||||
|
|
@ -542,7 +541,6 @@ A add foo
|
|||
$ jj rebase -r C -o A
|
||||
```
|
||||
|
||||
|
||||
```console
|
||||
$ jj log
|
||||
C rename foo->baz
|
||||
|
|
@ -655,7 +653,6 @@ $ jj new D E -m F
|
|||
|
||||
If F is empty (auto-merged), it should have the same state as E before.
|
||||
|
||||
|
||||
### Log
|
||||
|
||||
The copy graph contains all past paths and copy IDs of a file, so when doing
|
||||
|
|
@ -838,7 +835,6 @@ doing the conflict algebra we currently do. That means that things like
|
|||
parallelizing commits and then serializing them again would lose copy
|
||||
information.
|
||||
|
||||
|
||||
[same_change_rule]: https://github.com/martinvonz/jj/blob/560d66ecee5a9904b42dbc0b89333f0c27c683de/lib/src/merge.rs#L98-L111
|
||||
|
||||
[^martinvonz_slow]: This took me (@martinvonz) months to really understand.
|
||||
|
|
|
|||
|
|
@ -4,7 +4,6 @@ Authors: [Philip Metzger](mailto:philipmetzger@bluewin.ch), [Martin von Zweigber
|
|||
|
||||
Initial Version, 10.12.2022 (view full history [here](https://docs.google.com/document/d/14BiAoEEy_e-BRPHYpXRFjvHMfgYVKh-pKWzzTDi-v-g/edit))
|
||||
|
||||
|
||||
**Summary:** This Document documents the design of a new `run` command for
|
||||
Jujutsu which will be used to seamlessly integrate with build systems, linters
|
||||
and formatters. This is achieved by running a user-provided command or script
|
||||
|
|
@ -211,7 +210,6 @@ to a server. We might choose to defer any handling of this to the
|
|||
implementation of the command being invoked, instead of trying to
|
||||
communicate that information to jj.
|
||||
|
||||
|
||||
## Command Options
|
||||
|
||||
The base command of any jj command should be usable. By default `jj run` works
|
||||
|
|
@ -240,7 +238,6 @@ command)
|
|||
[#963][issue]
|
||||
`jj undo/jj op revert`: No special handling needed
|
||||
|
||||
|
||||
## Open Points
|
||||
|
||||
Should the command be working copy backend specific?
|
||||
|
|
@ -260,8 +257,6 @@ to Bazel's `select(..., message = "arch not supported for $project")`.
|
|||
- Make `jj run` asynchronous by spawning a `main` process, directly return to the
|
||||
user and incrementally updating the output of `jj st`.
|
||||
|
||||
|
||||
|
||||
[git-branchless]: https://github.com/arxanas/git-branchless
|
||||
[issue]: https://github.com/jj-vcs/jj/issues/963
|
||||
[fix-src]: https://repo.mercurial-scm.org/hg/file/tip/hgext/fix.py
|
||||
|
|
|
|||
|
|
@ -18,7 +18,6 @@ Jujutsu, you'll need to go through this process.
|
|||
1. Wait for the Maintainers and Stakeholders to show up.
|
||||
1. Iterate until everyone accepts the change in normal codereview fashion.
|
||||
|
||||
|
||||
[Rust RFCs]: https://github.com/rust-lang/rfcs
|
||||
|
||||
## Blueprint (Template)
|
||||
|
|
|
|||
|
|
@ -7,7 +7,6 @@ This document attempts to describe how Jujutsu is different from Git. See
|
|||
the `jj` command interoperates with Git repos. See
|
||||
[the Git command table](git-command-table.md) for a table of similar commands.
|
||||
|
||||
|
||||
## Overview
|
||||
|
||||
Here is a list of conceptual differences between Jujutsu and Git, along with
|
||||
|
|
@ -91,5 +90,4 @@ changes into the parent commit, which you might normally use
|
|||
choose which changes to move into the parent commit, or `jj squash <file>` to
|
||||
move a specific file.
|
||||
|
||||
|
||||
[evil merges]: https://git-scm.com/docs/gitglossary#Documentation/gitglossary.txt-evilmerge
|
||||
|
|
|
|||
|
|
@ -8,7 +8,6 @@ See `jj help git` for help about the `jj git` family of commands, and e.g.
|
|||
`jj help git push` for help about a specific command (use `jj git push -h` for
|
||||
briefer help).
|
||||
|
||||
|
||||
## Supported features
|
||||
|
||||
The following list describes which Git features Jujutsu is compatible with. For
|
||||
|
|
@ -72,7 +71,6 @@ a comparison with Git, including how workflows are different, see the
|
|||
or use the `jj sign` command.
|
||||
* **Git LFS: No.** ([#80](https://github.com/jj-vcs/jj/issues/80))
|
||||
|
||||
|
||||
## Creating an empty repo
|
||||
|
||||
To create an empty repo using the Git backend, use `jj git init <name>`. This
|
||||
|
|
@ -223,7 +221,6 @@ jj new && jj undo
|
|||
|
||||
TODO: Describe how branches are mapped
|
||||
|
||||
|
||||
## Format mapping details
|
||||
|
||||
Paths are assumed to be UTF-8. I have no current plans to support paths with
|
||||
|
|
|
|||
|
|
@ -1,6 +1,5 @@
|
|||
# Installation and setup
|
||||
|
||||
|
||||
## Installation
|
||||
|
||||
### Download pre-built binaries for a release
|
||||
|
|
@ -186,7 +185,6 @@ via scoop:
|
|||
scoop install main/jj
|
||||
```
|
||||
|
||||
|
||||
## Initial configuration
|
||||
|
||||
You may want to configure your name and email so commits are made in your name.
|
||||
|
|
@ -321,7 +319,6 @@ Insert the above into your `$PROFILE` file
|
|||
the [execution policy][ExecutionPolicies] needs to be set to `RemoteSigned`
|
||||
at minimum.
|
||||
|
||||
|
||||
[cargo-binstall]: https://github.com/cargo-bins/cargo-binstall
|
||||
[clap]: https://github.com/clap-rs/clap/issues/3166
|
||||
[Homebrew]: https://brew.sh/
|
||||
|
|
|
|||
|
|
@ -1,6 +1,5 @@
|
|||
# Operation log
|
||||
|
||||
|
||||
## Introduction
|
||||
|
||||
Jujutsu records each operation that modifies the repo in the "operation log".
|
||||
|
|
@ -26,7 +25,6 @@ The following operators are supported:
|
|||
* `x-`: Parents of `x` (e.g. `@-`)
|
||||
* `x+`: Children of `x`
|
||||
|
||||
|
||||
## Divergent operations
|
||||
|
||||
One benefit of the operation log (and the reason for its creation) is that it
|
||||
|
|
@ -44,7 +42,6 @@ then also update the contents of the change (maybe because you had forgotten the
|
|||
editor). When you eventually close your editor, the command will succeed and
|
||||
e.g. `jj log` will indicate that the change has diverged.
|
||||
|
||||
|
||||
## Loading an old version of the repo
|
||||
|
||||
The top-level `--at-operation/--at-op` option allows you to load the repo at a
|
||||
|
|
|
|||
|
|
@ -81,7 +81,6 @@ Publish each crate:
|
|||
(cd cli && cargo publish)
|
||||
```
|
||||
|
||||
|
||||
[^1]: We recommend publishing from a new clone because `cargo publish` will
|
||||
archive ignored files if they match the patterns in `[include]`
|
||||
([example](https://github.com/jj-vcs/jj/blob/b95628c398c6c3d11f41bdf53d0aef11f92ee96d/lib/Cargo.toml#L15-L22)),
|
||||
|
|
|
|||
|
|
@ -632,7 +632,6 @@ jj log -r 'tags() | bookmarks()'
|
|||
Show local commits leading up to the working copy, as well as descendants of
|
||||
those commits:
|
||||
|
||||
|
||||
```shell
|
||||
jj log -r '(remote_bookmarks()..@)::'
|
||||
```
|
||||
|
|
|
|||
|
|
@ -82,7 +82,6 @@ We have talked about somehow using content-defined chunking (CDC) to reduce
|
|||
storage and transfer costs for large files. Maybe we will store files in our
|
||||
future cloud-based server using the same model as [XetHub][xet-storage].
|
||||
|
||||
|
||||
[api-design-doc]: https://docs.google.com/document/d/1rOKvutee5TVYpFhh_UDNZDxfUKyrJ8rjCNpFaNHOHwU/edit?usp=sharing&resourcekey=0-922ApyoAjuXN_uTKqmCqjg
|
||||
[copy-design-doc]: design/copy-tracking.md
|
||||
[gg]: https://github.com/gulbanana/gg
|
||||
|
|
|
|||
|
|
@ -60,7 +60,6 @@ should be safe, concurrent modification of a repository from different computers
|
|||
might conceivably lose some bookmark pointers. Note that, unlike in pure
|
||||
Git, losing a bookmark pointer does not lead to losing commits.
|
||||
|
||||
|
||||
## Operation log
|
||||
|
||||
The most important piece in the lock-free design is the "operation log". That is
|
||||
|
|
|
|||
|
|
@ -1,6 +1,5 @@
|
|||
# Working copy
|
||||
|
||||
|
||||
## Introduction
|
||||
|
||||
The working copy is where the current working-copy commit's files are written so
|
||||
|
|
@ -29,7 +28,6 @@ You can use `jj file untrack` to untrack a file while keeping it in the working
|
|||
copy. However, first [ignore](#ignored-files) them or remove them from the
|
||||
`snapshot.auto-track` patterns; otherwise they will be immediately tracked again.
|
||||
|
||||
|
||||
## Conflicts
|
||||
|
||||
When you check out a commit with conflicts, those conflicts need to be
|
||||
|
|
@ -59,7 +57,6 @@ resolving conflicts between directories, files, and symlinks
|
|||
one side of the conflict, but there's no way to even see where the involved
|
||||
parts came from.
|
||||
|
||||
|
||||
## Ignored files
|
||||
|
||||
You probably don't want build outputs and temporary files to be under version
|
||||
|
|
@ -74,7 +71,6 @@ Ignored files are never tracked automatically (regardless of the value of
|
|||
even if they match ignore patterns. You can untrack such files with the
|
||||
`jj file untrack` command.
|
||||
|
||||
|
||||
## Workspaces
|
||||
|
||||
You can have multiple working copies backed by a single repo. Use
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue