Changeset View
Standalone View
en_US.ISO8859-1/articles/committers-guide/article.xml
Show First 20 Lines • Show All 3,988 Lines • ▼ Show 20 Lines | <qandaentry> | ||||
<question> | <question> | ||||
<para>How do I re-add a deleted port?</para> | <para>How do I re-add a deleted port?</para> | ||||
</question> | </question> | ||||
<answer> | <answer> | ||||
<para>This is essentially the reverse of deleting a | <para>This is essentially the reverse of deleting a | ||||
port.</para> | port.</para> | ||||
<important> | |||||
<para>Do not use <command>svn add</command> to add the | |||||
port. Follow these steps. If they are unclear, or are | |||||
not working, ask for help, do not just <command>svn | |||||
add</command> the port.</para> | |||||
</important> | |||||
<procedure> | <procedure> | ||||
<step> | <step> | ||||
<para>Figure out when the port was removed. Use this | <para>Figure out when the port was removed. Use this | ||||
<link | <link | ||||
xlink:href="http://people.freebsd.org/~crees/removed_ports/index.xml">list</link> | xlink:href="http://people.freebsd.org/~crees/removed_ports/index.xml">list</link>, | ||||
or look for the port on <link | |||||
xlink:href="http://www.freshports.org/">freshports</link>, | |||||
and then copy the last living revision of the | and then copy the last living revision of the | ||||
port:</para> | port:</para> | ||||
<screen>&prompt.user; <userinput>cd /usr/ports/<replaceable>category</replaceable></userinput> | <screen>&prompt.user; <userinput>cd /usr/ports/<replaceable>category</replaceable></userinput> | ||||
&prompt.user; <userinput>svn cp 'svn+ssh://svn.freebsd.org/ports/head/<replaceable>category</replaceable>/<replaceable>portname</replaceable>/@{<replaceable>YYYY-MM-DD</replaceable>}' <replaceable>portname</replaceable></userinput></screen> | &prompt.user; <userinput>svn cp 'svn+ssh://svn.freebsd.org/ports/head/<replaceable>category</replaceable>/<replaceable>portname</replaceable>/@<replaceable>XXXXXX</replaceable>' <replaceable>portname</replaceable></userinput></screen> | ||||
<para>Pick a date that is before the removal but after | <para>Pick the revision that is just before the | ||||
the last true commit.</para> | removal. For example, if the revision where it was | ||||
removed is <literal>269874</literal>, use | |||||
<literal>269873</literal>.</para> | |||||
<para>It is also possible to specify a date. In that | |||||
bcr: I would add a sentence stop at the comma here. Otherwise, this whole paragraph consists of only… | |||||
case, pick a date that is before the removal but | |||||
after the last true commit.</para> | |||||
Not Done Inline ActionsThe meaning of "last true commit" is kind of unclear. wblock: The meaning of "last true commit" is kind of unclear. | |||||
<screen>&prompt.user; <userinput>cd /usr/ports/<replaceable>category</replaceable></userinput> | |||||
&prompt.user; <userinput>svn cp 'svn+ssh://svn.freebsd.org/ports/head/<replaceable>category</replaceable>/<replaceable>portname</replaceable>/@{<replaceable>YYYY-MM-DD</replaceable>}' <replaceable>portname</replaceable></userinput></screen> | |||||
</step> | </step> | ||||
<step> | <step> | ||||
<para>Perform whatever changes are necessary to make | <para>Perform whatever changes are necessary to make | ||||
Not Done Inline ActionsThe use of "Perform whatever" is a little weird. How about: Make the changes necessary to get the port working again. wblock: The use of "Perform whatever" is a little weird. How about:
Make the changes necessary to get… | |||||
the port work again. If it was deleted because the | the port work again. If it was deleted because the | ||||
distfiles are no longer available you will need to | distfiles are no longer available you will need to | ||||
Not Done Inline ActionsNeeds a comma at the pause, and avoid using "you": distfiles are no longer available, either volunteer to host the distfiles, or find someone wblock: Needs a comma at the pause, and avoid using "you":
distfiles are no longer available, either… | |||||
volunteer to host them yourself, or find someone | volunteer to host them yourself, or find someone | ||||
else to do so.</para> | else to do so.</para> | ||||
</step> | </step> | ||||
<step> | <step> | ||||
<para><command>svn add</command> or | <para>If some files have been added, or were removed | ||||
<command>svn remove</command> any appropriate | during the resurrection process, use <command>svn | ||||
files.</para> | add</command> or <command>svn remove</command> | ||||
appropriately.</para> | |||||
Not Done Inline ActionsIf I remember my school english correctly, there is something missing here (*looks to native speakers for help*). I think it should say: If some files have been added, or were removed during ... bcr: If I remember my school english correctly, there is something missing here (*looks to native… | |||||
Not Done Inline Actions"appropriately" must be interpreted by the reader. It would be helpful to expand on that, like "to make sure the source control tracking of those files is corrected." (There's probably a better way to say that.) wblock: "appropriately" must be interpreted by the reader. It would be helpful to expand on that, like… | |||||
</step> | </step> | ||||
<step> | <step> | ||||
<para>Restore the <varname>SUBDIR</varname> listing of | <para>Restore the <varname>SUBDIR</varname> listing of | ||||
the port in the parent directory | the port in the parent directory | ||||
<filename>Makefile</filename>, and delete the entry | <filename>Makefile</filename>, keeping the entries | ||||
from <filename>ports/MOVED</filename>.</para> | sorted.</para> | ||||
</step> | </step> | ||||
<step> | <step> | ||||
<para>Delete the port entry from | |||||
<filename>ports/MOVED</filename>.</para> | |||||
</step> | |||||
<step> | |||||
<para>If the port had an entry in | <para>If the port had an entry in | ||||
<filename>ports/LEGAL</filename>, restore it.</para> | <filename>ports/LEGAL</filename>, restore it.</para> | ||||
</step> | </step> | ||||
<step> | <step> | ||||
<para><command>svn commit</command> these changes, | <para><command>svn commit</command> these changes, | ||||
preferably in one step.</para> | preferably in one step.</para> | ||||
</step> | </step> | ||||
▲ Show 20 Lines • Show All 565 Lines • ▼ Show 20 Lines | <question> | ||||
touch?</para> | touch?</para> | ||||
</question> | </question> | ||||
<answer> | <answer> | ||||
<para>Any file directly under <filename>ports/</filename>, | <para>Any file directly under <filename>ports/</filename>, | ||||
or any file under a subdirectory that starts with an | or any file under a subdirectory that starts with an | ||||
uppercase letter (<filename>Mk/</filename>, | uppercase letter (<filename>Mk/</filename>, | ||||
<filename>Tools/</filename>, etc.). In particular, the | <filename>Tools/</filename>, etc.). In particular, the | ||||
Ports Management Team is very protective of | &a.portmgr; is very protective of | ||||
<filename>ports/Mk/bsd.port*.mk</filename> so do not | <filename>ports/Mk/bsd.port*.mk</filename> so do not | ||||
commit changes to those files unless you want to face | commit changes to those files unless you want to face | ||||
their wra(i)th.</para> | their wra(i)th.</para> | ||||
</answer> | </answer> | ||||
</qandaentry> | </qandaentry> | ||||
<qandaentry> | <qandaentry> | ||||
<question> | <question> | ||||
Show All 9 Lines | <answer> | ||||
summary of the relevant diffs between the original and | summary of the relevant diffs between the original and | ||||
new distfile to ensure that the distfile has not been | new distfile to ensure that the distfile has not been | ||||
corrupted or maliciously altered. If the current | corrupted or maliciously altered. If the current | ||||
version of the port has been in the ports tree for a | version of the port has been in the ports tree for a | ||||
while, a copy of the old distfile will usually be | while, a copy of the old distfile will usually be | ||||
available on the ftp servers; otherwise the author or | available on the ftp servers; otherwise the author or | ||||
maintainer should be contacted to find out why the | maintainer should be contacted to find out why the | ||||
distfile has changed.</para> | distfile has changed.</para> | ||||
</answer> | |||||
</qandaentry> | |||||
<qandaentry xml:id="ports-request-mfh"> | |||||
<question> | |||||
<para>What is the procedure to request authorization for | |||||
merging a commit to the quarterly branch.</para> | |||||
Not Done Inline ActionsEnd the question with a question mark. wblock: End the question with a question mark. | |||||
</question> | |||||
<answer> | |||||
<para>When doing the commit, add the branch name to the | |||||
<literal>MFH:</literal> line, for example:</para> | |||||
<programlisting>MFH: <replaceable>2014Q1</replaceable></programlisting> | |||||
<para>It will automatically notify &a.ports-secteam; and | |||||
&a.portmgr;. They will then decide if the commit can be | |||||
merged and answer with the procedure on doing so.</para> | |||||
Not Done Inline ActionsThis should be "for doing so", but is not really needed: merged, and respond with the proper procedure. wblock: This should be "for doing so", but is not really needed:
merged, and respond with the proper… | |||||
<para>If the commit has already been made, send an email | |||||
to &a.ports-secteam; and &a.portmgr; with the revision | |||||
number, and a small description of why the commit needs | |||||
Not Done Inline ActionsNo comma after "number". wblock: No comma after "number". | |||||
to be merged.</para> | |||||
<para>To merge a specific commit, a script to automate the | |||||
Not Done Inline ActionsThis can be reworded into a smoother sentence with less pauses: A script is provided to automate merging a specific commit: wblock: This can be reworded into a smoother sentence with less pauses:
A script is provided to… | |||||
merge is provided, | |||||
<filename>ports/Tools/scripts/mfh</filename>. It can be | |||||
Not Done Inline ActionsPassive->Active: s/It can be/It is/ wblock: Passive->Active: s/It can be/It is/ | |||||
used as follows:</para> | |||||
<screen>&prompt.user; <userinput>/usr/ports/Tools/scripts/mfh 2015Q1 380362</userinput> | |||||
U 2015Q1 | |||||
Checked out revision 380443. | |||||
A 2015Q1/security | |||||
Updating '2015Q1/security/rubygem-sshkit': | |||||
A 2015Q1/security/rubygem-sshkit | |||||
A 2015Q1/security/rubygem-sshkit/Makefile | |||||
A 2015Q1/security/rubygem-sshkit/distinfo | |||||
A 2015Q1/security/rubygem-sshkit/pkg-descr | |||||
Updated to revision 380443. | |||||
--- Merging r380362 into '2015Q1': | |||||
U 2015Q1/security/rubygem-sshkit/Makefile | |||||
U 2015Q1/security/rubygem-sshkit/distinfo | |||||
--- Recording mergeinfo for merge of r380362 into '2015Q1': | |||||
U 2015Q1 | |||||
--- Recording mergeinfo for merge of r380362 into '2015Q1/security': | |||||
G 2015Q1/security | |||||
--- Eliding mergeinfo from '2015Q1/security': | |||||
U 2015Q1/security | |||||
--- Recording mergeinfo for merge of r380362 into '2015Q1/security/rubygem-sshkit': | |||||
G 2015Q1/security/rubygem-sshkit | |||||
--- Eliding mergeinfo from '2015Q1/security/rubygem-sshkit': | |||||
U 2015Q1/security/rubygem-sshkit | |||||
M 2015Q1 | |||||
M 2015Q1/security/rubygem-sshkit/Makefile | |||||
M 2015Q1/security/rubygem-sshkit/distinfo | |||||
Index: 2015Q1/security/rubygem-sshkit/Makefile | |||||
=================================================================== | |||||
--- 2015Q1/security/rubygem-sshkit/Makefile (revision 380443) | |||||
+++ 2015Q1/security/rubygem-sshkit/Makefile (working copy) | |||||
@@ -2,7 +2,7 @@ | |||||
# $FreeBSD$ | |||||
PORTNAME= sshkit | |||||
-PORTVERSION= 1.6.1 | |||||
+PORTVERSION= 1.7.0 | |||||
CATEGORIES= security rubygems | |||||
MASTER_SITES= RG | |||||
Index: 2015Q1/security/rubygem-sshkit/distinfo | |||||
=================================================================== | |||||
--- 2015Q1/security/rubygem-sshkit/distinfo (revision 380443) | |||||
+++ 2015Q1/security/rubygem-sshkit/distinfo (working copy) | |||||
@@ -1,2 +1,2 @@ | |||||
-SHA256 (rubygem/sshkit-1.6.1.gem) = 8ca67e46bb4ea50fdb0553cda77552f3e41b17a5aa919877d93875dfa22c03a7 | |||||
-SIZE (rubygem/sshkit-1.6.1.gem) = 135680 | |||||
+SHA256 (rubygem/sshkit-1.7.0.gem) = 90effd1813363bae7355f4a45ebc8335a8ca74acc8d0933ba6ee6d40f281a2cf | |||||
+SIZE (rubygem/sshkit-1.7.0.gem) = 136192 | |||||
Index: 2015Q1 | |||||
=================================================================== | |||||
--- 2015Q1 (revision 380443) | |||||
+++ 2015Q1 (working copy) | |||||
Property changes on: 2015Q1 | |||||
___________________________________________________________________ | |||||
Modified: svn:mergeinfo | |||||
Merged /head:r380362 | |||||
Do you want to commit? (no = start a shell) [y/n] | |||||
</screen> | |||||
<para>At that point, the script will either open a shell | |||||
for you to fix things, or open your text editor with the | |||||
commit message all prepared and then commit the | |||||
merge.</para> | |||||
<para>The script assumes that you can connect to | |||||
<literal>svn.FreeBSD.org</literal> with | |||||
<application>SSH</application> directly, so if your | |||||
local login name is different than your &os; cluster | |||||
account, you need a few lines in your | |||||
<filename>~/.ssh/config</filename>:</para> | |||||
<programlisting>Host svn.freebsd.org | |||||
User <replaceable>freebsd-login</replaceable></programlisting> | |||||
</answer> | </answer> | ||||
</qandaentry> | </qandaentry> | ||||
</qandadiv> | </qandadiv> | ||||
</qandaset> | </qandaset> | ||||
</sect1> | </sect1> | ||||
<sect1 xml:id="non-committers"> | <sect1 xml:id="non-committers"> | ||||
<title>Issues Specific to Developers Who Are Not | <title>Issues Specific to Developers Who Are Not | ||||
▲ Show 20 Lines • Show All 246 Lines • Show Last 20 Lines |
I would add a sentence stop at the comma here. Otherwise, this whole paragraph consists of only one long sentence. Instead, it would read like this:
It is also possible to specify a date. In that case ... last true commit.
Don't forget to add an extra space after the sentence stop.