From 7d9e9a143447c94cb062c0e03ee7e8aa7f9f964f Mon Sep 17 00:00:00 2001 From: Emily Date: Sun, 10 Nov 2024 06:21:24 +0100 Subject: [PATCH] docs: remove trailing whitespace in .md --- CHANGELOG.md | 2 +- docs/FAQ.md | 2 +- docs/bookmarks.md | 16 ++++++++-------- docs/glossary.md | 2 +- 4 files changed, 11 insertions(+), 11 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index a2d821e76..34cf8a853 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -122,7 +122,7 @@ to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). * Error on `trunk()` revset resolution is now handled gracefully. [#4616](https://github.com/martinvonz/jj/issues/4616) -* Updated the built-in diff editor `scm-record` to version +* Updated the built-in diff editor `scm-record` to version [0.4.0](https://github.com/arxanas/scm-record/releases/tag/v0.4.0), which includes multiple fixes. diff --git a/docs/FAQ.md b/docs/FAQ.md index a282ecf8e..2e542a21b 100644 --- a/docs/FAQ.md +++ b/docs/FAQ.md @@ -329,7 +329,7 @@ There are some trade-offs and there is no definitive answer yet. * Using `jj-lib` avoids parsing command output and makes error handling easier. * `jj-lib` is not a stable API, so you may have to make changes to your tool when the API changes. -* The CLI is not stable either, so you may need to make your tool detect the +* The CLI is not stable either, so you may need to make your tool detect the different versions and call the right command. * Using the CLI means that your tool will work with custom-built `jj` binaries, like the one at Google (if you're using the library, you will not be able to diff --git a/docs/bookmarks.md b/docs/bookmarks.md index 7b2581eb5..a3148ec7c 100644 --- a/docs/bookmarks.md +++ b/docs/bookmarks.md @@ -59,7 +59,7 @@ target there, `jj log` will show the bookmark name with an asterisk suffix (e.g. `main*`). That is meant to remind you that you may want to push the bookmark to some remote. -If you want to know the internals of bookmark tracking, consult the +If you want to know the internals of bookmark tracking, consult the [Design Doc][design]. ### Terminology summary @@ -85,9 +85,9 @@ must match. ### Manually tracking a bookmark -To track a bookmark permanently use `jj bookmark track @`. +To track a bookmark permanently use `jj bookmark track @`. It will now be imported as a local bookmark until you untrack it or it is deleted -on the remote. +on the remote. Example: @@ -110,7 +110,7 @@ To stop following a remote bookmark, you can `jj bookmark untrack` it. After tha subsequent fetches of that remote will no longer move the local bookmark to match the position of the remote bookmark. -Example: +Example: ```sh $ # List all local and remote bookmarks. @@ -141,7 +141,7 @@ marked as tracked. By default, every other remote bookmark is marked as "not tracked" when it's fetched. If desired, you need to manually `jj bookmark track` them. This works -well for repositories where multiple people work on a large number of bookmarks. +well for repositories where multiple people work on a large number of bookmarks. The default can be changed by setting the config `git.auto-local-bookmark = true`. Then, `jj git fetch` tracks every *newly fetched* bookmark with a local bookmark. @@ -154,13 +154,13 @@ bookmarks) by default. Currently Jujutsu automatically moves local bookmarks when these conditions are met: - * When a commit has been rewritten (e.g, when you rebase) bookmarks and the + * When a commit has been rewritten (e.g, when you rebase) bookmarks and the working-copy will move along with it. - * When a commit has been abandoned, all associated bookmarks will be moved + * When a commit has been abandoned, all associated bookmarks will be moved to its parent(s). If a working copy was pointing to the abandoned commit, then a new working-copy commit will be created on top of the parent(s). -You could describe the movement as following along the change-id of the +You could describe the movement as following along the change-id of the current bookmark commit, even if it isn't entirely accurate. ## Pushing bookmarks: Safety checks diff --git a/docs/glossary.md b/docs/glossary.md index b0ac215a7..560d969c8 100644 --- a/docs/glossary.md +++ b/docs/glossary.md @@ -29,7 +29,7 @@ for details. Unlike in Git, there is no concept of a "current bookmark"; bookmarks *do not* move when you create a new commit. Bookmarks *do* automatically follow the -commit if it gets [rewritten](#rewrite). +commit if it gets [rewritten](#rewrite). ## Branch