Bug 11684 - eliminate duplication between language reference guide and generated tapset docs
Summary: eliminate duplication between language reference guide and generated tapset docs
Status: RESOLVED FIXED
Alias: None
Product: systemtap
Classification: Unclassified
Component: documentation (show other bugs)
Version: unspecified
: P2 normal
Target Milestone: ---
Assignee: Lukas Berk
URL:
Keywords:
Depends on:
Blocks:
 
Reported: 2010-06-09 13:20 UTC by Frank Ch. Eigler
Modified: 2010-06-14 14:09 UTC (History)
1 user (show)

See Also:
Host:
Target:
Build:
Last reconfirmed:

Attachments
Add an attachment (proposed patch, testcase, etc.)

Note You need to log in before you can comment on or make changes to this bug.
Description Frank Ch. Eigler 2010-06-09 13:20:40 UTC 
doc/langref.tex contains a lot of tapset details that have become
obsolete and duplicative of the generated stuff in the tapset/*.stp
files and the hand-made stuff in man/tapset::*.

Let's shrink doc/langref.tex to eliminate the duplication.
Comment 1 Lukas Berk 2010-06-14 13:42:11 UTC 
http://fpaste.org/Lrw7/ contains a diff of changes(In reply to comment #0)

basic summary of changes, anything I've found in as a duplicate has been placed
in their corresponding locations (generally in tapset/*.stp). Documentation has
been formatted as follows:

/** function xxxx - note
 *
 * General Syntax: xxxx:xxxx
 *
 * @any variables here
 * 
 * Description: 
 */
> doc/langref.tex contains a lot of tapset details that have become
> obsolete and duplicative of the generated stuff in the tapset/*.stp
> files and the hand-made stuff in man/tapset::*.
> 
> Let's shrink doc/langref.tex to eliminate the duplication.
Comment 2 Lukas Berk 2010-06-14 14:09:30 UTC 
index aad57dc..a5b106c 100644

Documentation has been added in a standardized format throughout the /tapset/*.stp

references have been created in langref.tex to redirect to the proper tapset file.