d/freebsd-dev
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

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

Browse Source
This commit is contained in:
joe 2000-10-19 18:18:35 +00:00
parent 093cfc269a
commit 6eb0c7db2a
1 changed files with 13 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
share/man/man7/style.perl.7
View File

@ -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