[PATCH] Git::SVN::*: add missing "NAME" section to perldoc

Jonathan Nieder· May 5, 2013, 07:50 UTC · lore

lexgrog(1) relies on the NAME section to find a manpage's subject's name and description for easy access later using "man -k". Add the section it expects.

Noticed using lintian.

Signed-off-by: Jonathan Nieder <jrnieder@gmail.com>
---
Hi Eric,

Just noticed this by running a tool to sanity-check my build result. I hadn't noticed before because I hadn't been installing the manpages. Anyway, perhaps the patch can be useful.

 perl/Git/SVN/Editor.pm  | 2 ++
 perl/Git/SVN/Fetcher.pm | 2 ++
 perl/Git/SVN/Prompt.pm  | 2 ++
 perl/Git/SVN/Ra.pm      | 2 ++
 4 files changed, 8 insertions(+)

Show changes to 4 files +8 −0

perl/Git/SVN/Editor.pm, perl/Git/SVN/Fetcher.pm, perl/Git/SVN/Prompt.pm, perl/Git/SVN/Ra.pm

diff --git a/perl/Git/SVN/Editor.pm b/perl/Git/SVN/Editor.pm
index fa0d3c6c..b3bcd476 100644
--- a/perl/Git/SVN/Editor.pm
+++ b/perl/Git/SVN/Editor.pm
@@ -499,6 +499,8 @@ sub apply_diff {
 1;
 __END__
 
+=head1 NAME
+
 Git::SVN::Editor - commit driver for "git svn set-tree" and dcommit
 
 =head1 SYNOPSIS
diff --git a/perl/Git/SVN/Fetcher.pm b/perl/Git/SVN/Fetcher.pm
index 046a7a2f..72150af6 100644
--- a/perl/Git/SVN/Fetcher.pm
+++ b/perl/Git/SVN/Fetcher.pm
@@ -512,6 +512,8 @@ sub stash_placeholder_list {
 1;
 __END__
 
+=head1 NAME
+
 Git::SVN::Fetcher - tree delta consumer for "git svn fetch"
 
 =head1 SYNOPSIS
diff --git a/perl/Git/SVN/Prompt.pm b/perl/Git/SVN/Prompt.pm
index 74daa7a5..e940b085 100644
--- a/perl/Git/SVN/Prompt.pm
+++ b/perl/Git/SVN/Prompt.pm
@@ -125,6 +125,8 @@ sub _read_password {
 1;
 __END__
 
+=head1 NAME
+
 Git::SVN::Prompt - authentication callbacks for git-svn
 
 =head1 SYNOPSIS
diff --git a/perl/Git/SVN/Ra.pm b/perl/Git/SVN/Ra.pm
index 6a212eb7..75ecc425 100644
--- a/perl/Git/SVN/Ra.pm
+++ b/perl/Git/SVN/Ra.pm
@@ -627,6 +627,8 @@ sub skip_unknown_revs {
 1;
 __END__
 
+=head1 NAME
+
 Git::SVN::Ra - Subversion remote access functions for git-svn
 
 =head1 SYNOPSIS

-- 
1.8.3.rc1

Eric Wong· May 9, 2013, 01:08 UTC · re: Jonathan Nieder · lore

Re: [PATCH] Git::SVN::*: add missing "NAME" section to perldoc

Jonathan Nieder <jrnieder@gmail.com> wrote:

> Just noticed this by running a tool to sanity-check my build result.
> I hadn't noticed before because I hadn't been installing the manpages.
> Anyway, perhaps the patch can be useful.

Thanks, signed-off and applied, will push.

patchGit::SVN::*: add missing "NAME" section to perldoc