summaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorGabriel Scherer <gabriel.scherer@gmail.com>2021-04-14 11:21:09 +0200
committerGabriel Scherer <gabriel.scherer@gmail.com>2021-04-21 07:23:57 +0200
commit91cbb912c557ab0aef7563e8f0f846e9b226eff0 (patch)
treea76ffc1bfb75bdb3f94ffb39974e12476757dbda /README.md
parent4838e378b94f2731f1d53042a71136dcb4890c44 (diff)
README.md: workaround for the cargo manpage issue
git-absorb provides a manpage, but cargo does not currently know how to install it. Offer a manual workaround in the README. Co-authored-by: Waldir Pimenta <waldyrious@gmail.com>
Diffstat (limited to 'README.md')
-rw-r--r--README.md7
1 files changed, 7 insertions, 0 deletions
diff --git a/README.md b/README.md
index fa56531..4855727 100644
--- a/README.md
+++ b/README.md
@@ -37,6 +37,13 @@ Alternatively, `git absorb` is available in the following system package manager
| nixpkgs stable and unstable | `nix-env -iA nixpkgs.gitAndTools.git-absorb` |
| Void Linux | `xbps-install -S git-absorb` |
+Note: `cargo install` does not currently know how to install manpages ([cargo#2729](https://github.com/rust-lang/cargo/issues/2729)), so if you use `cargo` for installation then `git absorb --help` will not work. Here is a manual workaround, assuming your system has a `~/.local/share/man/man1` directory that `man --path` knows about:
+
+```
+wget https://raw.githubusercontent.com/tummychow/git-absorb/master/Documentation/git-absorb.1
+mv git-absorb.1 ~/.local/share/man/man1
+```
+
## Usage
1. `git add` any changes that you want to absorb. By design, `git absorb` will only consider content in the git index.