From patchwork Mon Dec 7 22:19:42 2020 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: morganamilo X-Patchwork-Id: 1831 Return-Path: Delivered-To: patchwork@archlinux.org Received: from apollo.archlinux.org (localhost [127.0.0.1]) by apollo.archlinux.org (Postfix) with ESMTP id 426CA1C9990FF for ; Mon, 7 Dec 2020 23:16:45 +0000 (UTC) X-Spam-Checker-Version: SpamAssassin 3.4.4 (2020-01-24) on apollo.archlinux.org X-Spam-Level: X-Spam-Status: No, score=-1.1 required=5.0 tests=DKIMWL_WL_HIGH=-0.001, DKIM_SIGNED=0.1,DKIM_VALID=-0.1,DKIM_VALID_AU=-0.1, MAILING_LIST_MULTI=-1,RCVD_IN_MSPIKE_H4=-0.01,RCVD_IN_MSPIKE_WL=-0.01, SPF_HELO_PASS=-0.001,T_DMARC_POLICY_NONE=0.01 autolearn=ham autolearn_force=no version=3.4.4 X-Spam-BL-Results: [127.0.0.19] Received: from mail.archlinux.org (mail.archlinux.org [95.216.189.61]) by apollo.archlinux.org (Postfix) with ESMTPS for ; Mon, 7 Dec 2020 23:16:45 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=archlinux.org; s=luna2; t=1607379734; bh=M90j5bqRAz4wCiWpqvfdM9njiwjxx+0g+KBTkNTyqp8=; h=From:To:Date:In-Reply-To:References:Subject:List-Id: List-Unsubscribe:List-Archive:List-Post:List-Help:List-Subscribe: Reply-To; b=Ho4jLAfrzTU6V8KHfELPAQUe7H8TEz9uYBXtyBcHd3qilrsHPJcXN74Cr16zQeFux Q3hmjUNfdb69wxEWss3jttOqsCIpLPySIT6QAceJo5F7XBsrhuRragS1vWy1MFGViZ 2k7toRig9JtEb6L+jb99OHUp+toCNYfgtsLH+fuYfSZSt1Y/9Oyo8q5dzLmHPOUwZD m+Sw1ju06LD/P8pLKAP4LwIWJQgJ/qqF7azJrrbmyLjnYqWZKntOvrO/5A+rGdeL0n pBbO9x8K0QOzbNQlz/96xZFAKLw/H+Lgu0Y1qLCj9sX3+oIlIv6I+ODNExH6Ut3ATw elnyfel+TvT3pwsRdLGXje4WNj0CPsW4jCKsGpuzESekH/33530HdQXjKWGrS6/0fY GXnxG2KJ2hQAvJj6m5A/0vx8oyjxl/wbv+8ILZnVSOSQ3IXJP5mucGnv23UFa9ueC5 35U6IRsFOMh4zcypPeDqW95QHvTWcJbQBS2RH7OYtraGGxiPhmC8gqVirBL3vfavpP Y4YRskE206JJSZRtpHls4kEWrlqZGlsmLS/13Sb1JI74t50ngrVNbTOIcz1LuelbQg G0U1VNYIiH48KgVZWLjb51KPbIeAdT+KfW89BPkvOoygYCuV9LwaOb6mhIuDt9KiT3 843iKMSlI7UqouRf8W/QpbfU= DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=archlinux.org; s=dkim-rsa; t=1607382989; h=from:from:sender:sender:reply-to:reply-to:subject:subject:date:date: message-id:message-id:to:to:cc:mime-version:mime-version: content-transfer-encoding:content-transfer-encoding: in-reply-to:in-reply-to:references:references:list-id:list-help: list-unsubscribe:list-subscribe:list-post; bh=p9g9mE8hRK8qSOKsljarFSvGsGSuortOwu2dGjfgoa8=; b=zrzBMpc0qBay9om2xQz06pNXdVDG6Ld9cgopfJ3fn68RsZPgavRv+IVjpysC3V2pXCIyyE TVmkZquXvUitoQ+zGnV8uQB7Y61yx7gW9bsiVWAxHw8+JHYau42wNrEMvKVpqd7lEDCRJZ sO330gS9eCrImXAcqC1p1Pk0cXLOvdwicHdwNsvln6wHqO2xzKD/onga0dHbLnuf6blCbs BzI4tJU5jZltoQ8KeRmxPEMOnEX8euZZ7NFk95nZV1xmLLnxZjcb1GFcW9JQ/6mSqiDbYR GRkMEimVt+Tp8BAScW3Nry01jXBXYBmyAA3ZkC4Q6YZ5+VAVTRXdUnDwOnYrYDbjOcEi4E hcqmQi2HZ93qOImqwbdEoPRIYKazcNuhpQ8FJi4lsOdCzkxaHJ59eOxhW0Mmu5Cnl0IvfM 6/RuwpsVA9GehYIkOzjEKqB0gVybrG/O6POQl7YivSAvbCBaxF4/3fTlLs8jv2KeyOuyhj OlKhtM0wG7RfqN77V3bEymKLFQjSo8PQPpe2okzH5L2LasVUv5eC3SyvOsZd0eCg3X1603 Ao2XSRSypyqoYdh525fq+r7a4QJU5uinnlSbtVy8N/iNkejdE4FD46Wl4yjqcQJn8wUkqq 2KKRsH42A7ba61xi6bx/a/QM/KP9n382gnQlyjmiV5/h5x+/NCY4M= DKIM-Signature: v=1; a=ed25519-sha256; c=relaxed/relaxed; d=archlinux.org; s=dkim-ed25519; t=1607382989; h=from:from:sender:sender:reply-to:reply-to:subject:subject:date:date: message-id:message-id:to:to:cc:mime-version:mime-version: content-transfer-encoding:content-transfer-encoding: in-reply-to:in-reply-to:references:references:list-id:list-help: list-unsubscribe:list-subscribe:list-post; bh=p9g9mE8hRK8qSOKsljarFSvGsGSuortOwu2dGjfgoa8=; b=KmiuM/UHrFwD6xrQz2tZar7wPUROQjLaT9HBWNPDgFEiNwTZytZ/xeiy86FZ16A4O/7R6b WF4NWwSSaO1MXyCw== From: morganamilo DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=archlinux.org; s=dkim-rsa; t=1607379730; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:cc:mime-version:mime-version: content-transfer-encoding:content-transfer-encoding: in-reply-to:in-reply-to:references:references; bh=p9g9mE8hRK8qSOKsljarFSvGsGSuortOwu2dGjfgoa8=; b=VRY1qY7lBKXlxZIJ8DYz+4Z25hfZLToXY9ZgNNysUyKvRUl2VL8hLhjlaXXSqx6nXmqxxO qSIKe+kaskjPUiDuLAfP9sPm+HxHBm6JXAFWe23Ok31jgnBsEQT7zTT24ta+P7H38NMjx4 N6RI2Eg7os+9XZfeWVetbtXEKuw6sDXDUMnYxbMPAPDRx/JOxkSmS/yeJDNhua/e5bGnAm x5QkdCM2JAK83MAwovJ15E/AbDOChrNrBpUumNk8Y8DNekuRolKmh1bTh+tUm0EbYnHV7c 00svOuhQVhSMFIA4SC2V5Ped3VH/QYmmcNZN3xCeC/dOeI4F7ObDI5WqczG8lh1WwfA7At EJABR6n6ea5yWF6/JBl2s/FJvl1bswFjnIHi0yZZxD83dS8PSBmN0+W8HepxefpDPYRIVG e2JezKkYjbdJ377ROBoOgQi+T2hVuQXGHjEGD9VVwi3V/rY2iKb1Rz/D6Zvd+HiOLtr+Aq nqdwu1U7peC/FCR+UxzMGLBOjhHJG9hItPWwtkXb4fn12kl0vdsa4ZhkSOkmfkHgERCM7U /VMGaXYPVw/jgGNbHpqeLFQfyqX2LWf8gaPv/mcf035LdA9dbwvDekd7/eSAPp+MNp85uD /2QogzeUikjhIsVhpVJCBtRJxXcA+zmcM1axW6Gt0OxHvDvAg6Tr0= DKIM-Signature: v=1; a=ed25519-sha256; c=relaxed/relaxed; d=archlinux.org; s=dkim-ed25519; t=1607379730; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:cc:mime-version:mime-version: content-transfer-encoding:content-transfer-encoding: in-reply-to:in-reply-to:references:references; bh=p9g9mE8hRK8qSOKsljarFSvGsGSuortOwu2dGjfgoa8=; b=6MIVPc+asjBUefkWeDYlG7UpuUt4CAs1x5qgx7G4iiXL+ntYcB1W6h1nnkCgHzTTWRQ70+ D++tNy/lGNyPIhCg== To: pacman-dev@archlinux.org Date: Mon, 7 Dec 2020 22:19:42 +0000 Message-Id: <20201207221956.667322-10-morganamilo@archlinux.org> X-Mailer: git-send-email 2.29.2 In-Reply-To: <20201207221956.667322-1-morganamilo@archlinux.org> References: <20201207221956.667322-1-morganamilo@archlinux.org> MIME-Version: 1.0 Subject: [pacman-dev] [PATCH 09/23] doc: document logging X-BeenThere: pacman-dev@archlinux.org X-Mailman-Version: 2.1.34 Precedence: list List-Id: Discussion list for pacman development List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Reply-To: Discussion list for pacman development Errors-To: pacman-dev-bounces@archlinux.org Sender: "pacman-dev" Authentication-Results: mail.archlinux.org; auth=pass smtp.auth=luna smtp.mailfrom=pacman-dev-bounces@archlinux.org --- lib/libalpm/alpm.h | 25 ++++++++++++++++++++----- 1 file changed, 20 insertions(+), 5 deletions(-) diff --git a/lib/libalpm/alpm.h b/lib/libalpm/alpm.h index c71c275f..ea690abc 100644 --- a/lib/libalpm/alpm.h +++ b/lib/libalpm/alpm.h @@ -1412,13 +1412,27 @@ typedef enum _alpm_pkgvalidation_t { /** Logging Levels */ typedef enum _alpm_loglevel_t { - ALPM_LOG_ERROR = 1, - ALPM_LOG_WARNING = (1 << 1), - ALPM_LOG_DEBUG = (1 << 2), - ALPM_LOG_FUNCTION = (1 << 3) + /** Error */ + ALPM_LOG_ERROR = 1, + /** Warning */ + ALPM_LOG_WARNING = (1 << 1), + /** Debug */ + ALPM_LOG_DEBUG = (1 << 2), + /** Function */ + ALPM_LOG_FUNCTION = (1 << 3) } alpm_loglevel_t; -typedef void (*alpm_cb_log)(alpm_loglevel_t, const char *, va_list); + +/** The callback type for logging. + * + * libalpm will call this function whenever something is to be logged. + * many libalpm will produce log output. Additionally any calls to \link alpm_logaction + * \endlink will also call this callback. + * @param level the currently set loglevel + * @param fmt the printf like format string + * @param args printf like arguments + */ +typedef void (*alpm_cb_log)(alpm_loglevel_t level, const char *fmt, va_list args); /** A printf-like function for logging. * @param handle the context handle @@ -1429,6 +1443,7 @@ typedef void (*alpm_cb_log)(alpm_loglevel_t, const char *, va_list); int alpm_logaction(alpm_handle_t *handle, const char *prefix, const char *fmt, ...) __attribute__((format(printf, 3, 4))); +/* End of alpm_log */ /** @} */ /** Fetch a list of remote packages.