From patchwork Wed Jul 5 13:31:36 2023 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Patchwork-Submitter: =?utf-8?q?Philippe_Mathieu-Daud=C3=A9?= X-Patchwork-Id: 699237 Delivered-To: patch@linaro.org Received: by 2002:adf:fcc5:0:0:0:0:0 with SMTP id f5csp2781358wrs; Wed, 5 Jul 2023 06:33:23 -0700 (PDT) X-Google-Smtp-Source: ACHHUZ4DEZ1ri8Eo37nwahTocNSmzQrpJ7jtZPno1dylclx+OegyxqTVX2kPs7h2FKe6VConKEpi X-Received: by 2002:ac8:7d4e:0:b0:403:3c39:c769 with SMTP id h14-20020ac87d4e000000b004033c39c769mr19836817qtb.31.1688564003569; Wed, 05 Jul 2023 06:33:23 -0700 (PDT) ARC-Seal: i=1; a=rsa-sha256; t=1688564003; cv=none; d=google.com; s=arc-20160816; b=a0XVd2qmePlhVu9F6xN11KdC4G0ZSizoqoQ6G7w4XvtsT0/EOxCOFOP5xz9DmB7ps8 w0NfTailP7jFoSxFs3HYLFoy1ZyE5J+eEqyiM7zom2l3aB/M6JciSFhLWToTxCEIpxg/ SnM8iK+PJ7KMgcUBTYlE4BFzukyDO220k+saemNuCM2FirOiqoovM45BTVSj1HOSEJMA 4I239rTxX78R6A/ea5sqP5N6D9p8TGgUfZI78sAyFhgtB4WtnCiJJEaT61DXvwN1DZ+l Na7Q13pbHnadNdv2Lsleld8BwxyeRysKCM/M9ifu5jv790C4c0boqT8lArHiGoDNRj/6 BEhg== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=arc-20160816; h=sender:errors-to:list-subscribe:list-help:list-post:list-archive :list-unsubscribe:list-id:precedence:content-transfer-encoding :mime-version:references:in-reply-to:message-id:date:subject:cc:to :from:dkim-signature; bh=BC1jdW44jTbjaqw2f+cHkqvuGEwANPMIK+BI/ks2IFM=; fh=QXqlxiHoBliGFMptr7ZMhDvY0ya7oCRNrlYjmpX9sZY=; b=b0SZxcXxlrAc0oHcAlKYtcmQYiM3aZX4NlFtQ1TYL09wvzqrnOW7RJufjl7KlxYWvB Z3as6gPISQv++IjL+phqFncDSfCNLH8D5TssaQH6rFzdhdC4MTLCvRRAgoeODFt/uOoF CmPQVCd25ZHs89YTjhK4GOSRaMTTLUfYfZgyivCfekdt5t+l4YkLCYeWQ6OtNcS2soXg vVZeSdUFLyUeecP4fVQNr2THMwW2ZJFMPNgUHRW2QdUA0iQc7X2ca8HlIcn2cupjsZbO dC7p8x9cAFUyaJpa+eqJQajZFji6OxK1MB68Zt+LMK6P6PRv7gBcgA9l0ACpFTJLXQxh pIZA== ARC-Authentication-Results: i=1; mx.google.com; dkim=pass header.i=@linaro.org header.s=google header.b=XDbDSozq; spf=pass (google.com: domain of qemu-devel-bounces+patch=linaro.org@nongnu.org designates 209.51.188.17 as permitted sender) smtp.mailfrom="qemu-devel-bounces+patch=linaro.org@nongnu.org"; dmarc=pass (p=NONE sp=NONE dis=NONE) header.from=linaro.org Return-Path: Received: from lists.gnu.org (lists.gnu.org. [209.51.188.17]) by mx.google.com with ESMTPS id e16-20020ac84e50000000b003f9c568b2c8si298324qtw.210.2023.07.05.06.33.23 for (version=TLS1_2 cipher=ECDHE-ECDSA-CHACHA20-POLY1305 bits=256/256); Wed, 05 Jul 2023 06:33:23 -0700 (PDT) Received-SPF: pass (google.com: domain of qemu-devel-bounces+patch=linaro.org@nongnu.org designates 209.51.188.17 as permitted sender) client-ip=209.51.188.17; Authentication-Results: mx.google.com; dkim=pass header.i=@linaro.org header.s=google header.b=XDbDSozq; spf=pass (google.com: domain of qemu-devel-bounces+patch=linaro.org@nongnu.org designates 209.51.188.17 as permitted sender) smtp.mailfrom="qemu-devel-bounces+patch=linaro.org@nongnu.org"; dmarc=pass (p=NONE sp=NONE dis=NONE) header.from=linaro.org Received: from localhost ([::1] helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1qH2cc-0006Ni-89; Wed, 05 Jul 2023 09:32:49 -0400 Received: from eggs.gnu.org ([2001:470:142:3::10]) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1qH2c2-0006Jm-MX for qemu-devel@nongnu.org; Wed, 05 Jul 2023 09:32:07 -0400 Received: from mail-ed1-x534.google.com ([2a00:1450:4864:20::534]) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1qH2c0-0001zO-Qb for qemu-devel@nongnu.org; Wed, 05 Jul 2023 09:32:06 -0400 Received: by mail-ed1-x534.google.com with SMTP id 4fb4d7f45d1cf-51dec0b6fecso6612101a12.1 for ; Wed, 05 Jul 2023 06:32:04 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=linaro.org; s=google; t=1688563923; x=1691155923; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:cc:to:from:from:to:cc:subject:date :message-id:reply-to; bh=BC1jdW44jTbjaqw2f+cHkqvuGEwANPMIK+BI/ks2IFM=; b=XDbDSozq35ZG0pXCbsCpOfO7iANG2I1G6CfJEwXUGwroSkox9wFFNPyOFGZlyR0ZN1 gwSR6q5IJz+JTmQ2+HbnA+FsJfFx//Cx7MDyGP6xqQj5pS8ePITVfiOwS4HaDpfwKMz2 qrjCJtX5x+LUmHqvD54lu8bxs6nUpC92QkmxBjeGksl1doJjDZznu3Vzzeblx66OHvKH 5xcZVJGN5LKzY4XzxMaV8KQpZU4unp00GP8BjzBvnfUcBFb+hViKs/Q8iXZ2UCqhgA2/ Ofv+d+6bfYkIhIr9u0Al34GR1epXqVgc+DLTVzoODWhDq0+huYQP16zih5ysaio9/66H pfQQ== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20221208; t=1688563923; x=1691155923; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:cc:to:from:x-gm-message-state:from:to:cc :subject:date:message-id:reply-to; bh=BC1jdW44jTbjaqw2f+cHkqvuGEwANPMIK+BI/ks2IFM=; b=kBq1pYRHww1IdAKwXSktO9Rb7JYvY4AzWJgccX5DYACDsVj5XWpg4rZiEJWgY8dRPF 9l5hT4cEsJHAaCEfrqEykaPXQnVa5srVHJGWeVwc02KFMKnI8KG2NJibDsafYSLS865s z28Ibk4bl9FgXoteuWeO7nkUteHSdL4sIza/PA0ogK5XRKoFPsA8wqepJe0YHe0QWJaW xWq4ahmnJzS+h3vcOZYm7i9A56GbaJozlc65Jj6vMD46LdUr8NvVAa20ZnJ+0OB58UDD 9JbuUCUZslYZHt9l/dKbVU0tx404q1BahSLn18pKw8w5ghImAPO0aT6xUmoqmnt54Ils 5vYw== X-Gm-Message-State: ABy/qLabCZPcxNUjO2cbYoPGG/YMzuRjkpSXY6cAHwaMqjMut1aeetJ7 qFGKgv2gWjzTmbUEzw7kuxZG5fYoSFwHgAa3flk= X-Received: by 2002:aa7:c158:0:b0:51d:9ddf:f0f6 with SMTP id r24-20020aa7c158000000b0051d9ddff0f6mr11671088edp.36.1688563923308; Wed, 05 Jul 2023 06:32:03 -0700 (PDT) Received: from m1x-phil.lan ([176.176.142.96]) by smtp.gmail.com with ESMTPSA id e11-20020a056402148b00b0051e1a4454b2sm2701296edv.67.2023.07.05.06.32.00 (version=TLS1_3 cipher=TLS_CHACHA20_POLY1305_SHA256 bits=256/256); Wed, 05 Jul 2023 06:32:03 -0700 (PDT) From: =?utf-8?q?Philippe_Mathieu-Daud=C3=A9?= To: qemu-devel@nongnu.org Cc: Gerd Hoffmann , Joel Stanley , Markus Armbruster , Alistair Francis , Laurent Vivier , "Edgar E. Iglesias" , Peter Maydell , "Dr. David Alan Gilbert" , =?utf-8?q?Marc-Andr=C3=A9_Lure?= =?utf-8?q?au?= , Paolo Bonzini , Amit Shah , qemu-riscv@nongnu.org, "Michael S. Tsirkin" , Jason Wang , qemu-arm@nongnu.org, =?utf-8?q?Daniel_P?= =?utf-8?q?=2E_Berrang=C3=A9?= , =?utf-8?q?Philippe_Mat?= =?utf-8?q?hieu-Daud=C3=A9?= Subject: [PATCH 1/4] io/channel: Explicit QIOChannel doc is based on GLib's IOChannel Date: Wed, 5 Jul 2023 15:31:36 +0200 Message-Id: <20230705133139.54419-2-philmd@linaro.org> X-Mailer: git-send-email 2.38.1 In-Reply-To: <20230705133139.54419-1-philmd@linaro.org> References: <20230705133139.54419-1-philmd@linaro.org> MIME-Version: 1.0 Received-SPF: pass client-ip=2a00:1450:4864:20::534; envelope-from=philmd@linaro.org; helo=mail-ed1-x534.google.com X-Spam_score_int: -20 X-Spam_score: -2.1 X-Spam_bar: -- X-Spam_report: (-2.1 / 5.0 requ) BAYES_00=-1.9, DKIM_SIGNED=0.1, DKIM_VALID=-0.1, DKIM_VALID_AU=-0.1, DKIM_VALID_EF=-0.1, RCVD_IN_DNSWL_NONE=-0.0001, SPF_HELO_NONE=0.001, SPF_PASS=-0.001, T_SCC_BODY_TEXT_LINE=-0.01 autolearn=ham autolearn_force=no X-Spam_action: no action X-BeenThere: qemu-devel@nongnu.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: qemu-devel-bounces+patch=linaro.org@nongnu.org Sender: qemu-devel-bounces+patch=linaro.org@nongnu.org One can get lost looking for "public API docs". Explicit we are referring to GLib IOChannel documentation. Signed-off-by: Philippe Mathieu-Daudé --- include/io/channel.h | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/include/io/channel.h b/include/io/channel.h index 229bf36910..998718b470 100644 --- a/include/io/channel.h +++ b/include/io/channel.h @@ -97,7 +97,7 @@ struct QIOChannel { * The first five callbacks are mandatory to support, others * provide additional optional features. * - * Consult the corresponding public API docs for a description + * Consult the corresponding GLib IOChannel public API docs for a description * of the semantics of each callback. io_shutdown in particular * must be thread-safe, terminate quickly and must not block. */