37 Commits

Author SHA1 Message Date
TimerErTim
ae1e831aa6 docs: mention openSUSE installation method 2025-04-17 18:34:12 +00:00
Raphael Borun Das Gupta
d1242635c6 docs: fix spelling of «NixOS»
The name «NixOS» doesn't have a space in it.
2025-03-19 22:46:34 +00:00
Johannes Altmanninger
4c01ed0746 docs: fish shell enables completions by default
To avoid redundant computation, users who run `COMPLETE=fish jj | source`
in their ~/.config/fish/config.fish should eventually remove that, or move it
to ~/.config/fish/completions/jj.fish which overrides the default completions.

Ref: https://github.com/fish-shell/fish-shell/pull/11046
2025-03-17 18:37:48 +00:00
Ilya Grigoriev
1ede79c483 MSRV: Update to 1.84 and run clippy --fix, cargo fmt
The CI seems to correctly use rustc 1.84.1 (and not 1.84.0) with this.

For reference, we last updated the MSRV to 1.76 in 5b517b5. According to
https://releases.rs/docs/1.76.0/, this was when it barely became stable.

`flake.nix` seems to be using a nightly toolchain now, so it seems there
is no need to update the version there.

The more precise clippy command used was:

cargo clippy --workspace --all-targets --fix
2025-03-06 07:24:28 +00:00
Vincent Ging Ho Yim
8f15f7eae9 docs/install-and-setup: clarify wording re: binaries of latest GitHub release 2025-02-05 21:31:47 +00:00
Vincent Ging Ho Yim
0c12636981 docs/install-and-setup: move 'prerelease version' sentence to after 'Cargo Binstall' section
It seems that in 38daa9a the 'Cargo Binstall' section should have been inserted above the 'prelease version' sentence instead.
2025-02-05 21:31:21 +00:00
Vincent Ging Ho Yim
de3c90ac90 docs/install-and-setup: replace linuxbrew with Homebrew
The name `Linuxbrew` is no longer used since Homebrew 2.0.0:
https://brew.sh/2019/02/02/homebrew-2.0.0/
2025-02-04 12:42:21 +00:00
Vincent Ging Ho Yim
ebac2b8a4e docs: add language identifiers to code blocks to improve syntax highlighting 2025-02-03 13:43:24 +00:00
Josh Steadmon
fb4d796cc6 docs: point to jj-vcs for Nix install instructions 2025-01-29 22:03:16 +00:00
Martin von Zweigbergk
e299931692 docs: fix typo in env variable $COMPLETE, and clarify text
Closes #5466.
2025-01-26 02:55:16 +00:00
Philip Metzger
c40e5210c4 docs: fix the mkdocs admonition I recently added
I didn't check the indentation as it _needs_ to be a codeblock to render correctly.
2025-01-10 23:09:01 +00:00
Philip Metzger
038c0bab12 docs: Make dynamic completions a bit more visible
In recent times multiple users showed up and were confused _why_ some
completions didn't show up, so make it explicit that they're opt-in
until the Clap upstream has made it so.
Also remove the link to the dynamic completions improvements issue, as it was closed
a while ago.
2025-01-10 20:59:45 +00:00
Ollivier Robert
602b79f7fd Add a paragraph on how to install jj completions into Powershell.
Change USER into $HOME.
2025-01-02 10:52:55 -06:00
Waleed Khan
34ec85edbd docs: revert "docs: update installation docs to say that cmake is needed"
This reverts commit b7ba3fc0be734cfa39bb7d6cfc50ed67eee15dce.

As per discussion in https://github.com/martinvonz/jj/pull/5047, I would like to make it so that the default build configuration doesn't need `cmake`.
2024-12-31 17:07:52 -06:00
Martin von Zweigbergk
b836e0ae95 docs/cli: update URLs to from martinvonz user to jj-vcs org
We just migrated to the jj-vcs GitHub org, so we should point to the
new GitHub URLs.
2024-12-17 12:44:44 -08:00
Martin von Zweigbergk
b7ba3fc0be docs: update installation docs to say that cmake is needed
Since we enabled the `zlib-ng` feature from `gix` in 2412fd4, `cmake`
is needed when installing from source.
2024-12-06 08:23:27 -08:00
Remo Senekowitsch
d76bcd9305 docs: clarify dynamic completion features 2024-11-29 21:22:38 +01: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
Remo Senekowitsch
c9e751ae6e completion: teach rename about local bookmarks 2024-11-10 07:26:22 +01:00
Emily
1a0780ebcd docs: fix typo in Mac install section 2024-10-26 14:21:52 +02: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
Daniel Raniz Raneland
3d5c5b03de Added docs about installation under Gentoo Linux 2024-08-20 22:19:09 -07:00
Ilya Grigoriev
206c0cf830 docs: document how to compile a statically linked binary on Mac
I feel like this is worth documenting, as it shouldn't require
Homebrew.
2024-08-11 20:10:37 -07:00
Ilya Grigoriev
b8d0cf31b8 docs install_and_setup: move Arch Linux after From Source
I am not sure how to order the other entries, but "From Source" seems to
me like the most important one.
2024-06-09 10:15:16 -07:00
Martin von Zweigbergk
3dad9d4a98 docs: make "Arch Linux" a subheading under "Linux"
I think this is how it was supposed to be. The "From Source" section
applies to non-Arch Linuxes too.
2024-04-24 09:22:51 -07:00
Patric Stout
e5b9e8ff58 docs: "bash" is no longer optional for command-line completion 2024-04-02 09:30:44 -07:00
TrashCan
33911712a2 Add archlinux instructions to install-and-setup.md
based upon #3289 by @roland-5
2024-03-13 21:35:08 -07:00
Alexis (Poliorcetics) Bourget
c75230747a completion: Add support for Nushell completions 2024-02-18 19:08:38 +01:00
Alexis (Poliorcetics) Bourget
fb10e3f296 completion: Update docs for new style with positional argument 2024-02-17 19:26:30 +01:00
Jesse Somerville
8fac33afdb install-and-setup.md: --strategy -> --strategies for cargo binstall 2023-11-21 20:19:38 -08:00
Ilya Grigoriev
38daa9abe3 install-and-setup.md: Document binary installation with cargo-binstall
I also mentioned this in the changelog, since people reading it are more likely
to use `binstall` than most.
2023-10-30 15:12:23 -07:00
Ilya Grigoriev
2cd262def3 install-and-setup.md: Make headings more consistent 2023-10-30 15:12:23 -07:00
Infra
56a1686925 Add build-essential to install instructions 2023-10-05 09:07:37 -07:00
Ilya Grigoriev
21f4015cbf install-and-setup.md: explain how to compile the latest release
Also a few minor updates.
2023-09-11 18:21:56 -07:00
Ilya Grigoriev
2911f414bd docs: remove v0.7.0 shell completion instructions
Now that v0.9.0 is released, it seems appropriate.
2023-09-06 15:35:01 -07:00
Ilya Grigoriev
623c5e28c2 docs: change "shell script" codeblock to "shell"
```shell script
    ```

breaks mkdocs rendering
2023-08-28 10:43:48 -07:00
Ilya Grigoriev
64140c34b7 docs: Move installation instructions from README to docs/
This allows the tutorial to reference them and will make it
easier to have different instructions for different versions.

We can later restore some instructions to the README, but I
think this is important since the installation instructions
do change in important (even if slight) ways from time to
time.
2023-08-28 10:43:48 -07:00