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=-1.0 required=3.0 tests=HEADER_FROM_DIFFERENT_DOMAINS, MAILING_LIST_MULTI,SPF_HELO_NONE,SPF_PASS,URIBL_BLOCKED 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 3E365C04AAF for ; Tue, 21 May 2019 11:12:17 +0000 (UTC) Received: from lists.gnu.org (lists.gnu.org [209.51.188.17]) (using TLSv1 with cipher AES256-SHA (256/256 bits)) (No client certificate requested) by mail.kernel.org (Postfix) with ESMTPS id 171D42081C for ; Tue, 21 May 2019 11:12:16 +0000 (UTC) DMARC-Filter: OpenDMARC Filter v1.3.2 mail.kernel.org 171D42081C 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 ([127.0.0.1]:51554 helo=lists.gnu.org) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1hT2gq-0006JM-8d for qemu-devel@archiver.kernel.org; Tue, 21 May 2019 07:12:16 -0400 Received: from eggs.gnu.org ([209.51.188.92]:58760) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1hT2Wc-0006mH-HI for qemu-devel@nongnu.org; Tue, 21 May 2019 07:01:43 -0400 Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1hT2Wb-0003Uv-Cs for qemu-devel@nongnu.org; Tue, 21 May 2019 07:01:42 -0400 Received: from mail-wm1-f52.google.com ([209.85.128.52]:51088) by eggs.gnu.org with esmtps (TLS1.0:RSA_AES_128_CBC_SHA1:16) (Exim 4.71) (envelope-from ) id 1hT2Wb-0003UL-6L for qemu-devel@nongnu.org; Tue, 21 May 2019 07:01:41 -0400 Received: by mail-wm1-f52.google.com with SMTP id f204so2524642wme.0 for ; Tue, 21 May 2019 04:01:41 -0700 (PDT) X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:subject:to:cc:references:from:message-id:date :user-agent:mime-version:in-reply-to:content-language :content-transfer-encoding; bh=ZOMC6HHFLJupWValHetArLkjeol+mF3LRE2pj6Idbec=; b=M95tXbLDWPODdVxYTzwXBkQO82ZEStOTH0oGV7G8A2xe8L948KqBxj2pjV03ndy2LE 1srjNy6MGPSUT2CwvW3FkZslLZHSFfNIL0MdIk2y0pLoCbov38j7hST9R7iPQULW98bR alYui9KKNgoJi/GMUvUWFGS6pR2TzNB7W3+2OE1pCuMsdFCR1kNssnUh8I2HJaUYvIIx l77yy3E1Raj/Zdj6DFIa99Zt3tIA6dY+9c/MEJcZN7fApDkc9mzXdi6Rr7XZ+eytvhFL R81Y1Z/z1Qo5b6/w3Y9DqAGL+6QHFR2X3xhvorW1cPL3Q3aHx/iBeoV0V4Y0nRk74qG8 Dksw== X-Gm-Message-State: APjAAAXFJOFdzG4m4sSiSkgYWFifk6ezajgHAcVfDHokmfsvq4YdxIWS FfWwbVlRqPxZv1ujW/6Py7wEPQ== X-Google-Smtp-Source: APXvYqy9LO0CVRakm7WCbl8FQmwCS/KgfoEUGnzcM6w8WnWycsI1kS/Z7LrT8tiq8Wh6kgrIt7FPnQ== X-Received: by 2002:a1c:eb07:: with SMTP id j7mr2830066wmh.138.1558436500155; Tue, 21 May 2019 04:01:40 -0700 (PDT) Received: from ?IPv6:2001:b07:6468:f312:ac04:eef9:b257:b844? ([2001:b07:6468:f312:ac04:eef9:b257:b844]) by smtp.gmail.com with ESMTPSA id 6sm25731054wrd.51.2019.05.21.04.01.39 (version=TLS1_2 cipher=ECDHE-RSA-AES128-GCM-SHA256 bits=128/128); Tue, 21 May 2019 04:01:39 -0700 (PDT) To: Peter Maydell , Eduardo Habkost References: <20190520184108.GA10764@habkost.net> From: Paolo Bonzini Message-ID: <34f9ddb5-a4b2-e8ed-ba10-f43036276d4b@redhat.com> Date: Tue, 21 May 2019 13:01:38 +0200 User-Agent: Mozilla/5.0 (X11; Linux x86_64; rv:60.0) Gecko/20100101 Thunderbird/60.6.1 MIME-Version: 1.0 In-Reply-To: Content-Type: text/plain; charset=utf-8 Content-Language: en-US Content-Transfer-Encoding: 7bit X-detected-operating-system: by eggs.gnu.org: GNU/Linux 2.2.x-3.x [generic] [fuzzy] X-Received-From: 209.85.128.52 Subject: Re: [Qemu-devel] Introducing GSoC project: API Documentation Generation X-BeenThere: qemu-devel@nongnu.org X-Mailman-Version: 2.1.21 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Cc: "Daniel P. Berrange" , Gabriel Barreto , QEMU Developers , "Emilio G. Cota" , Stefan Hajnoczi , Cleber Rosa , John Snow Errors-To: qemu-devel-bounces+qemu-devel=archiver.kernel.org@nongnu.org Sender: "Qemu-devel" On 21/05/19 11:42, Peter Maydell wrote: > (The other interesting thing I'd wondered about with generation > of docs from code comments is whether we would get better > (ie more accurate, regularly updated) documentation of our > supported machine models if we generated those parts of the > docs from comments. But that's definitely much harder than just > getting API documentation, because it involves trying to > integrate them into a 'user documentation' manual which we > have not yet converted from texinfo.) For the user documentation, makeinfo can produce docbook, and that seems to be the best way to convert out of Texinfo. At that point you can either pass docbook to sphinx (see https://wiki.qemu.org/Features/Documentation though it's a bit out of date), or convert it to rST using Pandoc. Paolo