Received-SPF: pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 23.128.96.37 as permitted sender) client-ip=23.128.96.37;
Date:   Mon, 16 Oct 2023 12:11:04 -0400
From:   Frank Li <Frank.li@nxp.com>
To:     Bjorn Helgaas <helgaas@kernel.org>
Cc:     Lorenzo Pieralisi <lpieralisi@kernel.org>,
        Minghuan Lian <minghuan.Lian@nxp.com>,
        Mingkai Hu <mingkai.hu@nxp.com>, Roy Zang <roy.zang@nxp.com>,
        Krzysztof =?utf-8?Q?Wilczy=C5=84ski?= <kw@linux.com>,
        Rob Herring <robh@kernel.org>,
        Bjorn Helgaas <bhelgaas@google.com>,
        "open list:PCI DRIVER FOR FREESCALE LAYERSCAPE" 
        <linuxppc-dev@lists.ozlabs.org>,
        "open list:PCI DRIVER FOR FREESCALE LAYERSCAPE" 
        <linux-pci@vger.kernel.org>,
        "moderated list:PCI DRIVER FOR FREESCALE LAYERSCAPE" 
        <linux-arm-kernel@lists.infradead.org>,
        open list <linux-kernel@vger.kernel.org>, imx@lists.linux.dev
Subject: Re: [PATCH 2/3] PCI: layerscape: add suspend/resume for ls1021a
Message-ID: <ZS1gmJiz8+PKIuwp@lizhi-Precision-Tower-5810>
References: <ZS1Mhe9JOsY2JJER@lizhi-Precision-Tower-5810>
 <20231016152211.GA1209639@bhelgaas>
Content-Type: text/plain; charset=us-ascii
Content-Disposition: inline
In-Reply-To: <20231016152211.GA1209639@bhelgaas>
MIME-Version: 1.0
X-MS-Exchange-AntiSpam-MessageData-ChunkCount: 1
X-MS-Exchange-AntiSpam-MessageData-0: =?us-ascii?Q?Ct0HVMfqiOZy67CZu+c0EnNQ8xseoolAO2vgrp6h6lGw1SBcnwBfva1ExKZ9?=
 =?us-ascii?Q?oLc6QwNIBMdt+cfJnxudSF5i09A/UPkUbTLTxuVlQPlZfyB2ror0rj2dbvcx?=
 =?us-ascii?Q?v5xXSsAOm0jPpxH6sArSjy+EyyFDLlnVbAb0ZliVyDJ78118sM2bu4ZXR3Nj?=
 =?us-ascii?Q?e+HB+1m0sb8mbChN8/yqxIpYYWJU4T2ms//UH+xz5KJSx1hf0wccaQ7R9Afd?=
 =?us-ascii?Q?dZzZAoauoYZdhA6fIHrjU671n5OGav/VEO5aCcZl+UuANq2ppoOqe3ZmPwG7?=
 =?us-ascii?Q?s98vVD5GBXfWrvMR5S86/Unh8afn/59k9pyLUJvZOGZJ4zm2nG2zjPTuRVeC?=
 =?us-ascii?Q?tRUcqlNHy4dkAUaHJ8HO9VItoCzUmy4SNyaazEPQg94kZfAP08EHwyRSNcgd?=
 =?us-ascii?Q?zH29e8A9hPsHlZ1kbpQCM3gLu2wpGYKncjweGGW6ATIOn6FrPLJniT0d/9bi?=
 =?us-ascii?Q?4FiZ3RUvb3iKU5rWk6lZBNOxiulBTCtgIMIK01i4simDUBn6FLNogOmvZUju?=
 =?us-ascii?Q?/U5Yia5GeZ8ZaDwiaWLqMCT4YUdsnjHfccQO0js6Mv9o2Zk+T2F4UJVoPp9E?=
 =?us-ascii?Q?oalkdDBybwl8lNvT76bemfZpHlSFulZnOull/RE0RjeXb9YinFlPn4x5XWAP?=
 =?us-ascii?Q?nT79nA+9KiF2eU6tElaDT1M0ALhks+TV9VSxp/AMYMziyQnfg4VQP4v+xomM?=
 =?us-ascii?Q?obW7E4ZuzaVXgUtCISig8BXgI7qqXIeRthIOBdyPVDdJElliwYMdnOsDotmd?=
 =?us-ascii?Q?iYQt6u8q1i6j2+SSWvsqw+Gy9eOpWG2QXRhBuX6KGkZOrQbTSsTZY5Y6gXfa?=
 =?us-ascii?Q?Rgn5z63t3EfdHWQ8/wuqKPvNdxG3jaQNl8ZcFbZngIDxHGVStnhcifeC9c8m?=
 =?us-ascii?Q?WR9fxzDksv8KmNR7HAsFIAttKoVHob7BhOX7QRQTmeQdEPTb/CptDdGb/Whp?=
 =?us-ascii?Q?FYMsk0pKMwnxQgC7Nnom9OFGkZ3zVzGlVmucMJFNLaIzn98jBU8HQhGPSHVz?=
 =?us-ascii?Q?L/BU9OAt4WqFd1CcYVpPMkg9d13IfC61Hf/3Io7iphMDufFl3OZHq+EvfWMK?=
 =?us-ascii?Q?quUUV7rgPj7ZlXCf0YyTpzazlGh+k7Ya974gO7Qkz7UrRFaafxtuTo3bfW5H?=
 =?us-ascii?Q?OkODZXDhYboqZ62H/8mPRBXet//oI1xo2Ga4u6l3mOzWGXg9NW5ZFazDu9wG?=
 =?us-ascii?Q?cbSngxGp/J52iiiwqOMULG2sHbTNUQLh5DmJ257ZHDI+X7un3WLufXxxJPG4?=
 =?us-ascii?Q?3O/4uIkH6tEWlVMAkeb3I/Mqg03CpWRlphz3UOSYN2y9BQyYRjXCeW5G0QDD?=
 =?us-ascii?Q?0vMQy4TvwuyQiYB+XEEiZV9AKiz8IALZPmbJpYEZeuLFQPf+ZC2OP/9wtwdK?=
 =?us-ascii?Q?ngj09PIap0/i1q+tmAbTj06O6759QaFayHPB5UA/stQNWjaRwDgFuB2Wrch1?=
 =?us-ascii?Q?Or+X++g6TPUiqO+O5rHV4qU0cSk/7vouXXtkNV5aRS/Gcxh6szWiuudOsssb?=
 =?us-ascii?Q?ssNrgTyhto779SMM9mJ4bcRAWh3oR8f8fWdXryGylF2xRm4M8ELiQ3Y6u0EQ?=
 =?us-ascii?Q?+rc8Rq1L/pPZUoel8RDe/1TbjoV4IuKd8EPXWJIC?=
