Skip to content

Commit

Permalink
Fix manpage for service
Browse files Browse the repository at this point in the history
We need `-s` for the pandoc invocation to render this right.

Signed-off-by: Colin Walters <walters@verbum.org>
  • Loading branch information
cgwalters committed Jan 17, 2024
1 parent 7d4a548 commit 44f4b6e
Show file tree
Hide file tree
Showing 3 changed files with 16 additions and 5 deletions.
11 changes: 8 additions & 3 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -10,9 +10,14 @@ install:
install -D -m 0755 -t $(DESTDIR)$(prefix)/bin target/release/bootc
install -d $(DESTDIR)$(prefix)/lib/bootc/install
# Support installing pre-generated man pages shipped in source tarball, to avoid
# a dependency on pandoc downstream
if test -d man; then install -D -m 0644 -t $(DESTDIR)$(prefix)/share/man/man5 man/*.5; fi
if test -d man; then install -D -m 0644 -t $(DESTDIR)$(prefix)/share/man/man8 man/*.8; fi
# a dependency on pandoc downstream. But in local builds these end up in target/man,
# so we honor that too.
for d in man target/man; do \
if test -d $$d; then \
install -D -m 0644 -t $(DESTDIR)$(prefix)/share/man/man5 $$d/*.5; \
install -D -m 0644 -t $(DESTDIR)$(prefix)/share/man/man8 $$d/*.8; \
fi; \
done
install -D -m 0644 -t $(DESTDIR)/$(prefix)/lib/systemd/system systemd/*.service systemd/*.timer

bin-archive: all
Expand Down
8 changes: 7 additions & 1 deletion manpages-md-extra/bootc-fetch-apply-updates.service.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
% bootc-fetch-apply-updates(5)

# NAME

bootc-fetch-apply-updates.service
Expand All @@ -17,11 +19,15 @@ project is enabled for daily updates.
However, it is fully expected that different operating systems
and distributions choose different defaults.

## Customizing updates
# CUSTOMIZING UPDATES

Note that all three of these steps can be decoupled; they
are:

- `bootc upgrade --check`
- `bootc upgrade`
- `bootc upgrade --apply`

# SEE ALSO

**bootc(1)**
2 changes: 1 addition & 1 deletion xtask/src/xtask.rs
Original file line number Diff line number Diff line change
Expand Up @@ -106,7 +106,7 @@ fn manpages(sh: &Shell) -> Result<()> {
.ok_or_else(|| anyhow!("Expected filename in {srcpath:?}"))?;
cmd!(
sh,
"pandoc --from=markdown --to=man --output=target/man/{base_filename}.5 {srcpath}"
"pandoc -s --from=markdown --to=man --output=target/man/{base_filename}.5 {srcpath}"
)
.run()?;
}
Expand Down

0 comments on commit 44f4b6e

Please sign in to comment.