diff options
author | fche <fche> | 2007-01-15 20:12:49 +0000 |
---|---|---|
committer | fche <fche> | 2007-01-15 20:12:49 +0000 |
commit | d633e387e0ad67821c476e5a75260a98306370f9 (patch) | |
tree | f04bcefa0a81da68e79c54807f05042846b50475 /HACKING | |
parent | 3948f93497412e0c4753bf02e5ddc35ced2f39de (diff) | |
download | systemtap-steved-d633e387e0ad67821c476e5a75260a98306370f9.tar.gz systemtap-steved-d633e387e0ad67821c476e5a75260a98306370f9.tar.xz systemtap-steved-d633e387e0ad67821c476e5a75260a98306370f9.zip |
* point to NEWS
Diffstat (limited to 'HACKING')
-rw-r--r-- | HACKING | 11 |
1 files changed, 7 insertions, 4 deletions
@@ -59,7 +59,8 @@ the <systemtap@sources.redhat.com> mailing list. code. One must tread carefully and run regression tests rigorously. Both positive and negative polarity (expect-pass / expect-fail) test cases may need to be written to assert a bug fix. Script language - changes should be documented in the stap.1 man page. + changes should be documented in the stap.1 man page and emphasized + in the NEWS file. - tapsets @@ -69,9 +70,11 @@ the <systemtap@sources.redhat.com> mailing list. It may be necessary to prefix symbols with the tapset name to ensure systemtap-wide uniqueness. All "external interfaces" expected to be used by user scripts (or perhaps other tapsets) should be documented - in stapfuncs.5, stapprobes.5. Internal function, variable, probe - identifiers should be prefixed with "_" for extra uniqueness, and - not documented in the man pages. + in stapfuncs.5, stapprobes.5. Major or incompatible changes should + be mentioned in the NEWS file. + + Internal function, variable, probe identifiers should be prefixed + with "_" for extra uniqueness, and not documented in the man pages. Tapsets should come with a tests cases that provide good test coverage. Every alias definition should be tested for pass-2 correctness. Every |