Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: generate man page via xtask #157

Merged
merged 2 commits into from
Sep 7, 2024
Merged

docs: generate man page via xtask #157

merged 2 commits into from
Sep 7, 2024

Conversation

reubeno
Copy link
Owner

@reubeno reubeno commented Sep 3, 2024

No description provided.

Copy link

github-actions bot commented Sep 3, 2024

Test Results

408 tests   394 ✅  25s ⏱️
 67 suites   14 💤
 11 files      0 ❌

Results for commit e8e0c70.

♻️ This comment has been updated with latest results.

Copy link

github-actions bot commented Sep 3, 2024

Performance Benchmark Report

Benchmark name Baseline (μs) Test/PR (μs) Delta (μs) Delta %
expand_one_string 3.60 μs 3.60 μs -0.00 μs ⚪ Unchanged
instantiate_shell 59.54 μs 59.33 μs -0.21 μs ⚪ Unchanged
instantiate_shell_with_init_scripts 27167.90 μs 27491.44 μs 323.54 μs ⚪ Unchanged
parse_bash_completion 5573.48 μs 5549.61 μs -23.87 μs ⚪ Unchanged
parse_sample_script 8.89 μs 9.07 μs 0.18 μs 🟠 +2.04%
run_echo_builtin_command 93.33 μs 92.67 μs -0.66 μs ⚪ Unchanged
run_one_builtin_command 112.22 μs 110.61 μs -1.62 μs ⚪ Unchanged
run_one_external_command 1906.77 μs 1925.50 μs 18.73 μs 🟠 +0.98%
run_one_external_command_directly 999.80 μs 1003.26 μs 3.46 μs ⚪ Unchanged

Code Coverage Report: Only Changed Files listed

Package Base Coverage New Coverage Difference
brush-core/src/arithmetic.rs 🟢 98.6% 🟢 97.44% 🔴 -1.16%
brush-core/src/builtins/alias.rs 🟢 83.87% 🟠 66.67% 🔴 -17.2%
brush-core/src/builtins/break_.rs 🟢 90% 🟢 77.78% 🔴 -12.22%
brush-core/src/builtins/builtin_.rs 🟢 100% 🟢 94.12% 🔴 -5.88%
brush-core/src/builtins/cd.rs 🟢 88.57% 🟠 75% 🔴 -13.57%
brush-core/src/builtins/command.rs 🟢 93.26% 🟢 91.25% 🔴 -2.01%
brush-core/src/builtins/complete.rs 🔴 21.48% 🔴 19.95% 🔴 -1.53%
brush-core/src/builtins/continue_.rs 🟢 91.67% 🟢 81.82% 🔴 -9.85%
brush-core/src/builtins/declare.rs 🟢 82.83% 🟢 81.64% 🔴 -1.19%
brush-core/src/builtins/dirs.rs 🟢 90.48% 🟢 84.38% 🔴 -6.1%
brush-core/src/builtins/dot.rs 🟢 95.65% 🟢 90% 🔴 -5.65%
brush-core/src/builtins/echo.rs 🟢 86.84% 🟢 81.82% 🔴 -5.02%
brush-core/src/builtins/enable.rs 🟢 91.07% 🟠 71.74% 🔴 -19.33%
brush-core/src/builtins/eval.rs 🟢 100% 🟢 88.89% 🔴 -11.11%
brush-core/src/builtins/exec.rs 🟢 90.32% 🟢 85.19% 🔴 -5.13%
brush-core/src/builtins/export.rs 🟢 88.73% 🟠 72.55% 🔴 -16.18%
brush-core/src/builtins/getopts.rs 🟢 97.7% 🟢 90.79% 🔴 -6.91%
brush-core/src/builtins/help.rs 🟢 90.7% 🟢 90.24% 🔴 -0.46%
brush-core/src/builtins/jobs.rs 🔴 41.86% 🔴 25.64% 🔴 -16.22%
brush-core/src/builtins/let_.rs 🟢 100% 🟢 88.89% 🔴 -11.11%
brush-core/src/builtins/popd.rs 🟢 94.12% 🟢 91.67% 🔴 -2.45%
brush-core/src/builtins/printf.rs 🟢 91.18% 🟢 82.61% 🔴 -8.57%
brush-core/src/builtins/pushd.rs 🟢 91.3% 🟢 88.89% 🔴 -2.41%
brush-core/src/builtins/pwd.rs 🟢 89.47% 🟠 69.23% 🔴 -20.24%
brush-core/src/builtins/read.rs 🟢 76.69% 🟠 68.06% 🔴 -8.63%
brush-core/src/builtins/return_.rs 🟢 83.33% 🟠 75% 🔴 -8.33%
brush-core/src/builtins/set.rs 🟢 76.64% 🟠 68.47% 🔴 -8.17%
brush-core/src/builtins/shift.rs 🟢 100% 🟢 94.44% 🔴 -5.56%
brush-core/src/builtins/shopt.rs 🟢 88.39% 🟠 69.05% 🔴 -19.34%
brush-core/src/builtins/test.rs 🟢 100% 🟢 85% 🔴 -15%
brush-core/src/builtins/trap.rs 🟢 82.95% 🟠 71.6% 🔴 -11.35%
brush-core/src/builtins/type_.rs 🟢 90.27% 🟢 79.01% 🔴 -11.26%
brush-core/src/builtins/unset.rs 🟢 94.64% 🟢 80% 🔴 -14.64%
brush-core/src/builtins/wait.rs 🟢 85.71% 🟠 65% 🔴 -20.71%
brush-core/src/completion.rs 🔴 42.73% 🔴 42.92% 🟢 0.19%
brush-core/src/escape.rs 🟢 84.52% 🟢 83.87% 🔴 -0.65%
brush-core/src/interp.rs 🟢 93.47% 🟢 89.02% 🔴 -4.45%
brush-core/src/shell.rs 🟢 78.11% 🟢 77.69% 🔴 -0.42%
brush-core/src/sys/unix/fs.rs 🟠 54.76% 🟠 56.41% 🟢 1.65%
brush-interactive/src/interactive_shell.rs 🟢 77.21% 🟢 76.96% 🔴 -0.25%
brush-shell/src/args.rs 🔴 0% 🟠 61.9% 🟢 61.9%
brush-shell/src/brushctl.rs 🔴 16.67% 🔴 17.14% 🟢 0.47%
brush-shell/src/main.rs 🟢 80.43% 🟢 88.54% 🟢 8.11%
Overall Coverage 🟢 78.09% 🟢 76.24% 🔴 -1.85%

Minimum allowed coverage is 70%, this run produced 76.24%

@reubeno reubeno merged commit 44aede7 into main Sep 7, 2024
10 checks passed
@reubeno reubeno deleted the gen-man-page branch September 7, 2024 06:52
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant