Commit Graph

30 Commits

Author SHA1 Message Date
Casey Rodarmor
452486a782
Placate clippy
type: reform
2021-05-02 22:00:43 -07:00
Casey Rodarmor
e7872f56f2
Move all output from bin/gen to target/gen
To make it clearer what is and isn't generated content, make gen place
all generated output in `target/gen`.

Also, try to make the readme clearer about the location of build
artifacts.

type: development
2020-05-01 00:29:40 -07:00
Casey Rodarmor
5ba885dbc4
Take input to imdl torrent create as positional
Allow taking the `--input` argument to `imdl torrent create` as a
positional argument, so the following now works:

    imdl torrent create foo

Taking input by flag `--input` still works.

type: changed
fixes:
- https://github.com/casey/intermodal/issues/375
2020-04-21 22:23:39 -07:00
Casey Rodarmor
4d67d3a10d
Don't commit the book
To avoid bloating commits, don't commit any auto generated from the
book.

type: development
2020-04-21 00:36:48 -07:00
Celeo
deca555ac3
Allow suppressing output with --quiet
Add a global flag `--quiet`, which allows supressing output from
`imdl torrent create` and `imdl torrent verify`.

Since it's a global option, it should be given before the subcommand,
e.g.:

    imdl --quiet torrent create --input .

type: added
fixes:
- https://github.com/casey/intermodal/issues/174
2020-04-20 21:37:07 -07:00
Casey Rodarmor
838167c4d3
Describe in FAQ creating torrent from git repo
type: documentation
2020-04-20 20:10:26 -07:00
Celeo
9b72873ed1
Optionally respect .gitignore in imdl torrent create
Add a '--ignore' flag that, when passed, causes `imdl torretn create` to
skip files listed in `.gitignore`, `.ignore`, `.git/info/exclude`, and
`git config --get core.excludesFile`.

Also switches from the `walkdir` crate to the `ignore` crate, which uses
`walkdir` internally, and which handles `.gitignore` and `.ignore`
files.

This changes the behavior of `-include-hidden` on MacOS to no longer
skip entries with the hidden attribute set, due to `ignore` not exposing
`walkdir`'s filter functionality.

A PR[0] is pending to add filtering to `ignore`, so hopefully this
functionality can be re-implemented soon.

[0] https://github.com/BurntSushi/ripgrep/pull/1557

type: added
fixes:
- https://github.com/casey/intermodal/issues/378
2020-04-20 19:20:12 -07:00
Casey Rodarmor
9f48062461
Improve FAQ template
Use separate anchor tags, so FAQ entry titles are properly rendered.

type: documentation
2020-04-20 00:17:57 -07:00
Casey Rodarmor
85246d816c
Release v0.1.6
- Bump version: 0.1.5 → 0.1.6
- Update dependencies
- Regenerate documentation

type: release
2020-04-19 23:27:32 -07:00
Casey Rodarmor
1cb1178672
Create FAQ
Add an FAQ section to the book. Include information about how to use
imdl with `fzf --preview`.

type: documentation
fixes:
- https://github.com/casey/intermodal/issues/397
2020-04-19 23:19:29 -07:00
Casey Rodarmor
65597c9851
Add --terminal override terminal autodetection
The `--terminal` flag can be used to override terminal autodetection and
force `imdl` to behave as if standard error and standard output are
connected to a terminal.

type: added
fixes:
- https://github.com/casey/intermodal/issues/398
2020-04-19 22:51:18 -07:00
Casey Rodarmor
09b0ee316c
Document piece length selection algorithm
Add a page to the book discussing factors in piece length selection, and
Intermodal's piece length selection algorithm.

type: documentation
pr: https://github.com/casey/intermodal/pull/392
fixes:
- https://github.com/casey/intermodal/issues/367
2020-04-18 23:12:31 -07:00
Casey Rodarmor
3ed449ce93
Generate reference sections with bin/gen
type: documentation
2020-04-18 19:14:54 -07:00
Casey Rodarmor
04338e3501
Merge documentation and changelog generation
Merge documentation generation into a single binary, `bin/gen`. This
includes: The changelog, man pages, the readme, and the book.

