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

build-sys: Generalize manpage bits to make update-generated #701

Merged
merged 1 commit into from
Jul 17, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,10 @@ validate: validate-rust
ruff check
.PHONY: validate

update-generated:
cargo xtask update-generated
.PHONY: update-generated

vendor:
cargo xtask $@
.PHONY: vendor
Expand Down
13 changes: 7 additions & 6 deletions xtask/src/xtask.rs
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ fn main() {
#[allow(clippy::type_complexity)]
const TASKS: &[(&str, fn(&Shell) -> Result<()>)] = &[
("manpages", manpages),
("man2markdown", man2markdown),
("update-generated", update_generated),
("package", package),
("package-srpm", package_srpm),
("spec", spec),
Expand Down Expand Up @@ -116,12 +116,13 @@ fn manpages(sh: &Shell) -> Result<()> {
Ok(())
}

/// Generate markdown files (converted from the man pages, which are generated
/// from the Rust sources) into docs/src, which ends up in the rendered
/// documentation. This process is currently manual.
#[context("man2markdown")]
fn man2markdown(sh: &Shell) -> Result<()> {
/// Update generated files, such as converting the man pages to markdown.
/// This process is currently manual.
#[context("Updating generated files")]
fn update_generated(sh: &Shell) -> Result<()> {
manpages(sh)?;
// And convert the man pages into markdown, so they can be included
// in the docs.
for ent in std::fs::read_dir("target/man")? {
let ent = ent?;
let path = &ent.path();
Expand Down