From patchwork Wed Feb 2 11:44:48 2022 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: =?utf-8?b?SsO8cmdlbiBHcm/Dnw==?= X-Patchwork-Id: 12732858 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org Received: from lists.xenproject.org (lists.xenproject.org [192.237.175.120]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by smtp.lore.kernel.org (Postfix) with ESMTPS id E755CC433EF for ; Wed, 2 Feb 2022 11:45:19 +0000 (UTC) Received: from list by lists.xenproject.org with outflank-mailman.264085.457054 (Exim 4.92) (envelope-from ) id 1nFE4E-0003G5-9N; Wed, 02 Feb 2022 11:44:54 +0000 X-Outflank-Mailman: Message body and most headers restored to incoming version Received: by outflank-mailman (output) from mailman id 264085.457054; Wed, 02 Feb 2022 11:44:54 +0000 Received: from localhost ([127.0.0.1] helo=lists.xenproject.org) by lists.xenproject.org with esmtp (Exim 4.92) (envelope-from ) id 1nFE4E-0003Fy-5q; Wed, 02 Feb 2022 11:44:54 +0000 Received: by outflank-mailman (input) for mailman id 264085; Wed, 02 Feb 2022 11:44:53 +0000 Received: from se1-gles-sth1-in.inumbo.com ([159.253.27.254] helo=se1-gles-sth1.inumbo.com) by lists.xenproject.org with esmtp (Exim 4.92) (envelope-from ) id 1nFE4D-0003Fs-4o for xen-devel@lists.xenproject.org; Wed, 02 Feb 2022 11:44:53 +0000 Received: from smtp-out1.suse.de (smtp-out1.suse.de [195.135.220.28]) by se1-gles-sth1.inumbo.com (Halon) with ESMTPS id 87f84f96-841d-11ec-8eb8-a37418f5ba1a; Wed, 02 Feb 2022 12:44:51 +0100 (CET) Received: from imap2.suse-dmz.suse.de (imap2.suse-dmz.suse.de [192.168.254.74]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature ECDSA (P-521) server-digest SHA512) (No client certificate requested) by smtp-out1.suse.de (Postfix) with ESMTPS id C51F321114; Wed, 2 Feb 2022 11:44:50 +0000 (UTC) Received: from imap2.suse-dmz.suse.de (imap2.suse-dmz.suse.de [192.168.254.74]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature ECDSA (P-521) server-digest SHA512) (No client certificate requested) by imap2.suse-dmz.suse.de (Postfix) with ESMTPS id 83BBB13E14; Wed, 2 Feb 2022 11:44:50 +0000 (UTC) Received: from dovecot-director2.suse.de ([192.168.254.65]) by imap2.suse-dmz.suse.de with ESMTPSA id kB23HrJu+mGbDwAAMHmgww (envelope-from ); Wed, 02 Feb 2022 11:44:50 +0000 X-BeenThere: xen-devel@lists.xenproject.org List-Id: Xen developer discussion List-Unsubscribe: , List-Post: List-Help: List-Subscribe: , Errors-To: xen-devel-bounces@lists.xenproject.org Precedence: list Sender: "Xen-devel" X-Inumbo-ID: 87f84f96-841d-11ec-8eb8-a37418f5ba1a DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=suse.com; s=susede1; t=1643802290; h=from:from:reply-to:date:date:message-id:message-id:to:to:cc:cc: mime-version:mime-version: content-transfer-encoding:content-transfer-encoding; bh=cCSPusOGm6qPQ6mVAN8rR9lkFSLkMYCqcl/n5Rr3lnI=; b=p6cr4PmHDoyn2o76NcCOyKiI2xTkm8n9oIigkZn8lnqCWHzI5hpcp4q6hqbfG7BLs/lauF WUAYh0X+wAIDARY14nlAmuOel6ThxbGrWDFMAKjf/yR64Zks/RWRoqFdfooX9RXbd89mik SHJfwjFqgHqL6kPvyWVThm5kBeF51x4= From: Juergen Gross To: xen-devel@lists.xenproject.org Cc: Juergen Gross , Andrew Cooper , George Dunlap , Jan Beulich , Julien Grall , Stefano Stabellini , Wei Liu Subject: [PATCH] docs: document patch rules Date: Wed, 2 Feb 2022 12:44:48 +0100 Message-Id: <20220202114448.8608-1-jgross@suse.com> X-Mailer: git-send-email 2.34.1 MIME-Version: 1.0 Add a document to describe the rules for sending a proper patch. As it contains all the information already being present in docs/process/tags.pandoc remove that file. Signed-off-by: Juergen Gross --- docs/process/sending-patches.pandoc | 284 ++++++++++++++++++++++++++++ docs/process/tags.pandoc | 55 ------ 2 files changed, 284 insertions(+), 55 deletions(-) create mode 100644 docs/process/sending-patches.pandoc delete mode 100644 docs/process/tags.pandoc diff --git a/docs/process/sending-patches.pandoc b/docs/process/sending-patches.pandoc new file mode 100644 index 0000000000..4cfc6e1a5b --- /dev/null +++ b/docs/process/sending-patches.pandoc @@ -0,0 +1,284 @@ +# How a proper patch should look like + +This is a brief description how a proper patch for the Xen project should +look like. Examples and tooling tips are not part of this document, those +can be found in the +[Xen Wiki](https://wiki.xenproject.org/wiki/Submitting_Xen_Project_Patches). + +## The patch subject + +The first line at the top of the patch should contain a short description of +what the patch does, and hints as to what code it touches. This line is used +as the **Subject** line of the mail when sending the patch. + +The hint which code is touched us usually in form of a relative path inside +the Xen git repository, where obvious directories can be omitted or replaced +by abbreviations, or it can be a single word describing the topic: + + : + +E.g.: + + xen/arm: increase memory banks number define value + tools/libs/evtchn: Deduplicate xenevtchn_fd() + MAINTAINERS: update my email address + build: correct usage comments in Kbuild.include + +The description should give a rough hint *what* is done in the patch. + +The subject line should in general not exceed 80 characters. It must be +followed by a blank line. + +## The commit message + +The commit message is free text describing *why* the patch is done and +*how* the goal of the patch is achieved. A good commit message will describe +the current situation, the desired goal, and the way this goal is being +achieved. Parts of that can be omitted in obvious cases. + +In case additional changes are done in the patch (like e.g. cleanups), those +should be mentioned. + +When referencing other patches (e.g. `patch xy introduced a bug ...`) those +patches should be referenced via their commit id (at least 12 digits) and the +patch subject: + + Commit 67d01cdb5518 ("x86: infrastructure to allow converting certain + indirect calls to direct ones") introduced a bug ... + +The following ``git config`` settings can be used to add a pretty format for +outputting the above style in the ``git log`` or ``git show`` commands: + + [core] + abbrev = 12 + [pretty] + fixes = Fixes: %h (\"%s\") + +Lines in the commit message should not exceed 75 characters, except when +copying error output directly into the commit message. + +## Tags + +Tags are entries in the form + + Tag: something + +In general tags are added in chronological order. So a `Reviewed-by:` tag +should be added **after** the `Signed-off-by:` tag, as the review happened +after the patch was written. + +Do not split a tag across multiple lines, tags are exempt from the +"wrap at 75 columns" rule in order to simplify parsing scripts. + +### Taken-from: + +Xen has inherited some source files from other open source projects. In case +a patch modifying such an inherited file is taken from that project (maybe in +modified form), the `Taken-from:` tag specifies the source of the patch: + + Taken-from: + +E.g.: + + Taken-from: git://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git f093b08c47b3 + +All tags **above** the `Taken-from:` tag are from the original patch (which +should all be kept), while tags **after** `Taken-from:` are related to the +normal Xen patch process as described here. + +### Fixes: + +If your patch fixes a bug in a specific commit, e.g. you found an issue using +``git bisect``, please use the `Fixes:` tag with the first 12 characters of +the commit id, and the one line summary. + + Fixes: ("") + +E.g.: + + Fixes: 67d01cdb5518 ("x86: infrastructure to allow converting certain indirect calls to direct ones") + +### Backport: + +A backport tag is an optional tag in the commit message to request a +given commit to be backported to the released trees: + + Backport: [# ] + +E.g.: + + Backport: 4.9+ + +It marks a commit for being a candidate for backports to all released +trees from 4.9 onward. + +The backport requester is expected to specify which currently supported +releases need the backport; but encouraged to specify a release as far +back as possible which applies. If the requester doesn't know the oldest +affected tree, they are encouraged to append a comment like the +following: + + Backport: 4.9+ # maybe older + +Maintainers request the Backport tag to be added on commit. Contributors +are welcome to mark their patches with the Backport tag when they deem +appropriate. Maintainers will request for it to be removed when that is +not the case. + +Please note that the Backport tag is a **request** for backport, which +will still need to be evaluated by the maintainers. Maintainers might +ask the requester to help with the backporting work if it is not +trivial. + +### Reported-by: + +This optional tag can be used to give credit to someone reporting an issue. +It is in the format: + + Reported-by: name + +E.g.: + + Reported-by: Jane Doe + +As the email address will be made public via git, the reporter of an issue +should be asked whether he/she is fine with being mentioned in the patch. + +### Suggested-by: + +This optional tag can be used to give credit to someone having suggested the +solution the patch is implementing. It is in the format: + + Suggested-by: name + +E.g.: + + Suggested-by: Jane Doe + +As the email address will be made public via git, the reporter of an issue +should be asked whether he/she is fine with being mentioned in the patch. + +### Signed-off-by: + +This mandatory tag specifies the author(s) of a patch (for each author a +separate `Signed-off-by:` tag is needed). It is in the format: + + Signed-off-by: name + +E.g.: + + Signed-off-by: Jane Doe + +The author must be a natural person (not a team or just a company) and the +`Signed-off-by:` tag must include the real name of the author (no pseudonym). + +By signing the patch with her/his name the author explicitly confirms to have +made the contribution conforming to the `Developer's Certificate of Origin`: + + Developer's Certificate of Origin 1.1 + + By making a contribution to this project, I certify that: + + (a) The contribution was created in whole or in part by me and I + have the right to submit it under the open source license + indicated in the file; or + + (b) The contribution is based upon previous work that, to the best + of my knowledge, is covered under an appropriate open source + license and I have the right under that license to submit that + work with modifications, whether created in whole or in part + by me, under the same open source license (unless I am + permitted to submit under a different license), as indicated + in the file; or + + (c) The contribution was provided directly to me by some other + person who certified (a), (b) or (c) and I have not modified + it. + + (d) I understand and agree that this project and the contribution + are public and that a record of the contribution (including all + personal information I submit with it, including my sign-off) is + maintained indefinitely and may be redistributed consistent with + this project or the open source license(s) involved. + +### Reviewed-by: + +A `Reviewed-by:` tag can only be given by a reviewer of the patch. With +responding to a sent patch adding the `Reviewed-by:` tag the reviewer +(which can be anybody) confirms to have looked thoroughly at the patch and +didn't find any issue (being it technical, legal or formal ones). If the +review is covering only some parts of the patch, those parts can optionally +be specified (multiple areas can be covered with multiple `Reviewed-by:` +tags). It is in the format: + + Reviewed-by: name [# area] + +E.g.: + + Reviewed-by: Jane Doe + Reviewed-by: Jane Doe # xen/x86 + +In case a patch is being resent an already given `Reviewed-by:` tag can and +should be included, if the patch didn't change the portions of the patch +covered by the tag, or if the reviewer already made clear it would be fine +to make specific changes and no *other* changes have been made. + +### Acked-by: + +Similar to `Reviewed-by:` the `Acked-by:` tag is given by someone having looked +at the patch. The `Acked-by:` tag can only be given by a **maintainer** of the +modified code, and it only covers the code the maintainer is responsible for. +For this reason there is no optional area possible. With the `Acked-by:` tag +the maintainer states, that he/she is fine with the changes in principle, but +didn't do a thorough review. The format is: + + Acked-by: name + +E.g.: + + Acked-by: Jane Doe + +Including the `Acked-by:` tag in a patch is done under the same rules as for +the `Reviewed-by:` tag, with the implied code area the maintainer who gave the +`Acked-by:` tag is responsible for. + +### Tested-by: + +The `Tested-by:` tag is another tag given by someone else. The one giving it +confirms to have tested the patch without finding any functional issues. The +format is: + + Tested-by: name + +E.g.: + + Tested-by: Jane Doe + +Including the `Tested-by:` tag in a patch is done under the same rules as for +the `Reviewed-by:` tag, now limited to the patch not having been modified +regarding code logic (having changed only coding style, comments, or message +texts is fine). + +## Patch version history (change log), further comments + +When sending revised versions of a patch it is good practice to include a +change log after a line containing only `---` (this line will result in the +following text not being included in the commit message). This change log +will help reviewers to spot which parts of the patch have changed. Attributing +changes due to reviewer comments will help the reviewer even more, e.g.: + + --- + Changes in V2: + - changed function foo() as requested by Jane Doe + - code style fixed + +In some cases it might be desirable to add some more information for readers +of the patch, like potential enhancements, other possible solutions, etc., +which should not be part of the commit message. This information can be +added after the `---` line, too. + +## Recipients of the patch + +A patch should always be sent **to** the xen-devel mailing list and all maintainers of all touched code areas should get a +copy of the mail via **Cc**. In case some other recipients are known to be +interested in the patch, they can be added via **Cc**, too. diff --git a/docs/process/tags.pandoc b/docs/process/tags.pandoc deleted file mode 100644 index 1841cb87a8..0000000000 --- a/docs/process/tags.pandoc +++ /dev/null @@ -1,55 +0,0 @@ -Tags: No line splitting ------------------------ -Do not split a tag across multiple lines, tags are exempt from the -"wrap at 75 columns" rule in order to simplify parsing scripts. For -example: - - Fixes: 67d01cdb5518 ("x86: infrastructure to allow converting certain indirect calls to direct ones") - - -Fixes Tag ---------- - -If your patch fixes a bug in a specific commit, e.g. you found an issue using -``git bisect``, please use the 'Fixes:' tag with the first 12 characters of -the SHA-1 ID, and the one line summary. - -The following ``git config`` settings can be used to add a pretty format for -outputting the above style in the ``git log`` or ``git show`` commands: - - [core] - abbrev = 12 - [pretty] - fixes = Fixes: %h (\"%s\") - - -Backport Tag ------------- - -A backport tag is an optional tag in the commit message to request a -given commit to be backported to the released trees: - - Backport: 4.9+ - -It marks a commit for being a candidate for backports to all released -trees from 4.9 onward. - -The backport requester is expected to specify which currently supported -releases need the backport; but encouraged to specify a release as far -back as possible which applies. If the requester doesn't know the oldest -affected tree, they are encouraged to append a comment like the -following: - - Backport: 4.9+ # maybe older - -Maintainers request the Backport tag to be added on commit. Contributors -are welcome to mark their patches with the Backport tag when they deem -appropriate. Maintainers will request for it to be removed when that is -not the case. - -Please note that the Backport tag is a **request** for backport, which -will still need to be evaluated by the maintainers. Maintainers might -ask the requester to help with the backporting work if it is not -trivial. - -When possible, please use the Fixes tag instead (or in addition).