From patchwork Mon Aug 5 18:44:03 2013 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Charlie Shepherd X-Patchwork-Id: 264747 Return-Path: X-Original-To: incoming@patchwork.ozlabs.org Delivered-To: patchwork-incoming@bilbo.ozlabs.org Received: from lists.gnu.org (lists.gnu.org [IPv6:2001:4830:134:3::11]) (using TLSv1 with cipher AES256-SHA (256/256 bits)) (Client did not present a certificate) by ozlabs.org (Postfix) with ESMTPS id 31E382C0040 for ; Tue, 6 Aug 2013 04:45:47 +1000 (EST) Received: from localhost ([::1]:46957 helo=lists.gnu.org) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1V6Pmo-00027d-Dq for incoming@patchwork.ozlabs.org; Mon, 05 Aug 2013 14:45:42 -0400 Received: from eggs.gnu.org ([2001:4830:134:3::10]:49953) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1V6Pm4-0001hp-Sq for qemu-devel@nongnu.org; Mon, 05 Aug 2013 14:45:02 -0400 Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1V6Plw-0007LJ-Pn for qemu-devel@nongnu.org; Mon, 05 Aug 2013 14:44:56 -0400 Received: from mail6.webfaction.com ([74.55.86.74]:42551 helo=smtp.webfaction.com) by eggs.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1V6Plw-0007Kk-Kv for qemu-devel@nongnu.org; Mon, 05 Aug 2013 14:44:48 -0400 Received: from rhodium.sg.lan. (maths.r-prg.net.univ-paris7.fr [81.194.27.158]) by smtp.webfaction.com (Postfix) with ESMTP id 0CF9D212AA45; Mon, 5 Aug 2013 18:44:46 +0000 (UTC) From: Charlie Shepherd To: qemu-devel@nongnu.org Date: Mon, 5 Aug 2013 20:44:03 +0200 Message-Id: <1375728247-1306-2-git-send-email-charlie@ctshepherd.com> X-Mailer: git-send-email 1.8.3.2 In-Reply-To: <1375728247-1306-1-git-send-email-charlie@ctshepherd.com> References: <1375728247-1306-1-git-send-email-charlie@ctshepherd.com> X-detected-operating-system: by eggs.gnu.org: GNU/Linux 2.6.x X-Received-From: 74.55.86.74 Cc: kwolf@redhat.com, pbonzini@redhat.com, Charlie Shepherd , gabriel@kerneis.info, stefanha@gmail.com Subject: [Qemu-devel] [PATCH 1/5] Add an explanation of when a function should be marked coroutine_fn X-BeenThere: qemu-devel@nongnu.org X-Mailman-Version: 2.1.14 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: qemu-devel-bounces+incoming=patchwork.ozlabs.org@nongnu.org Sender: qemu-devel-bounces+incoming=patchwork.ozlabs.org@nongnu.org From: Charlie Shepherd Coroutine functions that can yield directly or indirectly should be annotated with a coroutine_fn annotation. Add an explanation to that effect in include/block/coroutine.h. --- include/block/coroutine.h | 3 +++ 1 file changed, 3 insertions(+) diff --git a/include/block/coroutine.h b/include/block/coroutine.h index 377805a..3b94b6d 100644 --- a/include/block/coroutine.h +++ b/include/block/coroutine.h @@ -37,6 +37,9 @@ * static checker support for catching such errors. This annotation might make * it possible and in the meantime it serves as documentation. * + * A function must be marked with coroutine_fn if it can yield execution, either + * directly or indirectly. + * * For example: * * static void coroutine_fn foo(void) {