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

man: (re)generate man pages from md sources #1018

Merged
merged 10 commits into from
Jun 3, 2024

Conversation

mtomaschewski
Copy link
Member

No description provided.

The `wicked redfish <enable|disable>` commands are aliases to
the unified `wicked firmware <enable|disable> redfish` commands.
Copy link
Collaborator

@cfconrad cfconrad left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The sed command to replace %var% with @var@ must be fixed.

There is also a small typo in the last commit

- changed to WARN on uncommited changes
                     ^^^^^^^^^^

Makefile.am Show resolved Hide resolved
man/Makefile.am Outdated Show resolved Hide resolved
man/Makefile.am Outdated Show resolved Hide resolved
mtomaschewski and others added 2 commits May 31, 2024 21:54
Co-authored-by: cfconrad <cfamullaconrad@suse.com>
Fixed also typos reported by codespell and minior tweaks.
@mtomaschewski
Copy link
Member Author

# ./autogen.sh --disable-pandoc && make distcheck
[...]
make[2]: Entering directory '/root/wicked/git/man'
  GEN      ifcfg-bond.5
  GEN      ifcfg-bonding.5
  GEN      ifcfg-bridge.5
  GEN      ifcfg-dhcp.5
  GEN      ifcfg-infiniband.5
  GEN      ifcfg-lo.5
  GEN      ifcfg-macvlan.5
  GEN      ifcfg-macvtap.5
  GEN      ifcfg-ovs-bridge.5
  GEN      ifcfg-ppp.5
  GEN      ifcfg-tunnel.5
  GEN      ifcfg-vlan.5
  GEN      ifcfg-vxlan.5
  GEN      ifcfg.5
  GEN      ifdown.8
  GEN      ifroute.5
  GEN      ifrule.5
  GEN      ifstatus.8
  GEN      ifsysctl.5
  GEN      ifup.8
  GEN      routes.5
  GEN      wicked-config.5
  GEN      wicked-ethtool.8
  GEN      wicked.7
  GEN      wicked.8
  GEN      wickedd.8
Makefile:725: *** Missing pandoc to regenerate ifcfg-dummy.5.in from src/ifcfg-dummy.5.md .  Schluss.
make[2]: Leaving directory '/root/wicked/git/man'
Makefile:592: recipe for target 'distdir' failed
make[1]: *** [distdir] Error 1
make[1]: Leaving directory '/root/wicked/git'
Makefile:687: recipe for target 'dist' failed
make: *** [dist] Error 2

We commit pre-generated man-page templates along
with their source and it's in the dist archive,
so it's disabled to rebuild them by default.
- changed to WARN on uncommitted changes
- add pandoc not available/enabled warning
Copy link
Collaborator

@cfconrad cfconrad left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@cfconrad cfconrad merged commit 4ed7142 into openSUSE:master Jun 3, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants