Received-SPF: pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::1:20 as permitted sender) client-ip=2620:137:e000::1:20;
Date:   Fri, 28 Oct 2022 10:15:12 -0500
From:   Bjorn Helgaas <helgaas@kernel.org>
To:     LeoLiuoc <LeoLiu-oc@zhaoxin.com>
Cc:     Sathyanarayanan Kuppuswamy 
        <sathyanarayanan.kuppuswamy@linux.intel.com>, rafael@kernel.org,
        lenb@kernel.org, james.morse@arm.com, tony.luck@intel.com,
        bp@alien8.de, robert.moore@intel.com, ying.huang@intel.com,
        rdunlap@infradead.org, bhelgaas@google.com,
        linux-acpi@vger.kernel.org, linux-pci@vger.kernel.org,
        linux-kernel@vger.kernel.org, devel@acpica.org,
        CobeChen@zhaoxin.com, TonyWWang@zhaoxin.com, ErosZhang@zhaoxin.com
Subject: Re: [PATCH 0/5] Parse the PCIE AER structure and set to relevant
 registers
Message-ID: <20221028151512.GA889708@bhelgaas>
MIME-Version: 1.0
Content-Type: text/plain; charset=utf-8
Content-Disposition: inline
Content-Transfer-Encoding: 8bit
In-Reply-To: <d4096cf3-7f16-b20c-01ea-e235bc90ae77@zhaoxin.com>
Precedence: bulk

On Fri, Oct 28, 2022 at 07:19:25PM +0800, LeoLiuoc wrote:
> 在 2022/10/27 12:17, Sathyanarayanan Kuppuswamy 写道:
> > On 10/26/22 8:14 PM, LeoLiu-oc wrote:

> > Can you add spec reference?
> > 
> Please refer to Section 18.3.2 ACPI Error Source of acpi spec v6.3. Links to
> the online versions of ACPI Spec 6.3 is
> https://uefi.org/htmlspecs/ACPI_Spec_6_4_html/18_ACPI_Platform_Error_Interfaces/error-source-discovery.html#acpi-error-source.
> 
> Section 18.3.2.4 describes PCI Express Root Port AER Structure, section
> 18.3.2.5 describes PCI Express Device AER Structure, section 18.3.2.6
> describes PCI Express/PCI-X Bridge AER Structure.

Thanks.  It's OK to have the spec references in the email thread, but
the real point is that they should be in the commit log and, when it
makes sense, in code comments.

Cite the most recent spec version when you can.  In this case, I think
it is ACPI r6.5.

Personally I don't really care for URL references because they tend to
get stale over time as websites are reorganized and domains change.
Something like "ACPI r6.5, sec 18.3.2.4" is unambiguous and will
remain usable forever.

Bjorn