X-OriginatorOrg: nxp.com
X-MS-Exchange-CrossTenant-Network-Message-Id: 20adf9f4-9aeb-4684-6d9f-08dbce6284a6
X-MS-Exchange-CrossTenant-AuthSource: AM6PR04MB4838.eurprd04.prod.outlook.com
X-MS-Exchange-CrossTenant-AuthAs: Internal
X-MS-Exchange-CrossTenant-OriginalArrivalTime: 16 Oct 2023 16:11:13.2782
 (UTC)
X-MS-Exchange-CrossTenant-FromEntityHeader: Hosted
X-MS-Exchange-CrossTenant-Id: 686ea1d3-bc2b-4c6f-a92c-d99c5c301635
X-MS-Exchange-CrossTenant-MailboxType: HOSTED
X-MS-Exchange-CrossTenant-UserPrincipalName: ALOakVC0kLLoXrmFwLvNmF8wqqhJRwrU+1MEoMbGs+Id3CFQa+GmgQyeIKlJZQyuhslUTwi9+OOP6LkiTN98Xw==
X-MS-Exchange-Transport-CrossTenantHeadersStamped: VI1PR04MB9905
X-Spam-Status: No, score=-2.1 required=5.0 tests=BAYES_00,DKIM_SIGNED,
        DKIM_VALID,DKIM_VALID_AU,DKIM_VALID_EF,RCVD_IN_DNSWL_BLOCKED,
        RCVD_IN_MSPIKE_H2,SPF_HELO_PASS,SPF_PASS autolearn=ham
        autolearn_force=no version=3.4.6
X-Spam-Checker-Version: SpamAssassin 3.4.6 (2021-04-09) on
        lindbergh.monkeyblade.net
Precedence: bulk
List-ID: <linux-kernel.vger.kernel.org>
X-Mailing-List: linux-kernel@vger.kernel.org
X-Greylist: Sender passed SPF test, not delayed by milter-greylist-4.6.4 (snail.vger.email [0.0.0.0]); Mon, 16 Oct 2023 09:11:44 -0700 (PDT)

