From nobody Fri May 3 21:13:15 2024 Delivered-To: importer@patchew.org Received-SPF: pass (zohomail.com: domain of gnu.org designates 209.51.188.17 as permitted sender) client-ip=209.51.188.17; envelope-from=qemu-devel-bounces+importer=patchew.org@nongnu.org; helo=lists.gnu.org; Authentication-Results: mx.zohomail.com; dkim=fail; spf=pass (zohomail.com: domain of gnu.org designates 209.51.188.17 as permitted sender) smtp.mailfrom=qemu-devel-bounces+importer=patchew.org@nongnu.org; dmarc=fail(p=none dis=none) header.from=redhat.com ARC-Seal: i=1; a=rsa-sha256; t=1576763920; cv=none; d=zohomail.com; s=zohoarc; b=VKMnCfMYcfnHcAHHzmnfo0Tbw8BgBR49Jjx/Or52AoBagpV/pKphBYyBvwBcxpaidOxrXBAb7AfsnGvhBks7jIDMORSgqm1wKAh12pndeqvxt1bsqPrQoKdZfvz+l3i4ZdSadgppZc4o9ZRP9t51tkSk7WfdPdoKpexmkvQi0N0= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zohomail.com; s=zohoarc; t=1576763920; h=Content-Type:Content-Transfer-Encoding:Cc:Date:From:List-Subscribe:List-Post:List-Id:List-Archive:List-Help:List-Unsubscribe:MIME-Version:Message-ID:Sender:Subject:To; bh=Xu2SS5d3B9ghiw5I2mwzyuILj2kDLW9L9c3Ai/O7Ass=; b=Pl7010WeQOb9W5lxsNKERbMoijOpaIMI7vTzDwpiCXkZ6tmpx6BtQRYWCLyRUW0YM5OWA+YRlj9gmRQejFTcdbGOj2hfpskXR8VYeku5wAqIOProTs9lvijpRc6dSs0rilVPYaGcHRg0dRQvNCy0hhq7pvzkW7VNZHB2pTvX+9Y= ARC-Authentication-Results: i=1; mx.zohomail.com; dkim=fail; spf=pass (zohomail.com: domain of gnu.org designates 209.51.188.17 as permitted sender) smtp.mailfrom=qemu-devel-bounces+importer=patchew.org@nongnu.org; dmarc=fail header.from= (p=none dis=none) header.from= Return-Path: Received: from lists.gnu.org (lists.gnu.org [209.51.188.17]) by mx.zohomail.com with SMTPS id 1576763920633336.5414590082197; Thu, 19 Dec 2019 05:58:40 -0800 (PST) Received: from localhost ([::1]:41996 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1ihwK4-0006gh-3Z for importer@patchew.org; Thu, 19 Dec 2019 08:58:36 -0500 Received: from eggs.gnu.org ([2001:470:142:3::10]:38293) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1ihwI7-0004Kd-4V for qemu-devel@nongnu.org; Thu, 19 Dec 2019 08:56:36 -0500 Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1ihwI3-0006R6-BL for qemu-devel@nongnu.org; Thu, 19 Dec 2019 08:56:32 -0500 Received: from us-smtp-1.mimecast.com ([207.211.31.81]:32560 helo=us-smtp-delivery-1.mimecast.com) by eggs.gnu.org with esmtps (TLS1.0:DHE_RSA_AES_256_CBC_SHA1:32) (Exim 4.71) (envelope-from ) id 1ihwI2-0006JA-V8 for qemu-devel@nongnu.org; Thu, 19 Dec 2019 08:56:31 -0500 Received: from mimecast-mx01.redhat.com (mimecast-mx01.redhat.com [209.132.183.4]) (Using TLS) by relay.mimecast.com with ESMTP id us-mta-397-gWy7XR_ANCK0BeoPuIn2RQ-1; Thu, 19 Dec 2019 08:56:25 -0500 Received: from smtp.corp.redhat.com (int-mx03.intmail.prod.int.phx2.redhat.com [10.5.11.13]) (using TLSv1.2 with cipher AECDH-AES256-SHA (256/256 bits)) (No client certificate requested) by mimecast-mx01.redhat.com (Postfix) with ESMTPS id 9A770DB61; Thu, 19 Dec 2019 13:56:24 +0000 (UTC) Received: from localhost (ovpn-117-102.ams2.redhat.com [10.36.117.102]) by smtp.corp.redhat.com (Postfix) with ESMTP id B69417C823; Thu, 19 Dec 2019 13:56:21 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1576763789; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:cc:mime-version:mime-version:content-type:content-type: content-transfer-encoding:content-transfer-encoding; bh=Xu2SS5d3B9ghiw5I2mwzyuILj2kDLW9L9c3Ai/O7Ass=; b=SU2Q5kkL1HGVkxA/ufqGqOj0T3dqvzzpaCwtmYi75sxtO4w37FiKUiGKGoYk6n3fxwba6j Bi9ddZEjOnA/M3hDYhpd3+QW7BcHZEf+zengWWA1zhswiSwOZkz/gno0fJCAMcy0Sr7yKY vUP6i4hGZE6Ntjz23zSflecAtOg4f7k= From: Stefan Hajnoczi To: qemu-devel@nongnu.org Subject: [PATCH v3] docs: build an index page for the HTML docs Date: Thu, 19 Dec 2019 13:56:20 +0000 Message-Id: <20191219135620.1626608-1-stefanha@redhat.com> MIME-Version: 1.0 X-Scanned-By: MIMEDefang 2.79 on 10.5.11.13 X-MC-Unique: gWy7XR_ANCK0BeoPuIn2RQ-1 X-Mimecast-Spam-Score: 0 Content-Transfer-Encoding: quoted-printable X-detected-operating-system: by eggs.gnu.org: GNU/Linux 2.2.x-3.x [generic] [fuzzy] X-Received-From: 207.211.31.81 X-BeenThere: qemu-devel@nongnu.org X-Mailman-Version: 2.1.23 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Cc: Peter Maydell , Thomas Huth , Daniel Berrange , Stefan Hajnoczi Errors-To: qemu-devel-bounces+importer=patchew.org@nongnu.org Sender: "Qemu-devel" X-ZohoMail-DKIM: fail (Header signature does not verify) Content-Type: text/plain; charset="utf-8" There is no index.html start page for the QEMU HTML documentation. An index page is needed so that documentation can be browsed easily on the web. This patch adds an index.html.in template file where the QEMU version number is expanded. It is written in HTML instead of using the existing sphinx (rST) and texi documentation generators because they are heavyweight and would make this harder. Signed-off-by: Stefan Hajnoczi Reviewed-by: Thomas Huth --- v3: * Add attribute to satisfy the W3 Validator [Thomas Hut= h] --- Makefile | 6 ++++++ docs/index.html.in | 17 +++++++++++++++++ 2 files changed, 23 insertions(+) create mode 100644 docs/index.html.in diff --git a/Makefile b/Makefile index 1361def144..9da9cfda73 100644 --- a/Makefile +++ b/Makefile @@ -347,6 +347,7 @@ DOCS+=3Ddocs/interop/qemu-qmp-ref.html docs/interop/qem= u-qmp-ref.txt docs/interop/ DOCS+=3Ddocs/interop/qemu-ga-ref.html docs/interop/qemu-ga-ref.txt docs/in= terop/qemu-ga-ref.7 DOCS+=3Ddocs/qemu-block-drivers.7 DOCS+=3Ddocs/qemu-cpu-models.7 +DOCS+=3D$(MANUAL_BUILDDIR)/index.html ifdef CONFIG_VIRTFS DOCS+=3Dfsdev/virtfs-proxy-helper.1 endif @@ -819,6 +820,7 @@ install-sphinxdocs: sphinxdocs =20 install-doc: $(DOCS) install-sphinxdocs $(INSTALL_DIR) "$(DESTDIR)$(qemu_docdir)" + $(INSTALL_DATA) $(MANUAL_BUILDDIR)/index.html "$(DESTDIR)$(qemu_docdir)" $(INSTALL_DATA) qemu-doc.html "$(DESTDIR)$(qemu_docdir)" $(INSTALL_DATA) qemu-doc.txt "$(DESTDIR)$(qemu_docdir)" $(INSTALL_DATA) docs/interop/qemu-qmp-ref.html "$(DESTDIR)$(qemu_docdir)" @@ -1025,6 +1027,10 @@ $(MANUAL_BUILDDIR)/specs/index.html: $(call manual-d= eps,specs) $(MANUAL_BUILDDIR)/interop/qemu-ga.8: $(call manual-deps,interop) $(call build-manual,interop,man) =20 +$(MANUAL_BUILDDIR)/index.html: $(SRC_PATH)/docs/index.html.in qemu-version= .h + $(call quiet-command, sed "s|@@VERSION@@|${VERSION}|g" $< >$@, \ + "GEN","$@") + qemu-options.texi: $(SRC_PATH)/qemu-options.hx $(SRC_PATH)/scripts/hxtool $(call quiet-command,sh $(SRC_PATH)/scripts/hxtool -t < $< > $@,"GEN","$@= ") =20 diff --git a/docs/index.html.in b/docs/index.html.in new file mode 100644 index 0000000000..94eb782cf7 --- /dev/null +++ b/docs/index.html.in @@ -0,0 +1,17 @@ + + + + + QEMU @@VERSION@@ Documentation + + +

QEMU @@VERSION@@ Documentation

+ + + --=20 2.23.0