diff options
Diffstat (limited to 'documentation/content/en/books/porters-handbook/upgrading/_index.adoc')
| -rw-r--r-- | documentation/content/en/books/porters-handbook/upgrading/_index.adoc | 18 |
1 files changed, 9 insertions, 9 deletions
diff --git a/documentation/content/en/books/porters-handbook/upgrading/_index.adoc b/documentation/content/en/books/porters-handbook/upgrading/_index.adoc index e61a88dbaf..3da3d330c5 100644 --- a/documentation/content/en/books/porters-handbook/upgrading/_index.adoc +++ b/documentation/content/en/books/porters-handbook/upgrading/_index.adoc @@ -64,7 +64,7 @@ If there is no pending PR, the next step is to send an email to the port's maint That person may already be working on an upgrade, or have a reason to not upgrade the port right now (because of, for example, stability problems of the new version), and there is no need to duplicate their work. Note that unmaintained ports are listed with a maintainer of `ports@FreeBSD.org`, which is just the general ports mailing list, so sending mail there probably will not help in this case. -If the maintainer asks you to do the upgrade or there is no maintainer, then help out FreeBSD by preparing the update! Please do this by using the man:diff[1] command in the base system. +If the maintainer requests to do the upgrade or there is no maintainer, then help out FreeBSD by preparing the update! Please do this by using the man:diff[1] command in the base system. To create a suitable `diff` for a single patch, copy the file that needs patching to [.filename]#something.orig#, save the changes to [.filename]#something# and then create the patch: @@ -88,7 +88,7 @@ To simplify common operations with patch files, use `make makepatch` as describe Other tools exists, like [.filename]#/usr/ports/Tools/scripts/patchtool.py#. Before using it, please read [.filename]#/usr/ports/Tools/scripts/README.patchtool#. -If the port is unmaintained, and you are actively using it, please consider volunteering to become its maintainer. +If the port is unmaintained, and it is actively being used, please consider volunteering to become its maintainer. FreeBSD has over 4000 ports without maintainers, and this is an area where more volunteers are always needed. (For a detailed description of the responsibilities of maintainers, refer to the section in the extref:{developers-handbook}[Developer's Handbook, POLICIES-MAINTAINER].) @@ -125,8 +125,8 @@ They are easier to handle than diffs between "new and old" directories. It is easier to see what has changed, and to update the diff if something was modified in the Ports Collection since the work on it began, or if the committer asks for something to be fixed. Also, a patch generated with man:git-format-patch[1] or man:git-diff[1] can be easily applied with man:git-am[1] or man:git-apply[1] and will save some time for the committer. -Finally, the git patch generated by man:git-format-patch[1] includes your author information and commit messages. -These will be recorded in the log of the repository and this is the recommended way to submit your changes. +Finally, the git patch generated by man:git-format-patch[1] includes the author information and commit messages. +These will be recorded in the log of the repository and this is the recommended way to submit the changes. [source,shell] .... @@ -154,7 +154,7 @@ Also, update the checksum reference in distinfo with `make makesum`. Before making the patch, fetch the latest repository and rebase the changes on top of it. Watch and follow the output carefully. -If any of the files failed to rebase, it means that the upstream files changed while you were editing the same file, and the conflicts need to be resolved manually. +If any of the files failed to rebase, it means that the upstream files changed while local changes happened in the same file, and the conflicts need to be resolved manually. [source,shell] .... @@ -182,7 +182,7 @@ To generate a patch with man:git-format-patch[1]: This will generate a patch named like `0001-foo.patch`. This is the preferred way as it would include author identity, -and it is also easier when you are making a series of changes that +and it is also easier when making a series of changes that are not meant to be squashed together. Alternatively, to generate an unified diff with man:git-diff[1]: @@ -193,13 +193,13 @@ Alternatively, to generate an unified diff with man:git-diff[1]: This will generate a diff named like `foo-1.2.3.diff`. Where `foo` is replaced with the first line of the commit message, i.e., the subject of the commit message. -After patch has been created, you can switch to the main branch for starting other developments. +After patch has been created, switch to the main branch for starting other developments. [source,shell] .... % git checkout main .... -Once the patch is accepted and merged, you can delete the local development branch if you want: +Once the patch is accepted and merged, delete the local development branch if desired: [source,shell] .... % git branch -D my_branch @@ -227,7 +227,7 @@ The format of an entry in this file is: .... YYYYMMDD: AFFECTS: users of portcategory/portname - AUTHOR: Your name <Your email address> + AUTHOR: the name <the email address> Special instructions .... |