From patchwork Tue Jul 14 16:42:56 2020 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: 277872 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=-12.8 required=3.0 tests=BAYES_00,DKIM_INVALID, DKIM_SIGNED, HEADER_FROM_DIFFERENT_DOMAINS, INCLUDES_PATCH, MAILING_LIST_MULTI, SIGNED_OFF_BY,SPF_HELO_NONE,SPF_PASS,URIBL_BLOCKED,USER_AGENT_GIT autolearn=unavailable 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 49BE8C433E5 for ; Tue, 14 Jul 2020 16:49:28 +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 146E32256C for ; Tue, 14 Jul 2020 16:49:28 +0000 (UTC) Authentication-Results: mail.kernel.org; dkim=fail reason="signature verification failed" (2048-bit key) header.d=gmail.com header.i=@gmail.com header.b="QGJZEMV0" DMARC-Filter: OpenDMARC Filter v1.3.2 mail.kernel.org 146E32256C Authentication-Results: mail.kernel.org; dmarc=none (p=none dis=none) header.from=amsat.org Authentication-Results: mail.kernel.org; spf=pass smtp.mailfrom=qemu-devel-bounces+qemu-devel=archiver.kernel.org@nongnu.org Received: from localhost ([::1]:39946 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1jvO7T-0001k2-AJ for qemu-devel@archiver.kernel.org; Tue, 14 Jul 2020 12:49:27 -0400 Received: from eggs.gnu.org ([2001:470:142:3::10]:44156) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1jvO1J-00015P-KE for qemu-devel@nongnu.org; Tue, 14 Jul 2020 12:43:05 -0400 Received: from mail-wm1-x343.google.com ([2a00:1450:4864:20::343]:55634) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1jvO1H-0006oV-Um for qemu-devel@nongnu.org; Tue, 14 Jul 2020 12:43:05 -0400 Received: by mail-wm1-x343.google.com with SMTP id g75so6829999wme.5 for ; Tue, 14 Jul 2020 09:43:03 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20161025; h=sender:from:to:cc:subject:date:message-id:in-reply-to:references :mime-version:content-transfer-encoding; bh=2uqdg4rXwANaV6cVAKV4VhRMp7hv8Go60MYRFCgr3o4=; b=QGJZEMV0YV2oXUv6AOx4MA+YoAz9S/1wYuFkTAGPpUCFX6QclRLySp5SWpHgwZpXd2 xF8btEkBO1jZVUIeVZnRfxt3eqBLefWxVJNhU8glncms+0ccUmPGpUtDb1Ek7QQbFKaY UXik62yCKDryq9XU2t/gpjLWFG0BRQTT155Oq7XlMpaLJz5SFLdGQ/xZFgkRKN+4/CP3 eKdVzjvp7TiSBrSbEuf9SgTWrk8UjfyPGhHgEtf+QafFn7X49P8CpyKtwPomwnQFs5dP O0Ek3Cj12zC6+ILbqymS3U0727lVe5SfqMUIL3muczZOuXZqgzMfVOv/rw8nGGI/RwDL GFZQ== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:sender:from:to:cc:subject:date:message-id :in-reply-to:references:mime-version:content-transfer-encoding; bh=2uqdg4rXwANaV6cVAKV4VhRMp7hv8Go60MYRFCgr3o4=; b=ZBqawr1gR3aOZZoM/7MwtrPTWNlDG+/Gu36xryotz70gAbE/YeGa9b6U37r4D0lfrU JNyHQ0o9Eq+nVykoZtSxCp+HLr0vfqICZH/kXtAUAsXFrN4QyOJMXXi58mDwCy94+8Wn O4IgwZTcMVk85+TDJPBSZgHNo/CbT8GmRWZf4AETe1e3ujm/fw56iWDubIwuzuNc4nae Tlp8xsuOVoeowLxv2Ah2j5xZINuoOCov5v1jaewdbPUvN+ngg3e1zjNKaTPzWmylwe5w Ds4yeDI4glZrnp7VKBHuIkJONAIv/wkZTxUqRpccy7jlG7fmdqPb4g/AnfYCxsyZcGYt /xXQ== X-Gm-Message-State: AOAM533ltvuqO2XE2/MBBVSJVwXEDuKbS40ln2edalfXtNnGIJU3t6uZ nnW+jgBR1zJbSd/5u2cCzDzyu4fwEzo= X-Google-Smtp-Source: ABdhPJw3DS0HT+Zm8c31wbeXSUY9nKbcAYcwTpVE4nYMPjhfBuVdSk3qHKXXzqcoIl84MD97tl4TWg== X-Received: by 2002:a05:600c:2285:: with SMTP id 5mr4982825wmf.78.1594744982459; Tue, 14 Jul 2020 09:43:02 -0700 (PDT) Received: from localhost.localdomain (138.red-83-57-170.dynamicip.rima-tde.net. [83.57.170.138]) by smtp.gmail.com with ESMTPSA id 138sm6474380wmb.1.2020.07.14.09.43.01 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Tue, 14 Jul 2020 09:43:01 -0700 (PDT) From: =?utf-8?q?Philippe_Mathieu-Daud=C3=A9?= To: qemu-devel@nongnu.org Subject: [PATCH-for-5.1 3/4] qemu-common: Document qemu_find_file() Date: Tue, 14 Jul 2020 18:42:56 +0200 Message-Id: <20200714164257.23330-4-f4bug@amsat.org> X-Mailer: git-send-email 2.21.3 In-Reply-To: <20200714164257.23330-1-f4bug@amsat.org> References: <20200714164257.23330-1-f4bug@amsat.org> MIME-Version: 1.0 Received-SPF: pass client-ip=2a00:1450:4864:20::343; envelope-from=philippe.mathieu.daude@gmail.com; helo=mail-wm1-x343.google.com X-detected-operating-system: by eggs.gnu.org: No matching host in p0f cache. That's all we know. X-Spam_score_int: 0 X-Spam_score: 0.0 X-Spam_bar: / X-Spam_report: (0.0 / 5.0 requ) BAYES_00=-1.9, DKIM_SIGNED=0.1, DKIM_VALID=-0.1, DKIM_VALID_EF=-0.1, FREEMAIL_FORGED_FROMDOMAIN=1, FREEMAIL_FROM=0.001, HEADER_FROM_DIFFERENT_DOMAINS=1, RCVD_IN_DNSWL_NONE=-0.0001, SPF_HELO_NONE=0.001, SPF_PASS=-0.001 autolearn=no autolearn_force=no X-Spam_action: no action 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: Peter Maydell , Sarah Harris , Stefan Weil , =?utf-8?q?Phil?= =?utf-8?q?ippe_Mathieu-Daud=C3=A9?= , Michael Rolnik , Paolo Bonzini Errors-To: qemu-devel-bounces+qemu-devel=archiver.kernel.org@nongnu.org Sender: "Qemu-devel" Document qemu_find_file(), in particular the returned value which must be freed. Signed-off-by: Philippe Mathieu-Daudé --- include/qemu-common.h | 14 ++++++++++++++ 1 file changed, 14 insertions(+) diff --git a/include/qemu-common.h b/include/qemu-common.h index d0142f29ac..d6a08259d3 100644 --- a/include/qemu-common.h +++ b/include/qemu-common.h @@ -110,6 +110,20 @@ const char *qemu_get_vm_name(void); #define QEMU_FILE_TYPE_BIOS 0 #define QEMU_FILE_TYPE_KEYMAP 1 +/** + * qemu_find_file: + * @type: QEMU_FILE_TYPE_BIOS (for BIOS, VGA BIOS) + * or QEMU_FILE_TYPE_KEYMAP (for keymaps). + * @name: File name + * + * Search for @name file in the data directories, either configured at + * build time (DATADIR) or registered with the -L command line option. + * + * The caller must use g_free() to free the returned data when it is + * no longer required. + * + * Returns: absolute path to the file or NULL on error. + */ char *qemu_find_file(int type, const char *name); /* OS specific functions */