Issue #7675 has been updated by Nick Fagerlund.
I think this request is about the difference between the generated text and the compiled formatted `man`-ready text. We generate a bunch of odd markdown-like dialect, which is perfectly readable but a bit messy looking. But it's meant to be processed by a Ruby tool called "ronn," which turns that into roff-formatted text that can be consumed by the regular system `man` tool. Originally we wanted this to be done on the fly on the user's system when they ran puppet man -- this would be the best of both worlds, with up-to-date text hauled directly from the code, plus good formatting. Unfortunately, ronn turns out to be a somewhat idiosyncratic tool that requires native extensions, so we couldn't vendor it and we couldn't justifiably make it a packaging/gem requirement for Puppet, because deps are bad. So now we'd like an automated way to use ronn to generate STATIC man pages whenever we build packages. This way we can get users pretty-much up-to-date text, if they're installing from packages, as well as good formatting. We may also wish to modify the behavior of puppet man to use the system puppet manpages if available; if we don't, the tool we've been telling people to use will give a second-class experience. This automated build interface should also offer an interface to ronn's ability to generate HTML fragments, so that we can use it in both the packaging toolchain and the docs site toolchain. It should furthermore be able to handle both legacy applications and faces applications. Further furthermore, it should have some hardcoded workaround for the fact that we shipped a face with the same name as a legacy application (`resource`) and have been regretting it ever since. Does that clear this up? ---------------------------------------- Feature #7675: Generate static manpages from the dynamic data https://projects.puppetlabs.com/issues/7675#change-81543 Author: Nigel Kersten Status: Needs More Information Priority: Normal Assignee: Nigel Kersten Category: Target version: Affected Puppet version: Keywords: Branch: As per #7562 we have dynamically generated man page info for "puppet man". We need to take this work and use it to generate static manpages for the actual distribution. This should probably be part of install.rb so our packaging folks downstream can just use their existing tools to generate packages. -- You have received this notification because you have either subscribed to it, or are involved in it. To change your notification preferences, please click here: http://projects.puppetlabs.com/my/account -- You received this message because you are subscribed to the Google Groups "Puppet Bugs" group. To post to this group, send email to [email protected]. To unsubscribe from this group, send email to [email protected]. For more options, visit this group at http://groups.google.com/group/puppet-bugs?hl=en.
