From nobody Sun Dec 22 06:23:45 2024 Delivered-To: importer@patchew.org Received-SPF: pass (zohomail.com: domain of redhat.com designates 170.10.133.124 as permitted sender) client-ip=170.10.133.124; envelope-from=libvir-list-bounces@redhat.com; helo=us-smtp-delivery-124.mimecast.com; Authentication-Results: mx.zohomail.com; dkim=pass; spf=pass (zohomail.com: domain of redhat.com designates 170.10.133.124 as permitted sender) smtp.mailfrom=libvir-list-bounces@redhat.com; dmarc=pass(p=none dis=none) header.from=redhat.com ARC-Seal: i=1; a=rsa-sha256; t=1684945328; cv=none; d=zohomail.com; s=zohoarc; b=jH/Tjrjrm4BzbhOP5sItkANqmZ+rz4Ucf3RFQxoM4U1riwfPzMV8nR/MZozI1DVLISJhVce0nnxnO+D389aI8v1Y6TfpZhjRZRo3Gew9hwgimbHw3//9CB8jZsZbaEWjln6kHQ9ejsylML8HnKEapGQ2hFav7DK1sbErm5ytT3U= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zohomail.com; s=zohoarc; t=1684945328; h=Content-Type:Content-Transfer-Encoding:Date:From:In-Reply-To:List-Subscribe:List-Post:List-Id:List-Archive:List-Help:List-Unsubscribe:MIME-Version:Message-ID:References:Sender:Subject:To; bh=NedVTE7s2SoFiu3hDxJZTzY7l3nqKgvIn3QjBjlob+E=; b=HSUw/GS0EbCWJXeju6o5roOPKvS+lbSqsg8A1V2Bm3vZEG71awYu2zfM9TOzdjy21YOFNaNp9I9dHWDNyHbdWC3P/8VvOPaNdmQaAFOFneJjJzmxYXbauV7/coxGGVx/6w+FkhL9RPkxB0KPGlEkbblqAmd5T/+aB7C9m+kTQT4= ARC-Authentication-Results: i=1; mx.zohomail.com; dkim=pass; spf=pass (zohomail.com: domain of redhat.com designates 170.10.133.124 as permitted sender) smtp.mailfrom=libvir-list-bounces@redhat.com; dmarc=pass header.from= (p=none dis=none) Return-Path: Received: from us-smtp-delivery-124.mimecast.com (us-smtp-delivery-124.mimecast.com [170.10.133.124]) by mx.zohomail.com with SMTPS id 1684945328444369.64102509802; Wed, 24 May 2023 09:22:08 -0700 (PDT) Received: from mimecast-mx02.redhat.com (mimecast-mx02.redhat.com [66.187.233.88]) by relay.mimecast.com with ESMTP with STARTTLS (version=TLSv1.2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id us-mta-472-Nb3Agl7pOQiU_v2VWXDEUA-1; Wed, 24 May 2023 12:21:15 -0400 Received: from smtp.corp.redhat.com (int-mx08.intmail.prod.int.rdu2.redhat.com [10.11.54.8]) (using TLSv1.2 with cipher AECDH-AES256-SHA (256/256 bits)) (No client certificate requested) by mimecast-mx02.redhat.com (Postfix) with ESMTPS id 8291985828A; Wed, 24 May 2023 16:21:12 +0000 (UTC) Received: from mm-prod-listman-01.mail-001.prod.us-east-1.aws.redhat.com (unknown [10.30.29.100]) by smtp.corp.redhat.com (Postfix) with ESMTP id 0A2D4C164ED; Wed, 24 May 2023 16:21:11 +0000 (UTC) Received: from mm-prod-listman-01.mail-001.prod.us-east-1.aws.redhat.com (localhost [IPv6:::1]) by mm-prod-listman-01.mail-001.prod.us-east-1.aws.redhat.com (Postfix) with ESMTP id AC27D19465A8; Wed, 24 May 2023 16:21:10 +0000 (UTC) Received: from smtp.corp.redhat.com (int-mx10.intmail.prod.int.rdu2.redhat.com [10.11.54.10]) by mm-prod-listman-01.mail-001.prod.us-east-1.aws.redhat.com (Postfix) with ESMTP id B058919465A0 for ; Wed, 24 May 2023 16:21:09 +0000 (UTC) Received: by smtp.corp.redhat.com (Postfix) id 86C38492B0B; Wed, 24 May 2023 16:21:09 +0000 (UTC) Received: from localhost.localdomain (unknown [10.43.2.39]) by smtp.corp.redhat.com (Postfix) with ESMTP id 2F02E492B0A for ; Wed, 24 May 2023 16:21:09 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1684945327; h=from:from:sender:sender: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: in-reply-to:in-reply-to:references:references:list-id:list-help: list-unsubscribe:list-subscribe:list-post; bh=NedVTE7s2SoFiu3hDxJZTzY7l3nqKgvIn3QjBjlob+E=; b=Yp+7Z6ohURjvGTeJvmwpD/Vgd7LhcWAHJ07WgeQ7PYHeH4pzgWPi6f1zXJw5m0ygNyDMBL vD53G+YirAoR5uN4OG4a1DVKQd/O3Y21tA2S9Nq3gCTFkoImo28Z93M3qggLIKt9sSuGlp M33qOCgCOHjYbInQ2Cs+8puJeL+gD9w= X-MC-Unique: Nb3Agl7pOQiU_v2VWXDEUA-1 X-Original-To: libvir-list@listman.corp.redhat.com From: Michal Privoznik To: libvir-list@redhat.com Subject: [PATCH 1/3] docs: newapi.xsl: Generate docs on generic typedefs Date: Wed, 24 May 2023 18:21:05 +0200 Message-Id: In-Reply-To: References: MIME-Version: 1.0 X-Scanned-By: MIMEDefang 3.1 on 10.11.54.10 X-BeenThere: libvir-list@redhat.com X-Mailman-Version: 2.1.29 Precedence: list List-Id: Development discussions about the libvirt library & tools List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: libvir-list-bounces@redhat.com Sender: "libvir-list" X-Scanned-By: MIMEDefang 3.1 on 10.11.54.8 X-Mimecast-Spam-Score: 0 X-Mimecast-Originator: redhat.com Content-Transfer-Encoding: quoted-printable X-ZohoMail-DKIM: pass (identity @redhat.com) X-ZM-MESSAGEID: 1684945329471100001 Content-Type: text/plain; charset="utf-8"; x-default="true" We have plenty of generic typedefs (that basically just alias a struct, or our popular virXXXPtr). Because we do not generate HTML docs for it, the documentation is placed at random places, e.g.: comment from virDomainPtr typedef ("a virDomainPtr is pointer to a virDomain private structure ...") ends up after virDomainProcessSignal enum block. There are some less weird occurrences of this problem (e.g. virBlkioParameterPtr), but yet - the typedef appears in TOC. Therefore, generate a block for each typedef and put its description there. Signed-off-by: Michal Privoznik Reviewed-by: Peter Krempa --- docs/newapi.xsl | 20 ++++++++++++++++++++ 1 file changed, 20 insertions(+) diff --git a/docs/newapi.xsl b/docs/newapi.xsl index a8797f800d..3ddcc27d96 100644 --- a/docs/newapi.xsl +++ b/docs/newapi.xsl @@ -324,6 +324,26 @@ =20 + + + +

+
+ 
+        typedef 
+        
+         
+        
+        ;
+
+
+
+ + + +
+ + typedef --=20 2.39.3