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

Re: [virt-tools-list] [virt-manager][PATCH 3/3] Update man page author section.



On Wed, Jul 10, 2013 at 01:03:58PM -0400, Cole Robinson wrote:
> Thanks, I pushed the first two. But see below.
> 
> On 07/10/2013 12:14 PM, Leonardo Garcia wrote:
> > From: Leonardo Garcia <lagarcia br ibm com>
> > 
> > ---
> >  man/virt-manager.pod |    2 +-
> >  1 files changed, 1 insertions(+), 1 deletions(-)
> > 
> > diff --git a/man/virt-manager.pod b/man/virt-manager.pod
> > index f8e4d4b..a33955e 100644
> > --- a/man/virt-manager.pod
> > +++ b/man/virt-manager.pod
> > @@ -85,7 +85,7 @@ Standard GTK options like --g-fatal-warnings are also accepted.
> >  
> >  =head1 AUTHOR
> >  
> > -Written by Daniel P. Berrange and Cole Robinson.
> > +Written by Daniel P. Berrange, Cole Robinson, and Leonardo Garcia.
> >  
> >  =head1 BUGS
> >  
> 
> I always took this to mean 'virt-manager authors' and not specifically 'man
> page authors', but it appears there's examples of both in the wild. It's tough
> to do lists like this without overlooking someone or creating maintenance
> burden. My recommendation for this in order is:
> 
> 1) Drop the AUTHORS section from every man page
> 2) Clarify the AUTHORS section from each man page to mean 'application
> authors', drop all hardcoded names, and say 'see the git log' or provide a
> link to cgit.
> 3) Clarify that this is 'man page authors' Be fair and do some git archaeology
> to determine every person that has touched these files and list them all (I
> actually won't take a patch for this, just listing it for completeness).

http://linux.die.net/man/7/man-pages

  "AUTHORS

  lists authors of the documentation or program. Use of an AUTHORS section
  is strongly discouraged. Generally, it is better not to clutter every
  page with a list of (over time potentially numerous) authors; if you
  write or significantly amend a page, add a copyright notice as a comment
  in the source file. If you are the author of a device driver and want to
  include an address for reporting bugs, place this under the BUGS section. "

Which means do your option 1).

Daniel
-- 
|: http://berrange.com      -o-    http://www.flickr.com/photos/dberrange/ :|
|: http://libvirt.org              -o-             http://virt-manager.org :|
|: http://autobuild.org       -o-         http://search.cpan.org/~danberr/ :|
|: http://entangle-photo.org       -o-       http://live.gnome.org/gtk-vnc :|


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