Changeset View
Standalone View
en_US.ISO8859-1/books/porters-handbook/makefiles/chapter.xml
Show First 20 Lines • Show All 2,713 Lines • ▼ Show 20 Lines | .endif</programlisting> | ||||
<sect1 xml:id="makefile-maintainer"> | <sect1 xml:id="makefile-maintainer"> | ||||
<title><varname>MAINTAINER</varname></title> | <title><varname>MAINTAINER</varname></title> | ||||
<para>Set your mail-address here. Please. | <para>Set your mail-address here. Please. | ||||
<!-- smiley--> | <!-- smiley--> | ||||
<emphasis>:-)</emphasis></para> | <emphasis>:-)</emphasis></para> | ||||
<para>Note that only a single address without the comment part is | <para>Only a single address without the comment part is | ||||
wblock: "Note" is used way too much, remove it.
"Only a single address..." | |||||
allowed as a <varname>MAINTAINER</varname> value. The format | allowed as a <varname>MAINTAINER</varname> value. The format | ||||
used should be <literal>user@hostname.domain</literal>. Please | used is <literal>user@hostname.domain</literal>. Please | ||||
Not Done Inline Actionss/should be/is/ wblock: s/should be/is/ | |||||
Not Done Inline Actionss/your/a/ to avoid use of "you" and "your". wblock: s/your/a/ to avoid use of "you" and "your". | |||||
do not include any descriptive text such as your real name in | do not include any descriptive text such as a real name in | ||||
this entry—that merely confuses | this entry. That merely confuses the Ports infrastructure | ||||
<filename>bsd.port.mk</filename>.</para> | and most tools using it.</para> | ||||
Not Done Inline ActionsI like emdashes, but this is simpler as two sentences. "this entry. That merely..." wblock: I like emdashes, but this is simpler as two sentences.
"this entry. That merely..." | |||||
<para>The maintainer is responsible for keeping the port up to | <para>The maintainer is responsible for keeping the port up to | ||||
date, and ensuring the port works correctly. For a detailed | date and making sure that it works correctly. For a detailed | ||||
Not Done Inline ActionsThe maintainer is responsible for keeping the port up to date and making sure that it works correctly. wblock: The maintainer is responsible for keeping the port up to date and making sure that it works… | |||||
description of the responsibilities of a port maintainer, refer | description of the responsibilities of a port maintainer, refer | ||||
to the <link | to <link | ||||
xlink:href="&url.articles.contributing-ports;/maintain-port.html">The | xlink:href="&url.articles.contributing-ports;/maintain-port.html">The | ||||
challenge for port maintainers</link> section.</para> | challenge for port maintainers</link>.</para> | ||||
Not Done Inline Actions"section" seems superfluous there, can just be removed. wblock: "section" seems superfluous there, can just be removed. | |||||
<para>Changes to the port will be sent to the maintainer of a port | <note> | ||||
<para>A maintainer volunteers to keep a port in good working | |||||
order. Maintainers have the primary responsibility for their | |||||
ports, but not exclusive ownership. Ports exist for the | |||||
Not Done Inline ActionsGrammar: This should be "... who the community looks to to take care of the port..." but then that's a (grammatically correct) double word, which sometimes gets flagged (I think igor might flag this for example) and is also somewhat confusing. Perhaps rewording to: The community first looks to the maintainer to take care of the port, but the maintainer is not the only one who may do so. would be good? swills: Grammar: This should be "... who the community looks to to take care of the port..." but then… | |||||
Not Done Inline ActionsHow about A maintainer volunteers to keep a port in good working order. Maintainers have the primary responsibility for their ports, but not exclusive ownership. Ports exist for the benefit of the community and, in reality, belong to the community. What this means is that people other than the maintainer can make changes to a port. Large changes to the Ports Collection might require changes to many ports. The &os; Ports Management Team or members of other teams might modify ports to fix dependency issues or other problems, like a version bump for a shared library update. Some types of fixes have <quote>blanket approval</quote>, allowing any committer to fix those categories of problems on any port. wblock: How about
A maintainer volunteers to keep a port in good working order. Maintainers have the… | |||||
benefit of the community and, in reality, belong to the | |||||
community. What this means is that people other than the | |||||
maintainer can make changes to a port. Large changes to the | |||||
Ports Collection might require changes to many ports. The | |||||
Not Done Inline ActionsPerhaps add: Changes to a port are not solely limited to the port maintainer. There are many others who may make changes to any port, such as the FreeBSD Ports Management Team or members of other teams. Other committers may also make changes to any port to fix dependency or other issues caused by changes they are making, such as updating a shared library. Additionally, there are some types of fixes that are approved for any committer to make to any port. This might be a good place to document the blanket approvals if we plan to keep them forever. swills: Perhaps add:
Changes to a port are not solely limited to the port maintainer. There are many… | |||||
&os; Ports Management Team or members of other teams might | |||||
modify ports to fix dependency issues or other problems, like | |||||
a version bump for a shared library update.</para> | |||||
<para>Some types of fixes have <quote>blanket approval</quote> | |||||
from the &a.portmgr;, allowing any committer to fix those | |||||
categories of problems on any port. These fixes do not need | |||||
Not Done Inline Actionss/Those/These/ wblock: s/Those/These/ | |||||
approvals from the maintainer. Blanket approval do not apply | |||||
Not Done Inline Actionss/approval/approvals/ wblock: s/approval/approvals/ | |||||
wblockUnsubmitted Not Done Inline ActionsOops, my fault! I meant plural on the second one, not the first. approval from the maintainer. Blanket approvals do not apply or alternately approval from the maintainer. Blanket approval does not apply wblock: Oops, my fault! I meant plural on the second one, not the first.
approval from the maintainer. | |||||
to ports that are maintained by teams like <email | |||||
Not Done Inline ActionsThis sentence and the last one in the paragraph above should be combined. The list of blanket approvals ought to be inside the note. wblock: This sentence and the last one in the paragraph above should be combined. The list of blanket… | |||||
Not Done Inline ActionsMixed both paragraphs. mat: Mixed both paragraphs. | |||||
role="nolink">autotools@FreeBSD.org</email>, <email | |||||
Not Done Inline Actions&a.portmgr; and do not require maintainer approval. wblock: &a.portmgr; and do not require maintainer approval. | |||||
role="nolink">x11@FreeBSD.org</email>, <email | |||||
Not Done Inline ActionsThe list of exceptions should be a separate sentence, and not an aside. Blanket approvals do not apply to some ports that are maintained by teams like ... Blanket approval for most ports applies to these types of fixes: wblock: The list of exceptions should be a separate sentence, and not an aside.
Blanket approvals do… | |||||
role="nolink">gnome@FreeBSD.org</email>, or <email | |||||
role="nolink">kde@FreeBSD.org</email>. These teams use | |||||
external repositories and can have work that would conflict | |||||
with changes that would normally fall under blanket | |||||
Not Done Inline ActionsWell, not conflict with the approvals, but with the type of changes that fall under blanket approvals. So maybe ...conflict with changes that would normally fall under blanket approval.</para> wblock: Well, not conflict with the approvals, but with the type of changes that fall under blanket… | |||||
approval.</para> | |||||
Not Done Inline Actionss/Approval/approval/ wblock: s/Approval/approval/ | |||||
<para>Blanket approval for most ports applies to these types of | |||||
fixes:</para> | |||||
<itemizedlist> | |||||
Not Done Inline ActionsThe FDP Primer says to use American spellings unless the document used all British spellings originally, so s/modernising/modernizing/ . wblock: The FDP Primer says to use American spellings unless the document used all British spellings… | |||||
Not Done Inline ActionsI think I wrote modernizing, thought the z was making the word look ugly and replaced it with an s 0:-) mat: I think I wrote modernizing, thought the z was making the word look ugly and replaced it with… | |||||
<listitem> | |||||
<para>Most infrastructure changes to a port (that is, | |||||
modernizing, but not changing the functionality). For | |||||
example, converting to staging, | |||||
<varname>USE_GMAKE</varname> to | |||||
<literal>USES=gmake</literal>, the new | |||||
<varname>LIB_DEPENDS</varname> format...</para> | |||||
</listitem> | |||||
<listitem> | |||||
<para>Trivial and <emphasis>tested</emphasis> build | |||||
fixes.</para> | |||||
</listitem> | |||||
</itemizedlist> | |||||
</note> | |||||
<para>Other changes to the port will be sent to the maintainer | |||||
Not Done Inline Actions"of a port" is not needed. wblock: "of a port" is not needed. | |||||
for review and approval before being committed. If the | for review and approval before being committed. If the | ||||
Not Done Inline ActionsSeems like this should be qualified now. The note we just changed says that many changes already have approval. Are those changes still supposed to be sent to the maintainer before commit? wblock: Seems like this should be qualified now. The note we just changed says that many changes… | |||||
maintainer does not respond to an update request after two weeks | maintainer does not respond to an update request after two weeks | ||||
(excluding major public holidays), then that is considered a | (excluding major public holidays), then that is considered a | ||||
maintainer timeout, and the update may be made without explicit | maintainer timeout, and the update may be made without explicit | ||||
maintainer approval. If the maintainer does not respond within | maintainer approval. If the maintainer does not respond within | ||||
three months, then that maintainer is considered absent without | three months, then that maintainer is considered absent without | ||||
leave, and can be replaced as the maintainer of the particular | leave, and can be replaced as the maintainer of the particular | ||||
port in question. Exceptions to this are anything maintained by | port in question. Exceptions to this are anything maintained by | ||||
the &a.portmgr;, or the &a.security-officer;. No unauthorized | the &a.portmgr;, or the &a.security-officer;. No unauthorized | ||||
commits may ever be made to ports maintained by those | commits may ever be made to ports maintained by those | ||||
groups.</para> | groups.</para> | ||||
<para>We reserve the right to modify the maintainer's submission | <para>We reserve the right to modify the maintainer's submission | ||||
to better match existing policies and style of the Ports | to better match existing policies and style of the Ports | ||||
Collection without explicit blessing from the submitter. Also, | Collection without explicit blessing from the submitter or the | ||||
maintainer. Also, | |||||
large infrastructural changes can result in a port being | large infrastructural changes can result in a port being | ||||
modified without the maintainer's consent. These kinds of | modified without the maintainer's consent. These kinds of | ||||
changes will never affect the port's functionality.</para> | changes will never affect the port's functionality.</para> | ||||
<para>The &a.portmgr; reserves the right to revoke or override | <para>The &a.portmgr; reserves the right to revoke or override | ||||
anyone's maintainership for any reason, and the | anyone's maintainership for any reason, and the | ||||
&a.security-officer; reserves the right to revoke or override | &a.security-officer; reserves the right to revoke or override | ||||
maintainership for security reasons.</para> | maintainership for security reasons.</para> | ||||
▲ Show 20 Lines • Show All 1,899 Lines • Show Last 20 Lines |
"Note" is used way too much, remove it.
"Only a single address..."