# Tasks

## DONE Translate usage/help strings and manpages {#task-9e842529-b782-84a2-1d0a-801a8766cb7e}
- DONE in 2021-06-19

  Integration with Makefile done in
  [`b81c6437937fb594629d627334cc7e1fc2135507`](https://git.euandreh.xyz/git-permalink/commit/?id=b81c6437937fb594629d627334cc7e1fc2135507).
- DOING in 2021-06-18

  Translation of:
  - usage/help strings done in
  [`bf41672f72ee3ff7679c93e0d5a8f8646c19db3e`](https://git.euandreh.xyz/git-permalink/commit/?id=bf41672f72ee3ff7679c93e0d5a8f8646c19db3e);
  - manpages done in
  [`d0a5a24788e6c1720fce72629da4639fac372fad`](https://git.euandreh.xyz/git-permalink/commit/?id=d0a5a24788e6c1720fce72629da4639fac372fad).
- TODO in 2021-06-16

## DONE Fix tests in CI {#task-1e18a7cc-1055-bd09-3060-c03292ba583b}
- DONE in 2021-06-12

  There was a test that was too brittle, and it was removed.  See [CI logs before] and [CI logs after].

  Done in
  [`cd7bd39b1b6ce7d958f48d63b42ba3ab5fdf6f21`](https://git.euandreh.xyz/git-permalink/commit/?id=cd7bd39b1b6ce7d958f48d63b42ba3ab5fdf6f21).
- TODO in 2021-06-12

---

For some reason, running them locally witn `./aux/guix/with-container.sh 'make clean public dev-check'` passes, but the same command doesn't on CI.

[CI logs before]: https://euandreh.xyz/git-permalink/ci-logs/2021-06-12T22:51:21+00:00-07a75e37a4564ed13bc2f50ab84009df137bc223.log
[CI logs after]: https://euandreh.xyz/git-permalink/ci-logs/2021-06-12T23:15:22+00:00-cd7bd39b1b6ce7d958f48d63b42ba3ab5fdf6f21.log

## DONE Support override via git config {#task-7695d33d-e96e-d313-b74b-860addde01c3}
- DONE in 2021-06-12

  Done in
  [`dc51a628910eb872430e108084e81ee37f6e7dff`](https://git.euandreh.xyz/git-permalink/commit/?id=dc51a628910eb872430e108084e81ee37f6e7dff).
- TODO in 2021-06-12

## DONE Write `README.md`, `description` and `long-description` {#task-9bc160b8-5739-133d-1d46-61ba68ebd39e}
- DONE in 2021-06-12

  Finished `README.md` in
  [`d64e4491e417e31f35d3637ded05f5175c19b071`](https://git.euandreh.xyz/git-permalink/commit/?id=d64e4491e417e31f35d3637ded05f5175c19b071).
- DOING in 2021-06-12

  The `description` was already good enough.

  The `long-description` has better content over the previous duplication of whatever was in `description`.
	Done in
  [`9e089d29ec64936df39b9b1a0e385f988d843416`](https://git.euandreh.xyz/git-permalink/commit/?id=9e089d29ec64936df39b9b1a0e385f988d843416).

  The `README.md` is less empty, but still missing a "Usage" section.
  Done in
  [`a9022eb2f72efd9b99212a057df33cba762cd13b`](https://git.euandreh.xyz/git-permalink/commit/?id=a9022eb2f72efd9b99212a057df33cba762cd13b).
- TODO in 2021-06-12

## DONE Write tests {#task-fd654661-fa97-83db-1d49-83a66866ccfa}
- DONE in 2021-06-12

  I didn't find a simple way to test without getting too much into the weeds with mocking Git, and I don't think it is worth it.

  The tests I created are actually just exercising the help and versions flags, and asserting that other flags are ignored.
  For effectiveness this is pretty shallow and pretty useless, but I'm fine with the state of not testing the core functionality.

	To do that it would require me to split `src/git-permalink.sh` into two files, one with the function definitions and the other as a runner.
  But then I would have to glue them together on the `install` target, and more similar complications.

  Given all that, I chose not to write more tests, and call this done.

  Done in
  [`50a7c011274359ef058d30be87b9d29ca4fd06ed`](https://git.euandreh.xyz/git-permalink/commit/?id=50a7c011274359ef058d30be87b9d29ca4fd06ed).
- TODO in 2021-06-12

## DONE Write manpage {#task-6e6f917f-26ad-09fd-9a09-84b5df0f3ea4}
- DONE in 2021-06-12

  Done in
  [`0f02b1bf62005b451ff4b91a88716cb6e0365849`](https://git.euandreh.xyz/git-permalink/commit/?id=0f02b1bf62005b451ff4b91a88716cb6e0365849).
- TODO in 2021-06-12

---

Show example of how to create an override URL on `git config` from a known URL.

## DONE Support default flags {#task-a66edd2e-cec4-ef7d-5a8a-3c9013381719}
- DONE in 2021-06-12

  Done in
  [`9aded035e3a6ab3fbac3129353db587b22132c79`](https://git.euandreh.xyz/git-permalink/commit/?id=9aded035e3a6ab3fbac3129353db587b22132c79).
- TODO in 2021-06-12

---

Those are:
- `-h`
- `--help`
- `-V`
- `--version`

## DONE Support more forges {#task-cebc5298-17ad-5c60-dfa5-a25b66433a3a}
- DONE in 2021-06-19
- TODO in 2021-06-12

---

The ones done so far as of this writing:

- <input type="checkbox" disabled checked /> git.euandreh.xyz
- <input type="checkbox" disabled checked /> sourcehut
- <input type="checkbox" disabled checked /> savannah
- <input type="checkbox" disabled checked /> gitlab
- <input type="checkbox" disabled checked /> github

The one I can think of right now but almost never use to merit being
part of the first version:

- <input type="checkbox" disabled checked /> Kernel CGit (where Git itself in publicly available): [`caaac9ffb8c80432ef41ad9434762d3e3401f01a`](https://git.euandreh.xyz/git-permalink/commit/?id=caaac9ffb8c80432ef41ad9434762d3e3401f01a)
- <input type="checkbox" disabled checked /> codeberg: [`8be93bf6e7077d69eec43a80b773f9c2a6530524`](https://git.euandreh.xyz/git-permalink/commit/?id=8be93bf6e7077d69eec43a80b773f9c2a6530524)
- <input type="checkbox" disabled checked /> notabug: [`0ee7b1fa813809e2e86e4e322999d3d56f1d180d`](https://git.euandreh.xyz/git-permalink/commit/?id=0ee7b1fa813809e2e86e4e322999d3d56f1d180d)
- <input type="checkbox" disabled checked /> pagure: [`67573428bfcba5eb91cb286153ec593666c2a437`](https://git.euandreh.xyz/git-permalink/commit/?id=67573428bfcba5eb91cb286153ec593666c2a437)
- <input type="checkbox" disabled checked /> bitbucket: [`2c5e8e11a26a9a09cbeb2ceda1ca7b4e4f3aa68a`](https://git.euandreh.xyz/git-permalink/commit/?id=2c5e8e11a26a9a09cbeb2ceda1ca7b4e4f3aa68a)
- <input type="checkbox" disabled checked /> <del>generic cgit?</del> No, people should use `git-permalink.template-file-commit` and `git-permalink.template-commit-file` instead

# Bugs

# Improvements

# Questions

## DONE Is an empty blank line in groff the same as a `.P` request? {#question-e3b7748d-2e67-b60b-e966-ad80c754ea58}
- DONE in 2021-06-16

  Done in
  [`c24b3a73b259943bb2440c587d8054ce90480552`](https://git.euandreh.xyz/git-permalink/commit/?id=c24b3a73b259943bb2440c587d8054ce90480552).
- TODO in 2021-06-16

---

When reading the manpage with `man` or looking at the final output generated with `pandoc`, it seems to me that an empty line behaves and mean the same thing as a `.P` request.
If this is true, these two snippets are equivalent:

```troff
.\" First snippet, using .PP

.PP
The first paragraph.
.PP
The second paragrah.
.PP
The third paragraph.


.\" Second snippet, using empty lines

The first paragraph.

The second paragrah.

The third paragraph.
```

I find the second option to be much more readable, and if both are equivalent I prefer writing that.
In fact, I don't see any reason at all to use `.PP`.

# Resources

# Scratch