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: how to avoid a lengthy man page of stapprobes(5)?


-----BEGIN PGP SIGNED MESSAGE-----
Hash: SHA1

Hi,

> We are documenting NFS and RPC tapsets into stapprobes(5) man page. But
> there are more than 60 probe points and each may have 3-5 arguments. If
> we document them in the same way(names, introductions, arguments,
> argument descriptions) as we did for other tapsets, it will make the
> stapprobe man page too long. And finally the user may find it difficult
> to find something there.
> 
> So one way is to list probe point names and a short description in the
> manual page and guide the user to read the comments in the source for
> more details, i.e, the arguments and the description for each arguments
> if he wants to. Another way is that we need some better rearrangement of
> the stapprobe man page's layout to make it easier to find the desired
> probe point among a long list.
> 
> Any suggestions?

Is it an option to create manpages of the form

stapprobes.rpc (5)
stapprobes.nfs (5)
...

and list them in the main man page?

Bjoern
-----BEGIN PGP SIGNATURE-----
Version: GnuPG v1.4.5 (GNU/Linux)
Comment: Using GnuPG with Mozilla - http://enigmail.mozdev.org

iD8DBQFFCtZrP5ijxgQLUNkRAsFvAJ9IFjoiOaK+yqfazSt5R/Bos0nntACcDszv
4msn04WT6Px+HwwQJFSpNTk=
=6ve5
-----END PGP SIGNATURE-----


Index Nav: [Date Index] [Subject Index] [Author Index] [Thread Index]
Message Nav: [Date Prev] [Date Next] [Thread Prev] [Thread Next]