public inbox for frysk@sourceware.org
 help / color / mirror / Atom feed
From: Andrew Cagney <cagney@redhat.com>
To: Mark Wielaard <mark@klomp.org>
Cc: frysk <frysk@sourceware.org>
Subject: Re: Put refpurposes one line for easy manpage generation.
Date: Thu, 03 Apr 2008 14:25:00 -0000	[thread overview]
Message-ID: <47F4E516.4070000@redhat.com> (raw)
In-Reply-To: <1207230707.4284.11.camel@localhost.localdomain>

Mark,

Our man pages are in XML for a reason; surely we can make use of that.  
A short script should do it.

Andrew


Mark Wielaard wrote:
> Hi,
>
> This puts all refpurpose tags and content on one line for better manpage
> generation. Also did an upload-manpages. The currrent script expects
> this tag and matching closing tag on one line, if it isn't the
> description on the man index page will be empty (if someone knows some
> sed foo to make this more flexible that would be appreciated).
> http://sourceware.org/frysk/manpages/
>
>     frysk-core/frysk/bindir/ChangeLog
>     2008-04-03  Mark Wielaard  <mwielaard@redhat.com>
>     
>            * fdebuginfo.xml: Put refpurpose on one line.
>            * ferror.xml: Likewise.
>            * fexe.xml: Likewise.
>            * fmaps.xml: Likewise.
>
> diff --git a/frysk-core/frysk/bindir/fdebuginfo.xml b/frysk-core/frysk/bindir/fdebuginfo.xml
> index c641219..3798c06 100644
> --- a/frysk-core/frysk/bindir/fdebuginfo.xml
> +++ b/frysk-core/frysk/bindir/fdebuginfo.xml
> @@ -70,8 +70,7 @@
>  
>    <refnamediv>
>      <refname>fdebuginfo</refname>
> -    <refpurpose>display the debug-info paths for a process and its
> -    shared modules</refpurpose>
> +    <refpurpose>display the debug-info paths for a process and its shared modules</refpurpose>
>    </refnamediv>
>    
>    <refsynopsisdiv>
> diff --git a/frysk-core/frysk/bindir/ferror.xml b/frysk-core/frysk/bindir/ferror.xml
> index 5a1cf8d..6d4bc90 100644
> --- a/frysk-core/frysk/bindir/ferror.xml
> +++ b/frysk-core/frysk/bindir/ferror.xml
> @@ -70,8 +70,7 @@
>  
>    <refnamediv>
>      <refname>ferror</refname>
> -    <refpurpose>print a stack trace when the given message is printed
> -    by the traced program</refpurpose>
> +    <refpurpose>print a stack trace when the given message is printed by the traced program</refpurpose>
>    </refnamediv>
>    
>    <refsynopsisdiv>
> diff --git a/frysk-core/frysk/bindir/fexe.xml b/frysk-core/frysk/bindir/fexe.xml
> index bb7d91c..2c7a4c7 100644
> --- a/frysk-core/frysk/bindir/fexe.xml
> +++ b/frysk-core/frysk/bindir/fexe.xml
> @@ -70,8 +70,7 @@
>  
>    <refnamediv>
>      <refname>fexe</refname>
> -    <refpurpose>print a process or corefile's executable
> -    path</refpurpose>
> +    <refpurpose>print a process or corefile's executable path</refpurpose>
>    </refnamediv>
>    
>    <refsynopsisdiv>
> diff --git a/frysk-core/frysk/bindir/fmaps.xml b/frysk-core/frysk/bindir/fmaps.xml
> index df0c35a..692967e 100644
> --- a/frysk-core/frysk/bindir/fmaps.xml
> +++ b/frysk-core/frysk/bindir/fmaps.xml
> @@ -70,8 +70,7 @@
>  
>    <refnamediv>
>      <refname>fmaps</refname>
> -    <refpurpose>print the process or a corefile's address
> -    maps.</refpurpose>
> +    <refpurpose>print the process or a corefile's address maps.</refpurpose>
>    </refnamediv>
>    
>    <refsynopsisdiv>
>
>
>
>   

  reply	other threads:[~2008-04-03 14:10 UTC|newest]

Thread overview: 7+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2008-04-03 14:10 Mark Wielaard
2008-04-03 14:25 ` Andrew Cagney [this message]
2008-04-03 14:40   ` Mark Wielaard
2008-04-03 21:03     ` Andrew Cagney
2008-04-03 21:11       ` Mark Wielaard
2008-04-04  8:32         ` Petr Machata
2008-04-04  9:16           ` Mark Wielaard

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=47F4E516.4070000@redhat.com \
    --to=cagney@redhat.com \
    --cc=frysk@sourceware.org \
    --cc=mark@klomp.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).