type: reform
2020-04-17 21:31:54 -07:00
strickinato
cb8b5a6919
Partially implement BEP 53
This enables `--select-only 1,2,3` which gets appended to the magnet
link as `&so=1,2,3`.

It's a partial implementation because we're missing support for file
ranges ie `--select-only 4-6`

type: added
fixes:
- https://github.com/casey/intermodal/issues/245
2020-04-12 20:42:45 -07:00
Casey Rodarmor
707fdea21d
Release v0.1.5
- Bump version: 0.1.4 -> 0.1.5
- Update changelog
- Update man page
- Update book

type: release
pr: https://github.com/casey/intermodal/pull/366
2020-04-11 04:28:23 -07:00
Casey Rodarmor
727d5c1028
Fix Z Shell completions
The clap-generated zsh completion scripts use unescaped double-quoted
strings for the subocommand description text, which causes backtick
characters to be evaluated.

Remove backticks from the subcommand descriptions, to un-break the zsh
completion scripts.

type: fixed
pr: https://github.com/casey/intermodal/pull/365
2020-04-11 04:22:22 -07:00
Casey Rodarmor
f05807290b
Render command help text in book to avoid wrapping
The command `--help` text output in the book was very wide, which caused
it to be clipped and require scrolling horizontally to see it all.

This diff renders the text at 80 columns, which makes it visible without
scrolling at reasonable screen sizes.

To do this, `env::run` now checks for the presence of the environment
variable `IMDL_TERM_WIDTH`, which, if set to a positive integer, will be
passed to `Clap::set_term_width`.

`bin/man` now uses this to render the help text at 80 characters.

type: documentation
pr: https://github.com/casey/intermodal/pull/364
2020-04-11 04:00:52 -07:00
Casey Rodarmor
ed34ff48a7
Add fuchsi/maketorrent to prior art table
type: documentation
pr: https://github.com/casey/intermodal/pull/362
2020-04-10 22:33:24 -07:00
Casey Rodarmor
a3f4618722
Rename distributing large datasets
type: documentation
pr: https://github.com/casey/intermodal/pull/361
2020-04-10 21:10:31 -07:00
Casey Rodarmor
1c9ff0cde4
Add suggestions for distributing large datasets to book
type: documentation
pr: https://github.com/casey/intermodal/pull/360
2020-04-10 20:54:14 -07:00
Casey Rodarmor
b914c17594
Add buildtorretn to prior art section of book
type: documentation
pr: https://github.com/casey/intermodal/pull/355
2020-04-10 16:14:51 -07:00
Casey Rodarmor
f070c62b12
Release v0.1.4
- Bump version: 0.1.3
- Update dependencies
- Update generated documentation

type: release
pr: https://github.com/casey/intermodal/pull/354
2020-04-10 15:32:32 -07:00
Casey Rodarmor
8e6a2b0034
Release v0.1.3
- Bump version: 0.1.2 -> 0.1.3
- Update changelog
- Update book
- Add `update` recipe

type: release
2020-04-09 17:30:04 -07:00
Casey Rodarmor
268c62b66d
Add bin/man command for generating man pages
Generates man pages and book entries for all subcommands, and keeps the
commands index in the book up to date.

There is much cursed roff munging in this diff.

type: documentation
2020-04-09 15:23:12 -07:00
Casey Rodarmor
4aa8f47da5
Add "Metadata/Prior Art" section to book
Mention Media RSS specification, a structured metadata standard for RSS.

type: documentation
2020-04-07 19:01:42 -07:00
Casey Rodarmor
83ee172b72
Create section for bittorrent book chapters
type: documentation
2020-04-07 19:01:38 -07:00
Casey Rodarmor
2ba24bb985
Add description of UDP tracker protocol to book
type: documentation
2020-04-07 19:01:38 -07:00
Casey Rodarmor
e91b419af5
Improve book
- Write introduction
- Move large readme sections into book
- Rename docs to www

type: documentation
2020-04-07 19:01:30 -07:00
Casey Rodarmor
2415d88d92
Add empty book
The book should eventually contain all documentation that isn't suitable
for the readme or help text.

For now it's empty, but it seemed useful to add the scaffolding, so
adding to it is low friction.

type: documentation
2020-04-07 19:01:15 -07:00