From 9712ab2b521a97c66d194ee8432c55aecba46ab2 Mon Sep 17 00:00:00 2001 From: Karl Williamson Date: Thu, 4 Jul 2019 14:19:42 -0600 Subject: [PATCH] HACKERS: Add info about Hints and Warnings (cherry picked from commit 5df9c36cef7b172a0fe805f209de55cbb87f6ac6) Signed-off-by: Nicolas R --- dist/Devel-PPPort/HACKERS | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) diff --git a/dist/Devel-PPPort/HACKERS b/dist/Devel-PPPort/HACKERS index ff215a4..07289c5 100644 --- a/dist/Devel-PPPort/HACKERS +++ b/dist/Devel-PPPort/HACKERS @@ -191,6 +191,25 @@ A list of the provided API in the C<=provides> section. The implementation to add to F in the C<=implementation> section. +Here you can add additional information for a given item that will be displayed +when F is run. If your item is named C, you add a +comment like so: + + /* Hint: foo + paragraphs of stuff about foo you want to have + shown when ppport.h outputs something about foo + */ + +This will cause S> to display this hint when it outputs +something about C. + +A more serious caution about C can be displayed by instead saying + + /* Warning: foo + paragraphs of stuff about foo you want to have + shown when ppport.h outputs something about foo + */ + =item * The code required to add to PPPort.xs for testing the implementation. -- 1.8.3.1