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

38 KiB

Raw Blame History

Changelog

UNRELEASED - 2020-04-19

📚 xxxxxxxxxxxx Document piece length selection algorithm (#392) - Fixes #367 - Casey Rodarmor casey@rodarmor.com
📚 3ed449ce9325 Generate reference sections with bin/gen - Casey Rodarmor casey@rodarmor.com
🎨 a6bf75279181 Use invariant instead of unwrap and expect - Fixes #167 - Casey Rodarmor casey@rodarmor.com
✅ faf46c0f0e6f Test that globs match torrent contents - Fixes #377 - Casey Rodarmor casey@rodarmor.com
📚 0a754d0bcfcf Add manual Arch install link - Fixes #373 - Casey Rodarmor casey@rodarmor.com
🎨 0a870ed2ee2c Get current time early when creating torrents - Fixes #207 - Casey Rodarmor casey@rodarmor.com
📚 9098d3684032 Readme improvements - Casey Rodarmor casey@rodarmor.com
🎨 04338e3501af Merge documentation and changelog generation - Casey Rodarmor casey@rodarmor.com
📚 1f8023d13a39 Fix directory link in README - Matt Boulanger Celeo@users.noreply.github.com
✨ cb8b5a691945 Partially implement BEP 53 - Fixes #245 - strickinato aaronstrick@gmail.com
📚 6185d6c8a27c Add table of packages to readme (#372) - Fixes #369 - Casey Rodarmor casey@rodarmor.com
🔧 ddf097c83690 Fix publish recipe (#368) - Casey Rodarmor casey@rodarmor.com

v0.1.5 - 2020-04-11

🔖 707fdea21d61 Release v0.1.5 (#366) - Casey Rodarmor casey@rodarmor.com
🐛 727d5c102840 Fix Z Shell completions (#365) - Casey Rodarmor casey@rodarmor.com
📚 f05807290b31 Render command help text in book to avoid wrapping (#364) - Casey Rodarmor casey@rodarmor.com
📚 ed34ff48a740 Add fuchsi/maketorrent to prior art table (#362) - Casey Rodarmor casey@rodarmor.com
📚 a3f46187229f Rename distributing large datasets (#361) - Casey Rodarmor casey@rodarmor.com
📚 1c9ff0cde491 Add suggestions for distributing large datasets to book (#360) - Casey Rodarmor casey@rodarmor.com
✅ ff6f6d4c3de1 Test that --globs match entire file paths (#357) - Casey Rodarmor casey@rodarmor.com
📚 b914c175949f Add buildtorretn to prior art section of book (#355) - Casey Rodarmor casey@rodarmor.com

v0.1.4 - 2020-04-10

🔖 f070c62b12f5 Release v0.1.4 (#354) - Casey Rodarmor casey@rodarmor.com
🐛 4dfe537fa515 Prevent progress bar from overflowing (#353) - Casey Rodarmor casey@rodarmor.com
📦 a67eb72848c9 Improve install.sh and documentation (#352) - Casey Rodarmor casey@rodarmor.com
🎨 e54bdeb95d93 Remove use of unreachable in favor of internal errors (#351) - Fixes #188 - Casey Rodarmor casey@rodarmor.com
📚 52b78b90f675 Improve badges (#350) - Casey Rodarmor casey@rodarmor.com

v0.1.3 - 2020-04-10

🔖 8e6a2b0034de Release v0.1.3 - Casey Rodarmor casey@rodarmor.com
📚 268c62b66d46 Add bin/man command for generating man pages - Casey Rodarmor casey@rodarmor.com
📚 14fff1d888a3 Make smaller demo for readme - Casey Rodarmor casey@rodarmor.com
📚 4f8b6a212e80 Improve demo GIF - Casey Rodarmor casey@rodarmor.com

v0.1.2 - 2020-04-08

🔖 685883f02698 Release v0.1.2 - Casey Rodarmor casey@rodarmor.com
🔧 03a993516481 Skip fixup commits in changelog - Casey Rodarmor casey@rodarmor.com
🎨 a395052f7c22 Deduplicate progress style string - Casey Rodarmor casey@rodarmor.com
🔧 db2a2ac4f556 Refactor demo recipe in justfile into multiple recipes - Casey Rodarmor casey@rodarmor.com
⚡ 92748f9fd4e6 Make changelog generator strict (#341) - Casey Rodarmor casey@rodarmor.com
🔧 c33446b48135 Generate changelog from git history (#337) - Fixes #336 - Casey Rodarmor casey@rodarmor.com
🎨 6edab1fa3fa8 Use TestEnv::assert_ok everywhere - Fixes #330 - Casey Rodarmor casey@rodarmor.com
⚡ 8e3f5516aff8 Use attractive paths in user-facing messages - Fixes #252, #332 - Casey Rodarmor casey@rodarmor.com
🐛 1cfc0214536c Forbid empty input, output, and path targets - Casey Rodarmor casey@rodarmor.com
✨ c23b0635ee25 Add ability to create single-file torrents from stdin - Eric Siegel siegel.eric@gmail.com
🔧 796024bec9a0 Split automerge functionality into merge recipe - Casey Rodarmor casey@rodarmor.com
📚 4aa8f47da5d8 Add "Metadata/Prior Art" section to book - Casey Rodarmor casey@rodarmor.com
🔧 4c90bc41c3a2 Rewrite pr recipe to merge when CI passes - Casey Rodarmor casey@rodarmor.com
🔧 b16da8da5a85 Rewrite done recipe for new merge workflow - Casey Rodarmor casey@rodarmor.com
📚 9d43fa427597 Fix link to rodarmor's PGP key in readme - Casey Rodarmor casey@rodarmor.com
📚 543524b96de4 Mention signature policy in readme - Casey Rodarmor casey@rodarmor.com
🎨 f17527e58ee6 Use single-quoted strings in justfile - Casey Rodarmor casey@rodarmor.com
🔧 25153990817f Cache build artifacts - Casey Rodarmor casey@rodarmor.com
📚 83ee172b72cf Create section for bittorrent book chapters - Casey Rodarmor casey@rodarmor.com
📚 2ba24bb98528 Add description of UDP tracker protocol to book - Casey Rodarmor casey@rodarmor.com
📚 57e482f4b32b Record demo for readme - Casey Rodarmor casey@rodarmor.com
📚 a5e127318747 Update man page with new version number - Casey Rodarmor casey@rodarmor.com

v0.1.1 - 2020-04-08

🔖 93c23d29f24b Release v0.1.1 - Casey Rodarmor casey@rodarmor.com
📚 3131b0d56c7f Generate man page with from --help with help2man - Casey Rodarmor casey@rodarmor.com
✨ 8c30205b0263 Add shell completion scripts - Casey Rodarmor casey@rodarmor.com
🎨 e69c65a38b6a Remove errant torrent file - Casey Rodarmor casey@rodarmor.com

v0.1.0 - 2020-04-08

🔖 328a3adeafe3 Release v0.1.0 - Casey Rodarmor casey@rodarmor.com
✨ 97018031c1ab Introduce "sort specs" to allow fine-grained sorting of files in torrents - Casey Rodarmor casey@rodarmor.com
🎨 362a81d42fb9 Use strum crate to derive enum↔string conversions - Casey Rodarmor casey@rodarmor.com
📚 6996d1a3eac8 List supported OSs in readme - Casey Rodarmor casey@rodarmor.com
📚 4f7eead16a9a Link to blog post in readme - Casey Rodarmor casey@rodarmor.com
✨ 1cd6c276fdf7 Allow sorting files in torrents - Eric siegel.eric@gmail.com
🔧 687a863b45a5 Add cargo install cargo-watch to dev-deps recipe - Casey Rodarmor casey@rodarmor.com
📦 4b6191773aab Fix condition in GHA workflow - Casey Rodarmor casey@rodarmor.com
🔧 b27ecf1c09d6 Only deploy site during linux run of CI build - Casey Rodarmor casey@rodarmor.com
📚 b6cb3d389c98 Go back to sans-serif I in site logo - Casey Rodarmor casey@rodarmor.com
📚 ef1acd58c105 Use serifed I for intermodal on site - Casey Rodarmor casey@rodarmor.com
📚 4fc0f508e6a0 Add glow to intermodal letters on site - Casey Rodarmor casey@rodarmor.com
📚 89e97144e958 Improve readme intro - Casey Rodarmor casey@rodarmor.com
📚 6d5f489f1934 Add links to site - Casey Rodarmor casey@rodarmor.com
⚡ 6328118c0052 Use open crate to open files and URLs - Casey Rodarmor casey@rodarmor.com
📚 35d90adab4fd Rename www/head to www/head.txt - Casey Rodarmor casey@rodarmor.com
📚 0469f7fecd29 Record current git revision in www/head - Casey Rodarmor casey@rodarmor.com
🔧 972a1ec6288c Merge Github Actions workflows - Casey Rodarmor casey@rodarmor.com
✅ 151d912156c7 Deny warnings in GitHub Actions main workflow build - Casey Rodarmor casey@rodarmor.com
📚 e91b419af532 Improve book - Casey Rodarmor casey@rodarmor.com
🔧 1e5c19d02b5d Add GitHub Actions workflow to build book and push to github pages - Casey Rodarmor casey@rodarmor.com
🐛 b96c27e9b123 Fix build errors - Casey Rodarmor casey@rodarmor.com
📦 4cbeca802ac2 Add additional documents to release archive - Casey Rodarmor casey@rodarmor.com

v0.0.3 - 2020-04-08

🔖 5d4baa22eacb Release v0.0.3 - Casey Rodarmor casey@rodarmor.com
📦 86aeec3ce90f Fix release process issues - Casey Rodarmor casey@rodarmor.com

v0.0.2 - 2020-04-08

🔖 8b3954ff9965 Release v0.0.2 - Casey Rodarmor casey@rodarmor.com
✨ 498549b35c2f Allow reading torrent metainfo from stdin - Casey Rodarmor casey@rodarmor.com
✨ 1c84172ad48a Skip torrent file creation with imdl torrent create --dry-run - Casey Rodarmor casey@rodarmor.com
🔧 7e3a53ce52de Make just done default to current branch - Casey Rodarmor casey@rodarmor.com
✨ 0d7c1c0c279e Print magnet link to stdout with --link - Casey Rodarmor casey@rodarmor.com
📚 901fa150ff54 Indicate BEP 9 support in readme - Casey Rodarmor casey@rodarmor.com
✨ d8055c6e6a6c Allow opening magnet links after creation - Casey Rodarmor casey@rodarmor.com
✨ aeb9d8b31721 Add name and peers to magnet links - Casey Rodarmor casey@rodarmor.com
✨ 57a358e4580f Allow creating magnet links with imdl torrent link - Casey Rodarmor casey@rodarmor.com
📚 0b486cc6817c Update BEP list in readme with new issue links - Casey Rodarmor casey@rodarmor.com
⚡ 3257614c4fff Print correct and incorrect MD5 checksums in color - Casey Rodarmor casey@rodarmor.com
📦 1cac9ab9246f Use imdl-indicatif - Casey Rodarmor casey@rodarmor.com
✅ 0033e8381f59 Test imdl torrent verify output - Casey Rodarmor casey@rodarmor.com
🔧 2ea5e0b3840d Deny clippy::too_many_arguments - Casey Rodarmor casey@rodarmor.com
⚡ 1532113782ec Print individual file torrent verification errors - Casey Rodarmor casey@rodarmor.com
📚 f8e3fd594b50 Add explanation paragraph to readme - Casey Rodarmor casey@rodarmor.com
📦 f1cc12858cee Use bendy dep from crates.io instead of GitHub - Casey Rodarmor casey@rodarmor.com
✨ 1daa18ef9a7a Add progress messages and bar to imdl torrent verify - Casey Rodarmor casey@rodarmor.com
📚 5a0bd2dda75b Add braille spinner char explanation and legend - Casey Rodarmor casey@rodarmor.com
⚡ 2edf8a4fab1e Style imdl torrent create progress messages - Casey Rodarmor casey@rodarmor.com
🎨 8c0d9186079b Use concat!(...) to format braille tick chars - Casey Rodarmor casey@rodarmor.com
🎨 c3879db06f82 Remove matches macro - Casey Rodarmor casey@rodarmor.com
🐛 bb34936c2ffd Only write spinner and progress bar when connected to terminal - Casey Rodarmor casey@rodarmor.com
⚡ 2cfdad2597d6 Fail early if destination .torrent file exists - Casey Rodarmor casey@rodarmor.com
⚡ 4371bb14023b Improve spinner and progress bar - Casey Rodarmor casey@rodarmor.com
🎨 b25b389ae66b Rename Target to OutputTarget - Casey Rodarmor casey@rodarmor.com
⚡ 0de2b1719e55 Only show torrent summary on create with --show - Casey Rodarmor casey@rodarmor.com
⚡ 06947fd63e87 Make table names more greppable - Casey Rodarmor casey@rodarmor.com
✨ bdaec27cafd4 Add piece hashing progress bar - RJ Rybarczyk rj@rybar.tech
✨ c6cd78f56594 Add progress messages to imdl torrent create - RJ Rybarczyk rj@rybar.tech
📚 2415d88d9256 Add empty book - Casey Rodarmor casey@rodarmor.com
✨ 21a87a46f330 Improve imdl torrent create flags - Casey Rodarmor casey@rodarmor.com
✨ 3276f2d043d9 Add short flags to imdl torrent {show,verify} - Casey Rodarmor casey@rodarmor.com
✅ 027b229df112 Test piece-hashing edge cases - Casey Rodarmor casey@rodarmor.com
✅ 2b19a6213456 Test creating torrents from . and .. - Casey Rodarmor casey@rodarmor.com
📚 fa6d4e6ad013 Revise command line value names - Casey Rodarmor casey@rodarmor.com
📚 cba238470d3c Remove long_help in favor of help - Casey Rodarmor casey@rodarmor.com
🎨 4fffa777b4af Refactor Opt into Arguments, Options, and Subcommand - Casey Rodarmor casey@rodarmor.com
🐛 eb8efaf52843 Fix hidden method unused arg warning - RJ Rybarczyk rj@rybar.tech
🔧 1c22623df48f Trigger GitHub actions build on either push and PR to master - Casey Rodarmor casey@rodarmor.com
🎨 f2a5f137294e Format with unstable rustfmt options - Casey Rodarmor casey@rodarmor.com
⚡ d71bdffda15b Refactor tests and improve verification - Casey Rodarmor casey@rodarmor.com
✅ 2fb5bdb93344 Test that metainfo bencode representation is correct - Casey Rodarmor casey@rodarmor.com
📚 fdb18bb8d807 Update discord invite link - Casey Rodarmor casey@rodarmor.com
📚 55f2fcc73874 Add discord badge to readme - Casey Rodarmor casey@rodarmor.com
📚 355f76b86d3a Update badges - Casey Rodarmor casey@rodarmor.com
📚 b0962722c7db Add Github Actions build badge to readme - Casey Rodarmor casey@rodarmor.com
🎨 1227628306f0 Use list of SHA1 digests for piece list - Casey Rodarmor casey@rodarmor.com
🐛 9787344d9eee Fix torrent verify about message - Casey Rodarmor casey@rodarmor.com
✨ 165a7ea444b0 Support adding DHT bootstrap nodes to created torrents - Casey Rodarmor casey@rodarmor.com
✨ 6549850dac2e Add initial implementation of imdl torrent verify - Casey Rodarmor casey@rodarmor.com
🎨 b0f449b6aedb Drop serde_bencode in favor of bendy - Casey Rodarmor casey@rodarmor.com
⚡ 9b696f78a7df Don't display tier labels if tiers only contain a single entry - Casey Rodarmor casey@rodarmor.com
⚡ f7e9e80f972d Show files in single-file mode - Casey Rodarmor casey@rodarmor.com
✨ 43d87c06b6b5 Display torrent file tree - Casey Rodarmor casey@rodarmor.com
✨ a574368ffca6 Allow including and excluding files from torrent with globs - Casey Rodarmor casey@rodarmor.com
⚡ 9158c230dfd0 Skip hidden files, symlinks, and junk in created torrents - Casey Rodarmor casey@rodarmor.com
✨ 3739a92857fc Support creating multi-file torrents - Casey Rodarmor casey@rodarmor.com
⚡ 551617de4f09 Don't overwrite destination torrent without --force - Casey Rodarmor casey@rodarmor.com
✨ df3326510c4b Write torrent to stdout if - is passed to --output - Casey Rodarmor casey@rodarmor.com
✨ 5a1de1acd219 Select piece length when none is provided - Casey Rodarmor casey@rodarmor.com
⚡ 35a0e8f9b73f Improve torrent display formatting - Casey Rodarmor casey@rodarmor.com
✨ 5c5dac1fe532 Add source to generated torrent with --source - Casey Rodarmor casey@rodarmor.com
⚡ b9ca02fbaabc Show information about torrents after creation - Casey Rodarmor casey@rodarmor.com
✅ 3971854eaa44 Check for outdated dependencies before publishing - Casey Rodarmor casey@rodarmor.com
✨ 99a069a02184 Add imdl torrent show - Casey Rodarmor casey@rodarmor.com
⚡ 6df45e024463 Restrict piece length - Casey Rodarmor casey@rodarmor.com
📚 85f02d9f2992 Add pyrocore to prior art section of readme - Casey Rodarmor casey@rodarmor.com
⚡ 635692fdfac1 Accept --piece-length arguments with SI units - Casey Rodarmor casey@rodarmor.com
📚 eb6556ae6aa2 Replace favicon with pixel art rainbow text version - Casey Rodarmor casey@rodarmor.com
📚 5611f359686d Add favicon to github pages - Casey Rodarmor casey@rodarmor.com
📚 3f91f042c771 Fix github pages table jitter - Casey Rodarmor casey@rodarmor.com
📚 9ff627c29fd9 Make homepage A E S T H E T I C - Casey Rodarmor casey@rodarmor.com
🔧 460cf9ee0e79 Disable bors - Casey Rodarmor casey@rodarmor.com
🔧 2512b05ece5e Fix Bors - Casey Rodarmor casey@rodarmor.com
📚 e2c1f291605c Center symbols in BEP support table key in readme - Casey Rodarmor casey@rodarmor.com
📚 48ca86c67ce7 Add Alternatives & Prior Art section to readme - Casey Rodarmor casey@rodarmor.com
📦 ef5be39f9b61 Update install instructions to new domain - Casey Rodarmor casey@rodarmor.com
✅ 6461a00ba37a Test that wss:// trackers are accepted - Casey Rodarmor casey@rodarmor.com
🔧 a6745e2a4187 Configure Bors - Casey Rodarmor casey@rodarmor.com
📚 dc95bc53b27b Add github pages homepage - Casey Rodarmor casey@rodarmor.com
📦 e2cf93efb054 Add install script and installation section to readme - Casey Rodarmor casey@rodarmor.com

v0.0.1 - 2020-04-08

🔖 9dd8a5629814 Release v0.0.1 - Casey Rodarmor casey@rodarmor.com
✨ e8ab0e1c4f68 Open torrents with imdl create --open ... - Casey Rodarmor casey@rodarmor.com
📚 495316e82110 Add table of references to readme - Casey Rodarmor casey@rodarmor.com
✅ a8446c82db9e Test UDP tracker URLs parse - Casey Rodarmor casey@rodarmor.com
📚 0560181a099f Remove redundant information from the readme - Casey Rodarmor casey@rodarmor.com
📚 1a20f0d0b35d Link to tracking issues from BEP support table - Casey Rodarmor casey@rodarmor.com
📦 ff3a30ae2138 Add package script - Casey Rodarmor casey@rodarmor.com
📦 cf59a58c6733 Build and upload release artifacts from CI - Casey Rodarmor casey@rodarmor.com
📚 70e0091ec03c Add help messages to CLI flags and options - Casey Rodarmor casey@rodarmor.com
✨ b83d8d7ef53b [torrent stats] Pretty print torrents if --print is passed - Casey Rodarmor casey@rodarmor.com
⚡ 7d5e68f1941a Enable --help text wrapping - Casey Rodarmor casey@rodarmor.com
🎨 87e9b982b6be Sort Create opt struct fields - Casey Rodarmor casey@rodarmor.com
📚 801a51926564 BEP 3 is supported - Casey Rodarmor casey@rodarmor.com
🎨 1749fce2b227 Slighly improve readability of Hasher::hash_root - Casey Rodarmor casey@rodarmor.com
📚 1f5b829742f4 Add table of contents to readme - Casey Rodarmor casey@rodarmor.com
📚 66d44155f05a Add BEP support table to readme - Casey Rodarmor casey@rodarmor.com
✨ d1f8f24d8e18 Add colored output - Casey Rodarmor casey@rodarmor.com
✅ b334fa49b2d8 Redirect stdin and stdout and capture for tests - Casey Rodarmor casey@rodarmor.com
🎨 fd06943726cb Rename: Environment -> Env - Casey Rodarmor casey@rodarmor.com
🎨 7420c91553c6 Rename bencode::Error::ExtraData -> TrailingData - Casey Rodarmor casey@rodarmor.com
✅ 7de1c0477623 Fail CI if code isn't formatted - Casey Rodarmor casey@rodarmor.com
🎨 408735621e51 Delete extraneous comment in workflow file - Casey Rodarmor casey@rodarmor.com
✅ 074a3b3d42dd Run CI tests on windows, macos, and linux - Casey Rodarmor casey@rodarmor.com
✅ 9f8366137477 Configure clippy and lint on push - Casey Rodarmor casey@rodarmor.com
🔧 7f630a1bd937 Add done recipe to justfile - Casey Rodarmor casey@rodarmor.com
✅ 3affa8c5e14b Add build and test github action workflow - Casey Rodarmor casey@rodarmor.com
✨ 98335f435de2 Initial commit - Casey Rodarmor casey@rodarmor.com

38 KiB Raw Blame History

Changelog

UNRELEASED - 2020-04-19

v0.1.5 - 2020-04-11

v0.1.4 - 2020-04-10

v0.1.3 - 2020-04-10

v0.1.2 - 2020-04-08

v0.1.1 - 2020-04-08

v0.1.0 - 2020-04-08

v0.0.3 - 2020-04-08

v0.0.2 - 2020-04-08

v0.0.1 - 2020-04-08

38 KiB

Raw Blame History