From nobody Fri Apr 08 21:00:22 2022 X-Original-To: dev-commits-doc-all@mlmmj.nyi.freebsd.org Received: from mx1.freebsd.org (mx1.freebsd.org [IPv6:2610:1c1:1:606c::19:1]) by mlmmj.nyi.freebsd.org (Postfix) with ESMTP id 144C51A915C5 for ; Fri, 8 Apr 2022 21:00:23 +0000 (UTC) (envelope-from git@FreeBSD.org) Received: from mxrelay.nyi.freebsd.org (mxrelay.nyi.freebsd.org [IPv6:2610:1c1:1:606c::19:3]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (4096 bits) server-digest SHA256 client-signature RSA-PSS (4096 bits) client-digest SHA256) (Client CN "mxrelay.nyi.freebsd.org", Issuer "R3" (verified OK)) by mx1.freebsd.org (Postfix) with ESMTPS id 4KZrHV5typz4mb1; Fri, 8 Apr 2022 21:00:22 +0000 (UTC) (envelope-from git@FreeBSD.org) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=freebsd.org; s=dkim; t=1649451622; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:mime-version:mime-version:content-type:content-type: content-transfer-encoding:content-transfer-encoding; bh=jWqjEURpqkvK06y4zvHq+t66jrrrHQqTQFRq6NTJY7s=; b=l55I7/p55CwDYo0Z13e8Qn28i0FH7kY9sZodSwGtMfpvaiII6w7IrKGgFmN+no1mLNVuKl T6Cn4J+u5g1yFsUQnvPMg+HyW3grn3NHHQmK1DjkOAjxL43AGr/qdXSglUYTxT0fn/GU8l bALplTd0Wr68MyyDXqXfENq+/QQ9VDSNdLO3uSw6uSR5HmXKR2ZdliLh7bXxK+eJJFuHkD wIkHZlZBxj5ev9NNA80kvMghLlUDetEmjYRJknMiubugrqRlP1Q9ui39sWIIps9FQocY6C xsU8ubg1VPjWmPPgt4GqqxhgTuBgj/PS0qNH80SuSO8PIDhhKD9/P/SlZsSRcg== Received: from gitrepo.freebsd.org (gitrepo.freebsd.org [IPv6:2610:1c1:1:6068::e6a:5]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (4096 bits) server-digest SHA256) (Client did not present a certificate) by mxrelay.nyi.freebsd.org (Postfix) with ESMTPS id AA2D54732; Fri, 8 Apr 2022 21:00:22 +0000 (UTC) (envelope-from git@FreeBSD.org) Received: from gitrepo.freebsd.org ([127.0.1.44]) by gitrepo.freebsd.org (8.16.1/8.16.1) with ESMTP id 238L0Mc2083828; Fri, 8 Apr 2022 21:00:22 GMT (envelope-from git@gitrepo.freebsd.org) Received: (from git@localhost) by gitrepo.freebsd.org (8.16.1/8.16.1/Submit) id 238L0MeV083827; Fri, 8 Apr 2022 21:00:22 GMT (envelope-from git) Date: Fri, 8 Apr 2022 21:00:22 GMT Message-Id: <202204082100.238L0MeV083827@gitrepo.freebsd.org> To: doc-committers@FreeBSD.org, dev-commits-doc-all@FreeBSD.org From: Sergio Carlavilla Delgado Subject: git: 97655c6e49 - main - Upgrade how to create a diff patch in FDP overview chapter List-Id: Commit messages for all branches of the doc repository List-Archive: https://lists.freebsd.org/archives/dev-commits-doc-all List-Help: List-Post: List-Subscribe: List-Unsubscribe: Sender: owner-dev-commits-doc-all@freebsd.org X-BeenThere: dev-commits-doc-all@freebsd.org MIME-Version: 1.0 Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: 8bit X-Git-Committer: carlavilla X-Git-Repository: doc X-Git-Refname: refs/heads/main X-Git-Reftype: branch X-Git-Commit: 97655c6e49e1cbf1a340718ee3dcaadef808f1c8 Auto-Submitted: auto-generated ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=freebsd.org; s=dkim; t=1649451622; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:mime-version:mime-version:content-type:content-type: content-transfer-encoding:content-transfer-encoding; bh=jWqjEURpqkvK06y4zvHq+t66jrrrHQqTQFRq6NTJY7s=; b=cDv15S+WHS8nSbPpPamqNqVrt3ZKsCunGJ3EyQ+02K+bWCE5Mh1gnjtKgDzci/z6jRo5m5 Gei9AXlzTv+eDC+PQdmqz9e+glGLhNo5RyI5y+zWhk+lguR1/XPkp4D88PAb9GJ33msN9Q sIMd/CMWaDKyV9S+QSvKxct/jNzU2V+LiEquFux0XvcPqvuXntt4iggqySZWVs3k7HgLeP WERsKZ/GKL8dx8M/wPhrvqsO9ArGhvvhl+9gbUI+6S5yp4hcJsGLOvRE/GxDecVzi3zxOv fcwaSirt8PwrolRfAnM4CyucfdkOWvXD56yULy0CpST6yDEShOQf9tGnC+bEMg== ARC-Seal: i=1; s=dkim; d=freebsd.org; t=1649451622; a=rsa-sha256; cv=none; b=aaSpFnD2HHsK4Dvf7+FVHLS3GiiHzbqV6/0E8v4hoFOeJajzpOBFtMQI+Gkuhw93XT0W4v hDHQUV5RcO8GgiBUflGZb3T+NNt+wXnUQhjJVOfqthHFTaNarBFa62rKP+DchfE4FY0alp PCS0pF/QxDMIJI7aiJOsYmoRu5FIM7sri4jpKSPNvOk6BV/zWXW/L1o/I7Z1tuiqAq/S92 BeRyQC0g+lGq9v20u1+CXZb7AU4PBrzCHMq45Zvczgr68U3uYFG2WZSYqkkyulkad/dses bz6pLj/s5CUXOQSs3U3WmQdTx5frtVpqsXy5dz+w3bwM5Y/oSSrzBpBlHNWslQ== ARC-Authentication-Results: i=1; mx1.freebsd.org; none X-ThisMailContainsUnwantedMimeParts: N The branch main has been updated by carlavilla: URL: https://cgit.FreeBSD.org/doc/commit/?id=97655c6e49e1cbf1a340718ee3dcaadef808f1c8 commit 97655c6e49e1cbf1a340718ee3dcaadef808f1c8 Author: Sergio Carlavilla Delgado AuthorDate: 2022-04-08 20:57:53 +0000 Commit: Sergio Carlavilla Delgado CommitDate: 2022-04-08 20:57:53 +0000 Upgrade how to create a diff patch in FDP overview chapter Reported by: Pau Amma --- .../en/books/fdp-primer/overview/_index.adoc | 69 ++++++++++++++++++---- 1 file changed, 57 insertions(+), 12 deletions(-) diff --git a/documentation/content/en/books/fdp-primer/overview/_index.adoc b/documentation/content/en/books/fdp-primer/overview/_index.adoc index 6fe1fbb106..514ae7a06d 100644 --- a/documentation/content/en/books/fdp-primer/overview/_index.adoc +++ b/documentation/content/en/books/fdp-primer/overview/_index.adoc @@ -136,15 +136,31 @@ Repeat until all of the errors are resolved. % make .... + -. When changes are complete and tested, generate a "diff file": +. Add all the files with `git add .`, then review the diff with `git diff`. For example: + [source,shell] .... -% cd ~/doc -% git diff > bsdinstall.diff.txt +% git add . +% git diff --staged .... + -Give the diff file a descriptive name. +Make sure that all required files are included, then commit the change to your local branch and generate a patch with `git format-patch` ++ +[source,shell] +.... +% git commit +% git format-patch origin/main +.... ++ +Patch generated with `git format-patch` will include author identity and email addresses, +making it easier for developers to apply (with `git am`) and give proper credit. ++ +[IMPORTANT] +====== +To make it easier for committers to apply the patch on their working copy of the documentation tree, +please generate the [.filename]#.diff# from the base of your documentation tree. +====== ++ In the example above, changes have been made to the *bsdinstall* portion of the Handbook. + . Submit the diff file using the web-based https://bugs.FreeBSD.org/bugzilla/enter_bug.cgi?product=Documentation[Problem Report] system. If using the web form, enter a Summary of _[patch] short description of problem_. Select the Component `Documentation`. In the Description field, enter a short description of the changes and any important details about them. Use the btn:[Add an attachment] button to attach the diff file. Finally, use the btn:[Submit Bug] button to submit your diff to the problem report system. @@ -188,15 +204,30 @@ Repeat until all of the errors are resolved. % bmake run LOCALBASE=/usr .... + -. When changes are complete and tested, generate a diff file: +. Add all the files with `git add .`, then review the diff with `git diff`. For example: ++ +[source,shell] +.... +% git add . +% git diff --staged +.... ++ +Make sure that all required files are included, then commit the change to your local branch and generate a patch with `git format-patch` + [source,shell] .... -% cd ~/doc -% git diff > bsdinstall.diff +% git commit +% git format-patch origin/main .... + -Give the diff file a descriptive name. +Patch generated with `git format-patch` will include author identity and email addresses, +making it easier for developers to apply (with `git am`) and give proper credit. ++ +[IMPORTANT] +====== +To make it easier for committers to apply the patch on their working copy of the documentation tree, +please generate the [.filename]#.diff# from the base of your documentation tree. +====== + . Submit the diff file using the web-based https://bugs.FreeBSD.org/bugzilla/enter_bug.cgi?product=Documentation[Problem Report] system. If using the web form, enter a Summary of _short description of problem_. @@ -255,16 +286,30 @@ Repeat until all of the errors are resolved. .... $ bmake run LOCALBASE=/usr .... +. Add all the files with `git add .`, then review the diff with `git diff`. For example: ++ +[source,shell] +.... +% git add . +% git diff --staged +.... + -. When changes are complete and tested, generate a diff file: +Make sure that all required files are included, then commit the change to your local branch and generate a patch with `git format-patch` + [source,shell] .... -$ cd ~/doc -$ git diff > bsdinstall.diff +% git commit +% git format-patch origin/main .... + -Give the diff file a descriptive name. +Patch generated with `git format-patch` will include author identity and email addresses, +making it easier for developers to apply (with `git am`) and give proper credit. ++ +[IMPORTANT] +====== +To make it easier for committers to apply the patch on their working copy of the documentation tree, +please generate the [.filename]#.diff# from the base of your documentation tree. +====== + . Submit the diff file using the web-based https://bugs.FreeBSD.org/bugzilla/enter_bug.cgi?product=Documentation[Problem Report] system. If using the web form, enter a Summary of _short description of problem_.