625 commits

Author	SHA1	Message	Date
Scott Taylor	472fd35ff1	docs: rewrite conflict marker docs to include new styles ... The current docs for conflict markers start out by introducing Git "diff3" conflict markers, and then discussing how Jujutsu's conflict markers are different from Git's. I don't think this is the best way to explain it, because it requires the reader to first understand Git's conflict markers before they go on to learn Jujutsu's conflict markers. Instead, I think it's better to explain the conflict markers from scratch with a more detailed example so that we don't assume any particular knowledge of Git. This structure also works better with the new config option, since we can talk about the default option first, and then go on to explain alternatives later.	2024-11-23 08:28:47 -06:00
Lars Francke	ffe5519fd0	Update tutorial for 0.23 and clarify diffedit	2024-11-22 21:23:12 +01:00
Tim Janik	86a2a2b1e9	docs/git-compatibility.md: preserve working copy files when co-locating ... Use `jj new && jj undo` instead of `jj new @-` at the end of converting to a co-located repository, because the latter "stashes" newly added working copy changes into a sibling commit. See also: https://github.com/martinvonz/jj/discussions/4945 Signed-off-by: Tim Janik <timj@gnu.org>	2024-11-22 19:20:36 +01:00
Emily	c0a9e20222	docs: tighten the "previewing docs" section	2024-11-20 06:06:53 +01:00
Emily	cedaa5bb00	docs: migrate from poetry to uv ... Our docs are built with MkDocs, which requires Python and several deps. Previously those deps were managed with Poetry, which is also written in Python. This commit replaces Poetry with `uv`, a Rust-based Python project/package manager, and thus removes several steps from the docs build process. Before: <install Python> <install pipx> pipx install poetry poetry install poetry run -- mkdocs serve After: <install uv> uv run mkdocs serve	2024-11-20 06:06:53 +01:00
Luke Randall	068fa0f37e	revset: allow tags() to take a pattern for an argument ... This makes it more consistent with `bookmarks()`. Co-authored-by: Austin Seipp <aseipp@pobox.com>	2024-11-20 00:47:23 +00:00
Herman J. Radtke III	3be6f03938	docs: git blame comparison ... Add comparison for git blame and jj file annotate.	2024-11-19 09:58:28 -08:00
Yuya Nishihara	296961cb19	cli: git push: do not push new bookmarks by default ... If you have multiple remotes to push to, you might want to keep some changes (such as security patches) in your private fork. Git CLI has one upstream remote per branch, but jj supports multiple tracking remotes, and therefore "jj git push" can start tracking new remotes automatically. This patch makes new bookmarks not eligible for push by default. I considered adding a warning, but it's not always possible to interrupt the push shortly after a warning is emitted. --all implies --allow-new because otherwise it's equivalent to --tracked. It's also easier to write a conflict rule with --all/--deleted/--tracked than with two of them. -c/--change doesn't require --allow-new because it is the flag to create new tracking bookmark. #1278	2024-11-19 21:11:22 +09:00
Martin von Zweigbergk	a22620d30c	docs: say that support for Git's remote config is partial ... #4889	2024-11-16 17:41:08 -08:00
Tim Janik	e8bbd89ec1	docs/community_tools.md: add paragraph about jj-fzf ... Signed-off-by: Tim Janik <timj@gnu.org>	2024-11-16 23:49:03 +01:00
Tim Janik	68d4ec7f0a	docs/community_tools.md: restore alphabetical order ... Signed-off-by: Tim Janik <timj@gnu.org>	2024-11-16 23:49:03 +01:00
Martin von Zweigbergk	9fc3255238	docs: try to clarify that changes are not a first-class concept	2024-11-16 14:20:37 -08:00
Philip Metzger	eb91547e52	docs: Make the Roadmap a toplevel website entry ... This also fixes the Xethub link, by pointing it to the web archive, which no longer is available.	2024-11-16 11:11:59 +01:00
Benjamin Tan	4db4f413a7	revset: add fork_point function ... This can be used to find the fork point (best common ancestors) of a revset with an arbitrary number of commits, which cannot be expressed currently in the revset language.	2024-11-16 04:08:01 +08:00
Benjamin Tan	5a793f61d6	cli: duplicate: add --destination, --insert-after, and --insert-before options	2024-11-15 19:42:13 +08:00
Robin Stocker	560d66ecee	docs: switch all toml examples to heading notation	2024-11-14 16:29:49 +00:00
Remo Senekowitsch	a650af3fcd	completion: improve docs for activation ... It was not clear if users should activate both sets of completions if they wanted the dynamic ones. The shell commands for activating the dynamic completions are aligned with the static version. Users can choose / are responsible themselves to add the activation to their shell config if they want them in every shell instance. For fish specifically, `script | source` is more idiomatic than `source (script | psub)`.	2024-11-13 18:13:54 +01:00
Emily	7d9e9a1434	docs: remove trailing whitespace in .md	2024-11-12 01:16:08 +01:00
Emily	235d57c053	docs: beginnings of an 'editor setup' section	2024-11-12 01:16:08 +01:00
Yuya Nishihara	6739dccc6d	templater: add != operator as user would probably expect that it exists	2024-11-10 21:41:24 +09:00
Remo Senekowitsch	c9e751ae6e	completion: teach rename about local bookmarks	2024-11-10 07:26:22 +01:00
Remo Senekowitsch	db2b5890f8	util: add exec command for arbitrary aliases	2024-11-09 11:49:33 +01:00
Martin von Zweigbergk	86de9139b3	docs: fix a few typos noticed by automation at Google	2024-11-07 23:04:11 -08:00
Benjamin Tan	1372b39341	template: add support for logical equality operator	2024-11-08 01:55:18 +08:00
Tim Janik	aa040021da	docs/FAQ.md: answer monitoring jj log with watch and TUIs ... * Suggested `watch --color` as recommended by @ilyagr * Answered monitoring `jj log` with watch and TUIs * Minor wording fix. * Adjusted watch(1) and hwatch links as suggested by @ilyagr Signed-off-by: Tim Janik <timj@gnu.org>	2024-11-07 09:40:25 -08:00
Philip Metzger	7d1041c9d5	FAQ: Mention when users should use jj-lib or integrate via the CLI	2024-11-05 18:34:05 +00:00
Ilya Grigoriev	e8f722cfe1	docs config diff-editor: advertise Meld some more ... I think most people would benefit from trying both an internal and an external merge tool. I was also considering mentioning `kdiff3` or `diffedit3` more heavily. For `kdiff3`, I find its diff editing interface very confusing and I don't know of anybody who happily uses it as a diff editor. For `diffedit3`, I'm not very objective.	2024-11-04 19:14:18 -08:00
Ilya Grigoriev	4ecf75efc1	docs config diff-editor: clean up, change KDiff3 example to Meld ... I don't think recommending KDIff3 for diff editing is good advice in most cases (as opposed to merge conflict resolution, for which KDiff3 is very good). OTOH, trying Meld for diff editing is a good idea for many people. Historically, this part of the docs uses KDiff3 because it was written when `meld` was the default and `:builtin` did not exist.	2024-11-04 19:14:18 -08:00
Martin von Zweigbergk	c7cd014fe6	docs: add more detail to section about stale working copies ... We only explained that working copies can become stale when updating a commit from another workspace, but there are other cases too. I also tried to better explain what the state actually means.	2024-10-30 18:13:48 -07:00
Martin von Zweigbergk	30ab71d340	bookmarks: add support for git.auto-local-bookmark (to match docs) ... We had documented that we support `git.auto-local-bookmark` but we don't. The documentation has been incorrect since d9c68e08b1. This patch fixes it by adding support for `git.auto-local-bookmark` with fallback to the old/current `git.auto-local-branch`. .	2024-10-30 08:01:02 -07:00
SoraTenshi	fa5372f453	docs: include remote add command	2024-10-29 09:15:45 -07:00
Richard Macklin	8cdb0e4d6e	docs: Replace "first make sure..." comment with equivalent --only flag ... This part of the git-comparison table was implying you need to manually check and clear staged changes in order to only update the previous commit's message. That isn't the case, though. As mentioned in the `git-commit` documentation [1], this can be directly achieved by using the `--only` flag with `--amend`: > If this option is specified together with --amend, then no paths need > to be specified, which can be used to amend the last commit without > committing changes that have already been staged. [1]: https://git-scm.com/docs/git-commit#Documentation/git-commit.txt--o	2024-10-26 17:35:29 -07:00
Arthur Grillo	484f2fdc15	docs/config: Document where to set default templates ... The user may want to know how to change the default template used. To help this, add documentation about how to change this on the configs.	2024-10-26 14:01:18 -03:00
Emily	1a0780ebcd	docs: fix typo in Mac install section	2024-10-26 14:21:52 +02:00
Stephen Jennings	95283dd04f	docs: Simplify instructions for using private commits ... The current instructions ask the reader to convert the merge commit into a single-parent commit, then create a new merge. It is probably simpler to follow instructions for inserting a new commit before the merge commit.	2024-10-25 17:07:02 -07:00
Dave Townsend	891fa88be0	diff: Allow setting the default level of context in config.	2024-10-25 17:56:56 +01:00
Robin Stocker	5bd55f2981	docs: Fix typo in Watchman section	2024-10-22 21:00:41 +09:00
Martin von Zweigbergk	356e7b6bf2	docs: use release@origin in example of additional immutable bookmark ... The example said `maint@origin` until 670efbebfc. The name was supposed to stand for "maintenance". Let's use `release` instead to make it clearer.	2024-10-21 13:01:25 -07:00
Vincent Ging Ho Yim	1c28498f59	docs: fix typos in immutable_heads() example	2024-10-21 20:35:10 +11:00
Yuya Nishihara	5dd6185fbc	templater: make "git_head" return boolean, render it as "git_head()" ... For the same reason as the root revision is indicated by "root()".	2024-10-21 09:21:34 +09:00
Yuya Nishihara	3d31928dac	revset: drop support for HEAD@git symbol resolution ... This was added at f5f61f6bfe "revset: resolve 'HEAD@git' just like other pseudo @git branches." As I said in this patch, there was no practical use case of the HEAD@git symbol. Suppose we implement colocated workspaces/worktrees #4436, there may be multiple Git HEAD revisions. This means HEAD can no longer be abstracted as a symbol of the "git" remote.	2024-10-21 09:21:34 +09:00
Yuya Nishihara	009284736d	templater: add pad/truncate functions ... As I said in the preceding patch, I settled on separate pad/truncate functions instead of a function taking multiple optional parameters. It's less efficient to process truncation and padding independently, but I don't think that would matter. The order of arguments follows the current f(..., content) convention. We can also add a method syntax, but I'm not sure if it's useful. In order to call a method of Template type, we'll need to coerce printable object to Template: concat(author.email()).truncate_end(10).pad_end(10) ^^^^^^ String -> Template FWIW, String type could provide more efficient truncate/pad methods. Closes #3183	2024-10-21 08:47:08 +09:00
Martin von Zweigbergk	e00f6f121e	docs: mention that that Rust 1.76 is required to install from source ... We have our MSRV recorded in `Cargo.toml`, but at least with Rust versions < 1.71, the build fails before the MSRV is checked (IIUC), and you get a cryptic message like this: ``` error: Package jj-lib v0.22.0 (<some path>) does not have feature git2. ``` The message is clearer from 1.71, but that doesn't help users who have an older version. Let's mention the MSRV everywhere we tell the user to run `cargo` in the installation instructions.	2024-10-19 15:50:34 -07:00
Martin von Zweigbergk	9e80d0c51d	docs: update immutable_heads() examples to use builtin_immutable_heads() ... Users should generally use `builtin_immutable_heads()` when they override `immutable_heads()`, so this patch updates the existing example to use that. I also added another example showing how to make an additional remote-tracking bookmark immutable.	2024-10-16 13:59:30 -07:00
Ilya Grigoriev	166cdd0e5e	docs git-comparison: add shorthands for some bookmark commands ... I don't want people to think they'll have to type out the long version, at least for the most common ones.	2024-10-16 10:54:46 -07:00
Ilya Grigoriev	9291ae4aed	docs git-comparison: bookmark set -> bookmark move	2024-10-16 10:54:46 -07:00
Ilya Grigoriev	b795bf9562	docs glossary & git-comparison: fixup & update bookmark->branch transition ... This fixes up git-comparison.md. The changes to the glossary could be moved to a separate commit/PR.	2024-10-15 23:29:11 -07:00
Benjamin Tan	0f605b8aae	templates: Timestamp: add after, before methods ... This allows for more fine-grained control of timestamp formatting, for example: ``` [template-aliases] 'format_timestamp(timestamp)' = ''' if(timestamp.before("1 week ago"), timestamp.format("%b %d %Y %H:%M"), timestamp.ago() ) ''' ``` Closes #3782.	2024-10-16 13:46:06 +08:00
Benjamin Tan	8e817bc24b	revset: add coalesce(revsets...) ... The `coalesce` function takes a list of revsets and returns the commits in the first revset in the list which evalutes to a non-empty set of commits. It can be used to display fallbacks if a certain commit cannot be found, e.g. `coalesce(present(user_configured_trunk), builtin_trunk)`.	2024-10-16 10:36:27 +08:00
Vincent Ging Ho Yim	e415c09ede	docs/FAQ: fix incorrect change ID for commit removed as parent	2024-10-16 09:50:04 +11:00