Bug 228353

Summary: articles/committers-guide: Document "Sponsored by:" commit log line
Product: Documentation Reporter: John W. O'Brien <john>
Component: Books & ArticlesAssignee: freebsd-doc (Nobody) <doc>
Status: Closed FIXED    
Severity: Affects Some People CC: eadler, pi
Priority: ---    
Version: Latest   
Hardware: Any   
OS: Any   
Bug Depends on:    
Bug Blocks: 228362    
Attachments:
Description Flags
articles/committers-guide: Document "Sponsored by" none

Description John W. O'Brien 2018-05-18 23:33:57 UTC 
Created attachment 193524 [details]
articles/committers-guide: Document "Sponsored by"

Problem statement
=================

1.  The "Sponsored By" line is not documented in the Committers' Guide, through it has been included in the FreeBSD-specific patch to the devel/subversion port since March, 2013 [0].

2.  Common practice for using the "Sponsored By" line does not handle well the case where a commit is the result of work by multiple individuals who typically have different sponsorship including some who have no sponsorship at all. In this case, a sponsorship credit tends to have the unintended implication that the work of all collaborators was sponsored and by the same sponsor, which is rarely the case.

[0] https://svnweb.freebsd.org/changeset/ports/314983


Discussion
==========

A preliminary discussion of the problem statement and the concept for this patch took place on the freebsd-ports@ list [1].

[1] https://lists.freebsd.org/pipermail/freebsd-ports/2018-May/113352.html


Proposed solution
=================

The attached patch contributes documentation (in English) to address both parts of the problem statement.


Translations
============

The Committers' Guide is offered in English, French, Italian, and Russian, so a full solution should include patches for the other three languages.
Comment 1 commit-hook freebsd_committer freebsd_triage 2018-07-22 22:38:24 UTC 
A commit references this bug:

Author: wblock
Date: Sun Jul 22 22:38:14 UTC 2018
New revision: 52048
URL: https://svnweb.freebsd.org/changeset/doc/52048

Log:
  Address problems reported by John O'Brien in 228353. My changes differ
  from the patch included with that bug report, mostly by being more
  general and hopefully head off some bikeshed discussions.

  PR:		228353
  Submitted by:	John W. O'Brien <john@saltant.com>

Changes:
  head/en_US.ISO8859-1/articles/committers-guide/article.xml