summaryrefslogtreecommitdiff
path: root/docs
AgeCommit message (Collapse)Author
2023-07-07Add libgfold CHANGELOG and release processNick Gerace
Signed-off-by: Nick Gerace <nickagerace@gmail.com>
2023-06-26Fix arch linux package locations in other placesNick Gerace
Follow-up to 6b0f9458d7a602514fff205f8a58a9a863e4edc1 Signed-off-by: Nick Gerace <nickagerace@gmail.com>
2023-04-07Restore cargo xtaskNick Gerace
Primary: - Restore cargo xtask to the repository - Polish "size" and "loose-bench" tasks and integrate them with cargo xtask - Update documentation to reflect new xtask changes - Move ci to use cargo xtask Secondary: - Remove unneeded run from gfold test Signed-off-by: Nick Gerace <nickagerace@gmail.com>
2023-03-20Remove nix flake, fix changelog 4.3.2 title, bump depsNick Gerace
- Remove nix flake due to lack of maintainability - Fix changelog 4.3.2 title (it was missing on release) - Bump deps (includings "dirs" to 5.0.0) Signed-off-by: Nick Gerace <nickagerace@gmail.com>
2023-03-09Fix demo GIF linksNick Gerace
Signed-off-by: Nick Gerace <nickagerace@gmail.com>
2023-02-28Add nix flakeNick Gerace
- Add nix flake with documentation - Bump deps - Document private items by default Signed-off-by: Nick Gerace <nickagerace@gmail.com>
2023-02-05Add demo gifNick Gerace
Signed-off-by: Nick Gerace <nickagerace@gmail.com>
2022-12-21Add submodule support in json modeNick Gerace
Primary: - Add submodule collection and support in json display mode Doc: - Ensure build from source instructions work with cargo workspaces - Add "no deps" flag to clippy usages Misc: - Add result type aliases - Change NOTE, FIXME, and TODO comments to have the author's nickname Signed-off-by: Nick Gerace <nickagerace@gmail.com>
2022-12-20Update to 4.1.2Nick Gerace
Signed-off-by: Nick Gerace <nickagerace@gmail.com>
2022-10-20Update to 4.1.0 (part 2)Nick Gerace
Signed-off-by: Nick Gerace <nickagerace@gmail.com>
2022-10-20Update to 4.1.0 and switch from argh to clap v4Nick Gerace
- Update to 4.1.0 - Switch from argh to clap v4 - Remove ability to combine display flag with version flag - Move pre-4.0.0 changelog entries to their own file - Ensure integration test artifacts are built in the correct location Signed-off-by: Nick Gerace <nickagerace@gmail.com> Signed-off-by: Nick Gerace <nick@pop-os.localdomain>
2022-08-09Switch to cargo workspaceNick Gerace
Primary: - Switch to cargo workspace to replace xtask, make, etc. - Add debug symbol stripping Misc: - Upgrade all packages - Replace entries iterator with "next" due to the following PR: https://github.com/rust-lang/git2-rs/pull/854 - Remove "rustfmt.toml" Signed-off-by: Nick Gerace <nickagerace@gmail.com>
2022-07-05Update to 4.0.1Nick Gerace
Functional: - Update "Cargo.toml" version to 4.0.1 - Bump all packages - Add warnings check to "cargo doc" in CI - Remove bash scripts (install and uninstall) and move their logic to markdown docs Docs: - Move download and install from source instructions to their own file - Add "cargo doc" warnings check to dev docs - Rename scripts to performance testing scripts where mentioned - Add "quiet" flag to "cargo run" for scripts Signed-off-by: Nick Gerace <nickagerace@gmail.com>
2022-05-10Update to 4.0.0Nick Gerace
Signed-off-by: Nick Gerace <nickagerace@gmail.com>
2022-04-23Bolster loose bench to provide better resultsNick Gerace
Loose bench: - Bolster loose bench to calculate more runs with averages - Alternate order at the halfway mark of total runs for loose bench - Display run averages and global duration for loose bench - Add TODO for loose bench to track average deviation (i.e. how consistently does gfold perform across runs?) - Add module comment for loose bench explaining its purpose Misc: - Add TargetOption enum for processing target entries - Name reports and target varaibles with more specificity - Add fix commands to DEVELOPING - Misc updates to Cargo.lock - Update to 4.0.0-rc.3 Result: - Only use "anyhow::Result" when there is more than one error type Bug fix: - Add current dir to scripts to ensure gfold is being built Signed-off-by: Nick Gerace <nickagerace@gmail.com>
2022-04-16Fix origin remote and config file lookup errorsNick Gerace
- Fix error when remote is not "origin" and fallback to alternate remotes if "origin" is not found - Add failure scenario to core integration test - Fix error where "gfold.toml" not existing would result in execution failure - Add config file lookup behavior to README - Remove debug flag in favor of RUST_LOG - This also results in the logging module being removed since setting the logging should be configured via RUST_LOG - Add RUST_LOG and RUST_BACKTRACE to README and CLI help troubleshooting sections - Update display flags in README to use `-d` - Update flag description for color to use "never" instead of "off" as one of its options - Add sequencing debug logs (e.g. "foo has completed") - Switch back to anyhow for its backtrace feature - Update to 4.0.0-rc.2 Signed-off-by: Nick Gerace <nickagerace@gmail.com>
2022-03-30Enable multi-platform developmentNick Gerace
TLDR: remove barriers to multi-platform development, like Bash and Make. Moreover, remove the nightly fmt dependency and improve testing to catch potential corner cases on multiple platforms. Core: - Rename "Reports" to "LabeledReports" since "Reports" is not of implied type Vec<Report> Testing: - Add second half to the integration test: comparing found reports with expected reports - Essentially, we run the core gfold loop _again_, but only generate reports and skip displaying them to stdout CI: - Removed nightly fmt check and job - Moved fmt check to stable - Update bors toml to match changes Scripts: - Convert scripts from Bash scripts to independent crates (multi-platform friendly) - Add README to scripts directory - Ensure script crates do not have their Cargo lockfile tracked in Git Docs: - Adding DEVELOPING file to replace Makefile - Move THANKS and RELEASE files to new docs directory, along with DEVELOPING - Replace make commands in README and RELEASE files Misc: - Remove Rust nightly dependency since it was solely for imports granulaity for rustfmt - This repository is once again only reliant on stable Rust toolchains - Remove "rust-version" from Cargo toml since it was unused - Remove Makefile entirely in favor of DEVELOPING file (multi-platform friendly) - Update markdown code block languages as "shell" instead of "bash" to be multi-platform friendly Signed-off-by: Nick Gerace <nickagerace@gmail.com>
2021-09-15Convert library-driven structure to application-drivenNick Gerace
Convert library-driven structure to application-driven. Remove library. Remove EXTRA and DEVELOPING files. Move remaining docs to root. Create types file in favor of types within modules. Add tag workflow for prereleases and releases without artifacts. Remove Config struct for Driver.
2021-07-15Move special thanks to THANKS.mdNick Gerace
2021-06-17Rename advanced to extraNick Gerace
2021-06-17Move docs to their own directory and simplify READMENick Gerace