On Mon, Oct 16, 2023 at 10:22:11AM -0500, Bjorn Helgaas wrote:
> On Mon, Oct 16, 2023 at 10:45:25AM -0400, Frank Li wrote:
> > On Tue, Oct 10, 2023 at 06:02:36PM +0200, Lorenzo Pieralisi wrote:
> > > On Tue, Oct 10, 2023 at 10:20:12AM -0400, Frank Li wrote:
> 
> > > > Ping
> > > 
> > > Read and follow please (and then ping us):
> > > https://lore.kernel.org/linux-pci/20171026223701.GA25649@bhelgaas-glaptop.roam.corp.google.com
> > 
> > Could you please help point which specic one was not follow aboved guide?
> > Then I can update my code. I think that's efficial communication method. I
> > think I have read it serial times. But not sure which one violate the
> > guide?
> > 
> > @Bjorn Helgaas. How do you think so? 
> 
> Since Lorenzo didn't point out anything specific in the patch itself,
> I think he was probably referring to the subject line and this advice:
> 
>   - Follow the existing convention, i.e., run "git log --oneline
>     <file>" and make yours match in format, capitalization, and
>     sentence structure.  For example, native host bridge driver patch
>     titles look like this:
> 
>       PCI: altera: Fix platform_get_irq() error handling
>       PCI: vmd: Remove IRQ affinity so we can allocate more IRQs
>       PCI: mediatek: Add MSI support for MT2712 and MT7622
>       PCI: rockchip: Remove IRQ domain if probe fails
> 
> In this case, your subject line was:
> 
>   PCI: layerscape: add suspend/resume for ls1021a
> 
> The advice was to run this:
> 
>   $ git log --oneline drivers/pci/controller/dwc/pci-layerscape.c
>   83c088148c8e PCI: Use PCI_HEADER_TYPE_* instead of literals
>   9fda4d09905d PCI: layerscape: Add power management support for ls1028a
>   277004d7a4a3 PCI: Remove unnecessary <linux/of_irq.h> includes
>   60b3c27fb9b9 PCI: dwc: Rename struct pcie_port to dw_pcie_rp
>   d23f0c11aca2 PCI: layerscape: Change to use the DWC common link-up check function
>   7007b745a508 PCI: layerscape: Convert to builtin_platform_driver()
>   60f5b73fa0f2 PCI: dwc: Remove unnecessary wrappers around dw_pcie_host_init()
>   b9ac0f9dc8ea PCI: dwc: Move dw_pcie_setup_rc() to DWC common code
>   f78f02638af5 PCI: dwc: Rework MSI initialization
> 
> Note that these summaries are all complete sentences that start with a
> capital letter:
> 
>   Use PCI_HEADER_TYPE_* instead of literals
>   Add power management support for ls1028a
>   Remove unnecessary <linux/of_irq.h> includes
>   ...
> 
> So yours could be this:
> 
>   PCI: layerscape: Add suspend/resume for ls1021a
>                    ^
> 
> This is trivial, obviously.  But the uppercase/lowercase distinction
> carries information, and it's an unnecessary distraction to notice
> that "oh, this is different from the rest; is the difference
> important or should I ignore it?"

Thanks. Not everyone think it is trivial. Especially for the one, who
English are not native language.

> 
> Obviously Lorenzo *could* edit all your subject lines on your behalf,
> but it makes everybody's life easier if people look at the existing
> code and follow the style when making changes.

Understand, but simple mark 'a' and 'A' to me. I will update patches and
take care for next time instead search whole docuemnt to guess which one
violated. I know I make some mistakes at here. But I am working on many
difference kernel subsystems, some require upper case, some require low
case, someone doesn't care.
 
I respected all reviewer's and maintaner's time, but I hope respected
the contributor's time also.

Just simple words like , 'a' to 'A' or
run git log --oneline to check subject. I will know what exact means. 

Do you think it will better than below words

"Read and follow please (and then ping us):                           
https://lore.kernel.org/linux-pci/20171026223701.GA25649@bhelgaas-glaptop.roam.corp.google.com"

Frank

> 
> E.g., write subject lines that are similar in style to previous ones,
> name local variables similarly to other functions, use line lengths
> consistent with the rest of the file, etc.  After applying a change,
> the file should look like a coherent whole; we should not be able to
> tell that this hunk was added later by somebody else.  This all helps
> make the code (and the git history) more readable and maintainable.
> 
> Bjorn