[Date Prev][Date Next] [Thread Prev][Thread Next] [Date Index] [Thread Index]

Example of proposed pod usage (with patch)



Here is an example of how I think pod might work;
---
 README.developers |    6 ++++-
 frontend/lintian  |   60 ++++++++++++++++++++++++++++++++++------------------
 2 files changed, 44 insertions(+), 22 deletions(-)

diff --git a/README.developers b/README.developers
index dc1edd0..ca4b206 100644
--- a/README.developers
+++ b/README.developers
@@ -1,4 +1,6 @@
-README.Developers for the Lintian tool
+=pod
+
+Readme.Developers for the Lintian tool
 ---
 
 Lintian dissects Debian packages and tries to find bugs and policy
@@ -13,3 +15,5 @@ directory "frontend." This directory holds the "lintian" executable.
 This is what gets called when a user calls lintian. The frontend
 then calls the lintian checks which run over the Debian package 
 that Lintian is checking.
+
+=end
diff --git a/frontend/lintian b/frontend/lintian
index 0625b61..907e747 100755
--- a/frontend/lintian
+++ b/frontend/lintian
@@ -1,27 +1,45 @@
 #!/usr/bin/perl -w
-# {{{ Legal stuff
-# Lintian -- Debian package checker
-#
-# Copyright (C) 1998 Christian Schwarz and Richard Braakman
-#
-# This program is free software.  It is distributed under the terms of
-# the GNU General Public License as published by the Free Software
-# Foundation; either version 2 of the License, or (at your option) any
-# later version.
-#
-# This program is distributed in the hope that it will be useful,
-# but WITHOUT ANY WARRANTY; without even the implied warranty of
-# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-# GNU General Public License for more details.
-#
-# You should have received a copy of the GNU General Public License
-# along with this program.  If not, you can find it on the World Wide
-# Web at http://www.gnu.org/copyleft/gpl.html, or write to the Free
-# Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston,
-# MA 02110-1301, USA.
-# }}}
+
+=head1 NAME
+
+Lintian -- Debian package checker
+
+=over 2
+
+=item ./frontend/lintian
+
+=back
+
+=head1 LEGAL
+
+=over 2
+
+Copyright (C) 1998 Christian Schwarz and Richard Braakman
+
+This program is free software.  It is distributed under the terms of
+the GNU General Public License as published by the Free Software
+Foundation; either version 2 of the License, or (at your option) any
+later version.
+
+This program is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+GNU General Public License for more details.
+
+You should have received a copy of the GNU General Public License
+along with this program.  If not, you can find it on the World Wide
+Web at http://www.gnu.org/copyleft/gpl.html, or write to the Free
+Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston,
+MA 02110-1301, USA.
+
+=back
+
+=cut
+
+
 
 # {{{ libraries and such
+
 use strict;
 use warnings;


Reply to: