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 X-Spam-Level: X-Spam-Status: No, score=-6.5 required=3.0 tests=DKIM_INVALID,DKIM_SIGNED, HEADER_FROM_DIFFERENT_DOMAINS,INCLUDES_PATCH,MAILING_LIST_MULTI,SIGNED_OFF_BY, SPF_HELO_NONE,SPF_PASS autolearn=ham autolearn_force=no version=3.4.0 Received: from mail.kernel.org (mail.kernel.org [198.145.29.99]) by smtp.lore.kernel.org (Postfix) with ESMTP id 2C885C282DD for ; Tue, 7 Jan 2020 19:14:48 +0000 (UTC) Received: from lists.gnu.org (lists.gnu.org [209.51.188.17]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by mail.kernel.org (Postfix) with ESMTPS id ECB7F20715 for ; Tue, 7 Jan 2020 19:14:47 +0000 (UTC) Authentication-Results: mail.kernel.org; dkim=fail reason="signature verification failed" (1024-bit key) header.d=redhat.com header.i=@redhat.com header.b="TZxprrX2" DMARC-Filter: OpenDMARC Filter v1.3.2 mail.kernel.org ECB7F20715 Authentication-Results: mail.kernel.org; dmarc=fail (p=none dis=none) header.from=redhat.com Authentication-Results: mail.kernel.org; spf=pass smtp.mailfrom=qemu-devel-bounces+qemu-devel=archiver.kernel.org@nongnu.org Received: from localhost ([::1]:55198 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1iouJT-0006Sj-4B for qemu-devel@archiver.kernel.org; Tue, 07 Jan 2020 14:14:47 -0500 Received: from eggs.gnu.org ([2001:470:142:3::10]:48552) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1iouEN-00060k-Ib for qemu-devel@nongnu.org; Tue, 07 Jan 2020 14:09:32 -0500 Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1iouEL-0000Cc-Ms for qemu-devel@nongnu.org; Tue, 07 Jan 2020 14:09:31 -0500 Received: from us-smtp-delivery-1.mimecast.com ([205.139.110.120]:47767 helo=us-smtp-1.mimecast.com) by eggs.gnu.org with esmtps (TLS1.0:DHE_RSA_AES_256_CBC_SHA1:32) (Exim 4.71) (envelope-from ) id 1iouDs-0008HC-AK for qemu-devel@nongnu.org; Tue, 07 Jan 2020 14:09:29 -0500 DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1578424139; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:cc:content-type:content-type: content-transfer-encoding:content-transfer-encoding: in-reply-to:in-reply-to:references:references; bh=qwwjZfuXHTJiRDFXEIgu86wloW0KwDqRtkL2MWLXEHg=; b=TZxprrX2nInJbifvUg1yw5PqlWiJf9Ir8ae1Zj7h1I6XHxf82uhCFkntb8WNqtrIVbeqAQ fA4Z7pNmH9AAu/X9YNqY09DHB6JuScWgmoK1CbXZoJmuBxS8NQOvHpIwtO2rxDvQPCIGPB H1je0bCiIqSzVYcYgMtDs921Z+/PTMs= 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-166-Ts-eN9WbNI2AQfG9WJA95Q-1; Tue, 07 Jan 2020 14:08:55 -0500 Received: from smtp.corp.redhat.com (int-mx02.intmail.prod.int.phx2.redhat.com [10.5.11.12]) (using TLSv1.2 with cipher AECDH-AES256-SHA (256/256 bits)) (No client certificate requested) by mimecast-mx01.redhat.com (Postfix) with ESMTPS id 4580310AF376; Tue, 7 Jan 2020 19:08:54 +0000 (UTC) Received: from thuth.com (ovpn-116-83.ams2.redhat.com [10.36.116.83]) by smtp.corp.redhat.com (Postfix) with ESMTP id 0690560E1C; Tue, 7 Jan 2020 19:08:52 +0000 (UTC) From: Thomas Huth To: qemu-devel@nongnu.org, Peter Maydell Subject: [PULL 8/8] docs: build an index page for the HTML docs Date: Tue, 7 Jan 2020 20:08:02 +0100 Message-Id: <20200107190802.2257-9-thuth@redhat.com> In-Reply-To: <20200107190802.2257-1-thuth@redhat.com> References: <20200107190802.2257-1-thuth@redhat.com> X-Scanned-By: MIMEDefang 2.79 on 10.5.11.12 X-MC-Unique: Ts-eN9WbNI2AQfG9WJA95Q-1 X-Mimecast-Spam-Score: 0 Content-Type: text/plain; charset=US-ASCII 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: 205.139.110.120 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: =?UTF-8?q?Alex=20Benn=C3=A9e?= , Stefan Hajnoczi Errors-To: qemu-devel-bounces+qemu-devel=archiver.kernel.org@nongnu.org Sender: "Qemu-devel" From: Stefan Hajnoczi 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 Message-Id: <20191219135620.1626608-1-stefanha@redhat.com> Signed-off-by: Thomas Huth --- 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 6b5ad1121b..32bd554480 100644 --- a/Makefile +++ b/Makefile @@ -343,6 +343,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 @@ -811,6 +812,7 @@ install-sphinxdocs: sphinxdocs =20 install-doc: $(DOCS) install-sphinxdocs =09$(INSTALL_DIR) "$(DESTDIR)$(qemu_docdir)" +=09$(INSTALL_DATA) $(MANUAL_BUILDDIR)/index.html "$(DESTDIR)$(qemu_docdir)= " =09$(INSTALL_DATA) qemu-doc.html "$(DESTDIR)$(qemu_docdir)" =09$(INSTALL_DATA) qemu-doc.txt "$(DESTDIR)$(qemu_docdir)" =09$(INSTALL_DATA) docs/interop/qemu-qmp-ref.html "$(DESTDIR)$(qemu_docdir= )" @@ -1017,6 +1019,10 @@ $(MANUAL_BUILDDIR)/specs/index.html: $(call manual-d= eps,specs) $(MANUAL_BUILDDIR)/interop/qemu-ga.8: $(call manual-deps,interop) =09$(call build-manual,interop,man) =20 +$(MANUAL_BUILDDIR)/index.html: $(SRC_PATH)/docs/index.html.in qemu-version= .h +=09$(call quiet-command, sed "s|@@VERSION@@|${VERSION}|g" $< >$@, \ + "GEN","$@") + qemu-options.texi: $(SRC_PATH)/qemu-options.hx $(SRC_PATH)/scripts/hxtool =09$(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.18.1