From mboxrd@z Thu Jan 1 00:00:00 1970 Received: from eggs.gnu.org ([2001:4830:134:3::10]:47124) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1WKlsG-0002PV-Ch for qemu-devel@nongnu.org; Tue, 04 Mar 2014 04:43:04 -0500 Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1WKls7-0002dr-RQ for qemu-devel@nongnu.org; Tue, 04 Mar 2014 04:42:56 -0500 Received: from mail-ea0-x22b.google.com ([2a00:1450:4013:c01::22b]:59483) by eggs.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1WKls7-0002dc-Kv for qemu-devel@nongnu.org; Tue, 04 Mar 2014 04:42:47 -0500 Received: by mail-ea0-f171.google.com with SMTP id n15so215627ead.2 for ; Tue, 04 Mar 2014 01:42:46 -0800 (PST) Date: Tue, 4 Mar 2014 10:42:44 +0100 From: Stefan Hajnoczi Message-ID: <20140304094244.GH25676@stefanha-thinkpad.redhat.com> References: <1393901250-3922-1-git-send-email-xbing6@gmail.com> <1393901250-3922-2-git-send-email-xbing6@gmail.com> MIME-Version: 1.0 Content-Type: text/plain; charset=us-ascii Content-Disposition: inline In-Reply-To: <1393901250-3922-2-git-send-email-xbing6@gmail.com> Subject: Re: [Qemu-devel] [Discussion 01/10] docs: add docs/api-hierarchy.txt List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , To: Xuebing Wang Cc: pbonzini@redhat.com, qemu-devel@nongnu.org, stefanha@redhat.com, afaerber@suse.de On Tue, Mar 04, 2014 at 10:47:21AM +0800, Xuebing Wang wrote: > Signed-off-by: Xuebing Wang > --- > docs/api-hierarchy.txt | 93 ++++++++++++++++++++++++++++++++++++++++++++++++ > 1 file changed, 93 insertions(+) > create mode 100644 docs/api-hierarchy.txt This type of documentation gets outdated really quickly. I'm not sure it should be merged. Documenting the various APIs as doc comments in the code would have a better chance of staying up-to-date.