This is the mail archive of the systemtap@sourceware.org mailing list for the systemtap project.

Index Nav: [Date Index] [Subject Index] [Author Index] [Thread Index]
Message Nav: [Date Prev] [Date Next] [Thread Prev] [Thread Next]
Other format: [Raw text]

Re: [PATCH] tty: Adding tty.stp to the documentation

On 10/20/2009 11:08 AM, leitao@linux.vnet.ibm.com wrote:
> Adding the TTY tapset to the .tmpl Reference documentation
> ---
>  doc/SystemTap_Tapset_Reference/tapsets.tmpl |    9 +++++++++
>  1 files changed, 9 insertions(+), 0 deletions(-)
> 
> diff --git a/doc/SystemTap_Tapset_Reference/tapsets.tmpl b/doc/SystemTap_Tapset_Reference/tapsets.tmpl
> index 705cd3b..909dcfb 100644
> --- a/doc/SystemTap_Tapset_Reference/tapsets.tmpl
> +++ b/doc/SystemTap_Tapset_Reference/tapsets.tmpl
> @@ -164,6 +164,15 @@
>  !Itapset/scsi.stp
>    </chapter>
>  
> +  <chapter id="tty.stp">
> +    <title>TTY Tapset</title>
> +    <para>
> +      This family of probe points is used to probe TTY (Teletype) activities.  
> +      It contains the following probe points:
> +    </para>
> +!Itapset/scsi.stp
> +  </chapter>
> +

Note the copy/paste error on !I...

Please double-check that the docs are generated correctly.  For example,
both tty.open and tty.release* have an extra space:

> + * @inode _flags: the inode flags

Thanks,

Josh


* Perhaps this should be called tty.close?  I realize that the functions
you're probing have these imbalanced names, but that doesn't mean we
have to follow suit in the tapset.
Index Nav: [Date Index] [Subject Index] [Author Index] [Thread Index]
Message Nav: [Date Prev] [Date Next] [Thread Prev] [Thread Next]