Scripts should contain a comment block describing what the script does.

1 files changed, 13 insertions, 0 deletions

diff --git a/share/man/man7/style.perl.7 b/share/man/man7/style.perl.7
index 5639bfc..51b71df 100644
--- a/share/man/man7/style.perl.7
+++ b/share/man/man7/style.perl.7
@@ -49,12 +49,25 @@ source tree.
  # Fill them so they look like real paragraphs.
 .Ed
 .Pp
+All scripts should follow the copyright block at the start of the
+script with a comment block that describes what the script does.
+.Bd -literal -offset 0i
+ #!/usr/bin/perl -w
+
+ # COPYRIGHT
+ # BLOCK
+
+ # This script processes an old kernel config file, which it gets on
+ # stdin, and outputs a new style hints file to stdout.
+.Ed
 All scripts should use the
 .Fa strict
 module and run without warnings. For example:
 .Bd -literal -offset 0i
  #!/usr/bin/perl -w
 
+ # Copyright, description of what the script does, etc
+
  use strict;
  ...
 .Ed