Re: [Ganglia-developers] Writing a Makefile for manpages in mans/
On Mon, Feb 28, 2011 at 12:11:16PM -0800, Bernard Li wrote: > On Sat, Feb 26, 2011 at 8:56 AM, Carlo Marcelo Arenas Belon > wrote: > > > and also requires some post processing for the right formatting : > > > > ?http://www.mail-archive.com/ganglia-developers@lists.sourceforge.net/msg05612.html > > In the email, you said: > > "after the binaries are build then pipe them to help2man, then some > sed to replace the "`" if I recall correctly." > > So do we want "`" or not, because it looks like the code in trunk > right now has "`": obviously I didn't recall correctly ;), specially considering that the source of the backticks is actually gengetopt. > I guess it all depends on the locale of your system. On my RHEL6b2 > system, everything is single quote and there are no "`". which version of help2man?, which locale, and which version of the binaries are you calling that don't have backticks in --help? > Are you aware of any other post-processing that needs to be done? * removing the version (--version-string=" " could help as a workaround) * a descriptive name (-n"manual page for Ganglia Status Tool" for gstat) * removing the misalignment that is added in the DESCRIPTION with the package name, version and the '.SS "Purpose"\n.IP' string which was removed with commit 1132 > I think the only thing left is slightly better formatting for AUTHORS > and COPYING then we can use those as template for the manpages (in my > Makefile I generate a help2man include template that has AUTHORS, > COPYING and BUGS). presume first creating suitable include files for -i > What do you think? since I don't have such Makefile, there is not much I can comment on, but my attempt of generating a test updated man file for gstat showed the formatting was really off compared with the original, so hope you had better luck : $ help2man --version-string=" " -N -n"manual page for Ganglia Status Tool" -i AUTHORS -i COPYING ./gstat > ../mans/gstat.1 Carlo PS. using help2man 1.38.2 -- Free Software Download: Index, Search & Analyze Logs and other IT data in Real-Time with Splunk. Collect, index and harness all the fast moving IT data generated by your applications, servers and devices whether physical, virtual or in the cloud. Deliver compliance at lower cost and gain new business insights. http://p.sf.net/sfu/splunk-dev2dev ___ Ganglia-developers mailing list Ganglia-developers@lists.sourceforge.net https://lists.sourceforge.net/lists/listinfo/ganglia-developers
Re: [Ganglia-developers] Writing a Makefile for manpages in mans/
Hi Carlo: On Sat, Feb 26, 2011 at 8:56 AM, Carlo Marcelo Arenas Belon wrote: > and also requires some post processing for the right formatting : > > http://www.mail-archive.com/ganglia-developers@lists.sourceforge.net/msg05612.html In the email, you said: "after the binaries are build then pipe them to help2man, then some sed to replace the "`" if I recall correctly." So do we want "`" or not, because it looks like the code in trunk right now has "`": https://sourceforge.net/apps/trac/ganglia/browser/trunk/monitor-core/mans/gmetric.1 I guess it all depends on the locale of your system. On my RHEL6b2 system, everything is single quote and there are no "`". Are you aware of any other post-processing that needs to be done? I think the only thing left is slightly better formatting for AUTHORS and COPYING then we can use those as template for the manpages (in my Makefile I generate a help2man include template that has AUTHORS, COPYING and BUGS). What do you think? Thanks, Bernard -- Free Software Download: Index, Search & Analyze Logs and other IT data in Real-Time with Splunk. Collect, index and harness all the fast moving IT data generated by your applications, servers and devices whether physical, virtual or in the cloud. Deliver compliance at lower cost and gain new business insights. http://p.sf.net/sfu/splunk-dev2dev ___ Ganglia-developers mailing list Ganglia-developers@lists.sourceforge.net https://lists.sourceforge.net/lists/listinfo/ganglia-developers
Re: [Ganglia-developers] Writing a Makefile for manpages in mans/
On Fri, Feb 25, 2011 at 08:34:03PM -0500, Jesse Becker wrote: > On Fri, Feb 25, 2011 at 19:13, Bernard Li wrote: > > Currently maintaining the manpages in mans/ is a manual process. ?One > > would need to know the exact options necessary to generate the > > manpages to have the same format as the one currently in the mans/ > > directory. > > Really? That's...crazy. and also requires some post processing for the right formatting : http://www.mail-archive.com/ganglia-developers@lists.sourceforge.net/msg05612.html Carlo -- Free Software Download: Index, Search & Analyze Logs and other IT data in Real-Time with Splunk. Collect, index and harness all the fast moving IT data generated by your applications, servers and devices whether physical, virtual or in the cloud. Deliver compliance at lower cost and gain new business insights. http://p.sf.net/sfu/splunk-dev2dev ___ Ganglia-developers mailing list Ganglia-developers@lists.sourceforge.net https://lists.sourceforge.net/lists/listinfo/ganglia-developers
Re: [Ganglia-developers] Writing a Makefile for manpages in mans/
On Fri, Feb 25, 2011 at 19:13, Bernard Li wrote: > Currently maintaining the manpages in mans/ is a manual process. One > would need to know the exact options necessary to generate the > manpages to have the same format as the one currently in the mans/ > directory. Really? That's...crazy. > What do people think about adding Makefile targets to generate these > during build time, now that the COPYING, BUGS, AUTHORS file are > relatively in current state which can then be used as manpage > templates. Yes: absolutely. > help2man seems to be readily available in most Linux distributions. > My main concern is other OSes. I guess we could potentially continue > to ship 'stock' man pages in the distribution tarball, however I > noticed that they all have /etc/ganglia hardcoded as the sysconfdir, > so if one were to use a different prefix, the manpages will be > misleading. > > Thoughts? A simple search/replace using your templating program of choice will fix any hard-coded paths. -- Jesse Becker -- Free Software Download: Index, Search & Analyze Logs and other IT data in Real-Time with Splunk. Collect, index and harness all the fast moving IT data generated by your applications, servers and devices whether physical, virtual or in the cloud. Deliver compliance at lower cost and gain new business insights. http://p.sf.net/sfu/splunk-dev2dev ___ Ganglia-developers mailing list Ganglia-developers@lists.sourceforge.net https://lists.sourceforge.net/lists/listinfo/ganglia-developers
