From mboxrd@z Thu Jan 1 00:00:00 1970 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 vger.kernel.org (vger.kernel.org [23.128.96.18]) by smtp.lore.kernel.org (Postfix) with ESMTP id 38BC0C77B7A for ; Wed, 24 May 2023 09:12:09 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S239858AbjEXJMI convert rfc822-to-8bit (ORCPT ); Wed, 24 May 2023 05:12:08 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:40500 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S240566AbjEXJMF (ORCPT ); Wed, 24 May 2023 05:12:05 -0400 Received: from frasgout.his.huawei.com (frasgout.his.huawei.com [185.176.79.56]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id 69A4EFC for ; Wed, 24 May 2023 02:12:02 -0700 (PDT) Received: from lhrpeml500005.china.huawei.com (unknown [172.18.147.207]) by frasgout.his.huawei.com (SkyGuard) with ESMTP id 4QR51838d4z6H7vb; Wed, 24 May 2023 17:07:24 +0800 (CST) Received: from localhost (10.122.247.231) by lhrpeml500005.china.huawei.com (7.191.163.240) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256) id 15.1.2507.23; Wed, 24 May 2023 10:11:59 +0100 Date: Wed, 24 May 2023 10:11:58 +0100 From: Jonathan Cameron To: Markus Armbruster CC: , Michael Tsirkin , Fan Ni , , , Ira Weiny , Alison Schofield , Michael Roth , Philippe =?ISO-8859-1?Q?Mathieu-Daud=E9?= , Dave Jiang , , Eric Blake , Mike Maslenkin , =?ISO-8859-1?Q?Marc-Andr=E9?= Lureau , "Thomas Huth" Subject: Re: [PATCH v5 5/7] hw/cxl/events: Add injection of General Media Events Message-ID: <20230524101158.0000579d@huawei.com> In-Reply-To: <87ttw35i6q.fsf@pond.sub.org> References: <20230423165140.16833-1-Jonathan.Cameron@huawei.com> <20230423165140.16833-6-Jonathan.Cameron@huawei.com> <87lehgq1cy.fsf@pond.sub.org> <20230522135737.000079c4@Huawei.com> <87fs7na2o8.fsf@pond.sub.org> <20230523113543.00006a1f@Huawei.com> <87ttw35i6q.fsf@pond.sub.org> Organization: Huawei Technologies R&D (UK) Ltd. X-Mailer: Claws Mail 4.0.0 (GTK+ 3.24.29; x86_64-w64-mingw32) MIME-Version: 1.0 Content-Type: text/plain; charset="utf-8" Content-Transfer-Encoding: 8BIT X-Originating-IP: [10.122.247.231] X-ClientProxiedBy: lhrpeml500005.china.huawei.com (7.191.163.240) To lhrpeml500005.china.huawei.com (7.191.163.240) X-CFilter-Loop: Reflected Precedence: bulk List-ID: X-Mailing-List: linux-cxl@vger.kernel.org On Tue, 23 May 2023 14:46:37 +0200 Markus Armbruster wrote: > Jonathan Cameron writes: > > >> > > >> >> > +# > >> >> > +# Inject an event record for a General Media Event (CXL r3.0 8.2.9.2.1.1) > >> >> > >> >> What's "CXL r3.0", and where could a reader find it? > >> > > >> > We have docs in docs/system/devices/cxl.rst that include the consortium > >> > website which has download links on the front page. > >> > >> cxl.rst has > >> > >> References > >> ---------- > >> > >> - Consortium website for specifications etc: > >> http://www.computeexpresslink.org > >> - Compute Express link Revision 2 specification, October 2020 > >> - CEDT CFMWS & QTG _DSM ECN May 2021 > >> > >> Should the second reference be updated to 3.0? Exact title seems to be > >> "The Compute Express Link™ (CXL™) 3.0 specification". Not sure we need > >> to bother with the "™" in a reference. > > > > Yes. On the todo list is to update all the references to latest released > > specification because old ones are unobtainable to non consortium members > > unless they grabbed a copy in the past. > > > > Annoyingly this will be a repeated requirement as new spec versions are released > > but the cadence should be fairly low. > > > >> > >> > I'm not sure we want to > >> > have lots of references to the URL spread throughout QEMU. I can add one > >> > somewhere in cxl.json if you think it is important to have one here as well. > >> > >> You could add an introduction right under the "# = CXL devices" heading, > >> and include a full reference to the specification there. Suitably > >> abbreviated references like the ones you use in this patch should then > >> be fine. > > > > I tried doing that - it resulted in the index including an entry with all the text. > > So on the webpage, the contents list to the left includes whatever text you put > > in that block. > > > > I'm not sure why, or how to fix that. > > Show me what you tried (as a patch or something I can git-pull), and > I'll have a look. > > [...] > Very simple to replicate the issue - see below. Result of this is an extra "Test text" entry in the index to the left of the html docs. In qemu-qmp-ref.html we have
  • CXL devices
    • Test text
    • CxlEventLog (Enum)
      • diff --git a/qapi/cxl.json b/qapi/cxl.json index 05c560cfe5..9f7f0485ae 100644 --- a/qapi/cxl.json +++ b/qapi/cxl.json @@ -3,6 +3,8 @@ ## # = CXL devices +# +# Test text ## ##