Log4php
  1. Log4php
  2. LOG4PHP-1

Remove @author tags in code and document credits in README and website

    Details

    • Type: Task Task
    • Status: Closed
    • Priority: Trivial Trivial
    • Resolution: Fixed
    • Affects Version/s: None
    • Fix Version/s: 2.0.0
    • Component/s: Documentation, Website
    • Labels:
      None

      Description

      Quoted from http://marc.info/?l=log4php-dev&m=118462440903786&w=2

      "@author tags are discouraged in ASF code (http://www.apache.org/
      foundation/records/minutes/2004/board_minutes_2004_09_22.txt, perhaps
      there is a better reference), but there hasn't been any effort to
      remove them in LS code."

      I suggest that we clean out all author tags and document proper credits in README and the website documentation.

      1. patch-noauthors.txt
        29 kB
        Christian Grobmeier

        Activity

        Hide
        Christian Grobmeier added a comment -

        As discussed on the malinglist: author tags removed, use changelog instead.

        Show
        Christian Grobmeier added a comment - As discussed on the malinglist: author tags removed, use changelog instead.
        Hide
        Christian Grobmeier added a comment -

        An contributors.xml file allready exists:
        https://svn.apache.org/repos/asf/incubator/log4php/trunk/src/site/xdoc/contributors.xml

        This file lists more contributors than listed in the source code.

        Show
        Christian Grobmeier added a comment - An contributors.xml file allready exists: https://svn.apache.org/repos/asf/incubator/log4php/trunk/src/site/xdoc/contributors.xml This file lists more contributors than listed in the source code.
        Hide
        Christian Grobmeier added a comment -

        I emailed all guys who are named in the sourcecode.
        Hopefully they wiil agree to the remove (or even return to the project).

        Show
        Christian Grobmeier added a comment - I emailed all guys who are named in the sourcecode. Hopefully they wiil agree to the remove (or even return to the project).
        Hide
        Ceki Gulcu added a comment -

        Indeed, projects can choose their own path in this regard. I am just observing that removing author tags is not as innocuous as it seems and would propose that the issue be reconsidered. Nevertheless, if there is an emerging consensus on this issue, then I will not be standing on your way.

        Show
        Ceki Gulcu added a comment - Indeed, projects can choose their own path in this regard. I am just observing that removing author tags is not as innocuous as it seems and would propose that the issue be reconsidered. Nevertheless, if there is an emerging consensus on this issue, then I will not be standing on your way.
        Hide
        Gavin added a comment -

        Hi Ceki,

        Yes each project is free to choose their own path in this regard. Knowing your background on this project and its sponsoring project logging.apache.org we will not dismiss your concerns lightly. Lets continue to discuss this on the lop4php-dev@logging.apache.org list before we make a decision.

        Thanks.

        Show
        Gavin added a comment - Hi Ceki, Yes each project is free to choose their own path in this regard. Knowing your background on this project and its sponsoring project logging.apache.org we will not dismiss your concerns lightly. Lets continue to discuss this on the lop4php-dev@logging.apache.org list before we make a decision. Thanks.
        Hide
        Ceki Gulcu added a comment -

        My point is that it removing author tags is not good practice. While some Apache projects do not maintain author tags, others do. The board recommendation dating back to 2005 about author tags is highly contested. It is an unfortunate recommendation which should not be taken lightly.

        Show
        Ceki Gulcu added a comment - My point is that it removing author tags is not good practice. While some Apache projects do not maintain author tags, others do. The board recommendation dating back to 2005 about author tags is highly contested. It is an unfortunate recommendation which should not be taken lightly.
        Hide
        Christian Grobmeier added a comment -

        All authors (except apache committers) will be named in the NOTICE file, where the license is specified too. This is good practice at other apache projects too - why shouldn't it work here?

        Show
        Christian Grobmeier added a comment - All authors (except apache committers) will be named in the NOTICE file, where the license is specified too. This is good practice at other apache projects too - why shouldn't it work here?
        Hide
        Ceki Gulcu added a comment -

        Removing the author tags without the consent of the authors is in my humble opinion a questionable action at best. Please leave the author tags as is.

        Show
        Ceki Gulcu added a comment - Removing the author tags without the consent of the authors is in my humble opinion a questionable action at best. Please leave the author tags as is.
        Hide
        Christian Grobmeier added a comment -

        Patch applied. This patch doesn't add authors to readme nor to the website since I think they aren't necessary when everything has been developed within the ASF.

        Show
        Christian Grobmeier added a comment - Patch applied. This patch doesn't add authors to readme nor to the website since I think they aren't necessary when everything has been developed within the ASF.

          People

          • Assignee:
            Knut Urdalen
            Reporter:
            Knut Urdalen
          • Votes:
            0 Vote for this issue
            Watchers:
            0 Start watching this issue

            Dates

            • Created:
              Updated:
              Resolved:

              Development