603 commits

Author	SHA1	Message	Date
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
Lukas Wirth	802e3db27e	git_backend: Support shallow git repositories	2024-10-14 20:01:08 +02:00
Vamsi Avula	92103f4db2	formatters: implement raw() for FormatRecorder ... This adds `raw_escape_sequence(...)` support for things that use FormatRecorder like wrapped text / `fill(...)` / `indent(...)`. Change-Id: Id00000004248b10feb2acd54d90115b783fac0ff	2024-10-13 12:02:40 +05:30
Vamsi Avula	fb93394610	templates: add raw_escape_sequence ... Templates can be formatted (using labels) and are usually sanitized (unless for plain text output). `raw_escape_sequence(content)` bypasses both. ```toml 'hyperlink(url, text)' = ''' raw_escape_sequence("\e]8;;" ++ url ++ "\e\\") ++ text ++ raw_escape_sequence("\e]8;;\e\\") ''' ``` In this example, `raw_escape_sequence` not only outputs the intended escape codes, it also strips away any escape codes that might otherwise be part of the `url` (from any labels attached to the `url` content). Not all formatters (namely FormatRecorder) are supported yet. Change-Id: Id00000004492dbf39e50f3b7090706839d1d8d45	2024-10-13 12:02:40 +05:30
Vamsi Avula	a6aa25c9eb	templates: support hex bytes in string literals ... One particular use case for these is escape sequences -- and to that end, I'm also adding `\e` as a shorthand for `\x1b`. Change-Id: Id000000040ea6fd8e2d720219931485960c570dd	2024-10-13 12:02:40 +05:30
Yuya Nishihara	f166fd0726	revset: add at_operation(op, expression) ... This can be used in order to refer old working-copy commit, for example. If we find it's useful, maybe we can add an infix syntax later. Closes #1283	2024-10-12 07:57:55 +09:00
Yuya Nishihara	c6568787f3	cli: warn if trunk() alias cannot be resolved, fall back to none() ... This patch replaces all call sites with present(trunk()), and adds an explicit check for unresolvable trunk(). If we add coalesce() expression, maybe it can be rewritten to coalesce(present(trunk()), builtin_trunk()). Fixes #4616	2024-10-11 09:37:47 +09:00
Martin von Zweigbergk	b2e4854a43	docs: explain a bit about good commit messages ... We didn't have any guidelines about what to include in a commit message. Others have already written good guides for that. This commit adds a link to one. I also added a sentence about explaining the reason for a change, since I think that's particularly often missed (I'm sure I also miss it sometimes - don't hesitate to point out when that happens).	2024-10-07 17:02:49 -07:00
Martin von Zweigbergk	71b60a3102	docs: clarify that commit messages start with a topic, not a component ... It's generally more useful to say something like "revset: use Self to refer to expressions of the same type" than "lib: use Self to refer to revset expressions of the same type ", so let's try to clarify that.	2024-10-07 17:02:49 -07:00
Fedor Sheremetyev	cacd6a3fd0	docs: add link to VisualJJ	2024-10-05 01:18:52 -07:00
Martin von Zweigbergk	801b243678	docs: mention snapshot.auto-track in config.md too ... I forgot to add the `snapshot.auto-track` config option to `config.md` when I added it. This patch copies it from `working-copy.md` and modifies it slightly.	2024-10-04 12:42:22 -07:00
Theodore Ehrenborg	3d26af876f	docs: update stale references to singular file() revset	2024-10-03 22:39:42 +02:00
Samuel Tardieu	acdc42fd9f	doc: add comment to explain the syntax of folded examples	2024-10-02 19:37:18 +02:00
Martin von Zweigbergk	f8e30fb1de	bookmarks: update docs to try to clarify mapping to Git branches ... I also removed a few instances suggesting that we might map bookmarks to something else in Git in the future (I don't think we have any such plans).	2024-10-01 06:46:32 -07:00
Yuya Nishihara	0a8d8dad67	cli: make default log revset work without working-copy commit ... Spotted while adding an error propagation path from IdPrefixContext.	2024-10-01 20:04:06 +09:00
Samuel Tardieu	baf25ba482	unsquash: deprecate in favor of squash and diffedit ... Everything that could be done with `jj unsquash` can be done with `jj squash` or `jj diffedit --preserve-descendants`.	2024-09-26 16:34:48 +02:00
Essien Ita Essien	895d53f395	Rename conflict and file revsets to conflicts and files. ... See discussion thread in linked issue. With this PR, all revset functions in [BUILTIN_FUNCTION_MAP](8d166c7642/lib/src/revset.rs (L570)) that return multiple values are either named in plural or the naming is hard to misunderstand (e.g. `reachable`) Fixes: #4122	2024-09-24 20:02:49 +01:00
Yuya Nishihara	b8f8827914	docs: add some scripting template examples ... Closes #4357	2024-09-22 07:19:50 +09:00
Vamsi Avula	a2e67bdd9b	templates: add .normal_hex() for {Commit,Change}Id ... This doesn't do much for CommitId but outputs the "forward" hex for ChangeId, which can be useful to use as Gerrit Change-Id.	2024-09-17 21:11:00 -05:00
Samuel Tardieu	05c6d62c68	bookmark: add "b" alias ... `jj bookmark` is a frequently used command. Its subcommands already have one letter aliases. Defining `jj b` as an alias for `jj bookmarks` make bookmarks really easy to use.	2024-09-17 18:24:26 +02:00
Ilya Grigoriev	5bd7588738	contributing.md: make MkDocs happier with a link	2024-09-16 16:44:31 -07:00
Samuel Tardieu	6e72b1cfb0	git: add --remote option to clone command ... This makes it easier to work with multiple remotes at once while tracking the default branch of the remote used to create the local repository: ```shell $ jj git clone --remote upstream https://github.com/upstream-org/repo $ cd repo $ jj git remote add origin git@github.com:your-org/repo $ jj config set --repo git.fetch upstream ``` In the example above, `upstream` is the repository containing the reference source code that you might want to patch, while `origin` is your fork where pull-request will be pushed. The branch `main@upstream` will be tracked.	2024-09-13 18:14:57 +02:00
Lukas Wirth	62059dd91e	Fix missing word in working-copy.md	2024-09-13 13:36:52 +02:00