From patchwork Tue Jun 10 14:30:56 2014 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Thomas Wood X-Patchwork-Id: 4329241 Return-Path: X-Original-To: patchwork-intel-gfx@patchwork.kernel.org Delivered-To: patchwork-parsemail@patchwork1.web.kernel.org Received: from mail.kernel.org (mail.kernel.org [198.145.19.201]) by patchwork1.web.kernel.org (Postfix) with ESMTP id DA7839F3B4 for ; Tue, 10 Jun 2014 14:31:15 +0000 (UTC) Received: from mail.kernel.org (localhost [127.0.0.1]) by mail.kernel.org (Postfix) with ESMTP id 6221F202AE for ; Tue, 10 Jun 2014 14:31:13 +0000 (UTC) Received: from gabe.freedesktop.org (gabe.freedesktop.org [131.252.210.177]) by mail.kernel.org (Postfix) with ESMTP id 59164202E5 for ; Tue, 10 Jun 2014 14:31:10 +0000 (UTC) Received: from gabe.freedesktop.org (localhost [127.0.0.1]) by gabe.freedesktop.org (Postfix) with ESMTP id F0F726E6BC; Tue, 10 Jun 2014 07:31:09 -0700 (PDT) X-Original-To: intel-gfx@lists.freedesktop.org Delivered-To: intel-gfx@lists.freedesktop.org Received: from mail-wi0-f170.google.com (mail-wi0-f170.google.com [209.85.212.170]) by gabe.freedesktop.org (Postfix) with ESMTP id 21BCD6E6BC for ; Tue, 10 Jun 2014 07:31:07 -0700 (PDT) Received: by mail-wi0-f170.google.com with SMTP id cc10so1764754wib.1 for ; Tue, 10 Jun 2014 07:31:07 -0700 (PDT) X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20130820; h=x-gm-message-state:from:to:subject:date:message-id:in-reply-to :references; bh=EdT2bbS7rAPMLBpzkb9DBVldUWT1ddcA/Zw4aHdTCgw=; b=DK9LrGpFbMfS491OUCbxLhKQabBbhk4ezTursUAZopA+xfMWwDBKeeapufxLEnweAz GveYlAd9xJpfcTw42VzGsOr35mKU1j07tHkyytVl8Wtb7wI8RJ7HtARv1G3SrjxB0wyV hedyiJBpH8oys73SnsiQoqwiU7RlSaG6/MPzVuse1dQK1mmRoTCVPTR7P0NTpOOVingE pOwttnEXxq7xd6bOEdrylxdXoxjpds7i5Q48FEdOtk4bqbc4rPdnkGwqabb45nhkF5Z7 5S2HeCcz2eIZ3cl5hHZlHzf6X93D2BUPI6wyLFksDnmyemoWzEtETrHpJzyMhYOVgaaz Kzzg== X-Gm-Message-State: ALoCoQl1LfGUD05++QzKzbZt5Mc8Zq+E4aUCxLJ62Kh6gAWvwpgTeRifHiW1O/XceS1x9oQomwMJ X-Received: by 10.180.13.113 with SMTP id g17mr39081911wic.48.1402410666317; Tue, 10 Jun 2014 07:31:06 -0700 (PDT) Received: from pistachio.icx.intel.com ([83.217.123.106]) by mx.google.com with ESMTPSA id ci16sm379523wjb.5.2014.06.10.07.31.05 for (version=TLSv1.2 cipher=ECDHE-RSA-AES128-GCM-SHA256 bits=128/128); Tue, 10 Jun 2014 07:31:05 -0700 (PDT) From: Thomas Wood To: intel-gfx@lists.freedesktop.org Date: Tue, 10 Jun 2014 15:30:56 +0100 Message-Id: <1402410657-4768-6-git-send-email-thomas.wood@intel.com> X-Mailer: git-send-email 1.9.3 In-Reply-To: <1402410657-4768-1-git-send-email-thomas.wood@intel.com> References: <1402410657-4768-1-git-send-email-thomas.wood@intel.com> Subject: [Intel-gfx] [i-g-t 6/7] lib: various documentation fixes X-BeenThere: intel-gfx@lists.freedesktop.org X-Mailman-Version: 2.1.15 Precedence: list List-Id: Intel graphics driver community testing & development List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , MIME-Version: 1.0 Errors-To: intel-gfx-bounces@lists.freedesktop.org Sender: "Intel-gfx" X-Spam-Status: No, score=-4.8 required=5.0 tests=BAYES_00, RCVD_IN_DNSWL_MED, RP_MATCHES_RCVD, UNPARSEABLE_RELAY autolearn=unavailable version=3.3.1 X-Spam-Checker-Version: SpamAssassin 3.3.1 (2010-03-16) on mail.kernel.org X-Virus-Scanned: ClamAV using ClamSMTP Fix some documentation comments and mark some struct members private. Signed-off-by: Thomas Wood --- lib/igt_aux.c | 5 ++--- lib/igt_core.c | 10 +++++----- lib/igt_kms.h | 2 ++ lib/intel_batchbuffer.h | 5 +---- 4 files changed, 10 insertions(+), 12 deletions(-) diff --git a/lib/igt_aux.c b/lib/igt_aux.c index c0088d5..7b277be 100644 --- a/lib/igt_aux.c +++ b/lib/igt_aux.c @@ -430,10 +430,9 @@ bool igt_setup_runtime_pm(void) } /** - * igt_runtime_pm_status: + * igt_get_runtime_pm_status: * - * Returns: - * The current runtime PM status. + * Returns: The current runtime PM status. */ enum igt_runtime_pm_status igt_get_runtime_pm_status(void) { diff --git a/lib/igt_core.c b/lib/igt_core.c index 56eacf2..7ac7ebe 100644 --- a/lib/igt_core.c +++ b/lib/igt_core.c @@ -1031,11 +1031,11 @@ static void fatal_sig_handler(int sig) * @fn: exit handler function * * Set a handler that will be called either when the process calls exit() or - * returns from the main function, or one of the signals in 'handled_signals' - * is raised. MAX_EXIT_HANDLERS handlers can be installed, each of which will - * be called only once, even if a subsequent signal is raised. If the exit - * handlers are called due to a signal, the signal will be re-raised with the - * original signal disposition after all handlers returned. + * returns from the main function, or one of the signals in + * 'handled_signals' is raised. MAX_EXIT_HANDLERS handlers can be installed, + * each of which will be called only once, even if a subsequent signal is + * raised. If the exit handlers are called due to a signal, the signal will be + * re-raised with the original signal disposition after all handlers returned. * * The handler will be passed the signal number if called due to a signal, or * 0 otherwise. Exit handlers can also be used from test children spawned with diff --git a/lib/igt_kms.h b/lib/igt_kms.h index 8e80d4b..17bf0a2 100644 --- a/lib/igt_kms.h +++ b/lib/igt_kms.h @@ -99,6 +99,7 @@ typedef struct igt_pipe igt_pipe_t; typedef uint32_t igt_fixed_t; /* 16.16 fixed point */ typedef struct { + /*< private >*/ igt_pipe_t *pipe; int index; unsigned int is_primary : 1; @@ -127,6 +128,7 @@ struct igt_pipe { }; typedef struct { + /*< private >*/ igt_display_t *display; uint32_t id; /* KMS id */ struct kmstest_connector_config config; diff --git a/lib/intel_batchbuffer.h b/lib/intel_batchbuffer.h index 49dbcf0..3715161 100644 --- a/lib/intel_batchbuffer.h +++ b/lib/intel_batchbuffer.h @@ -204,14 +204,10 @@ void intel_copy_bo(struct intel_batchbuffer *batch, * @tiling: tiling mode bits * @data: pointer to the memory mapping of the buffer * @size: size of the buffer object - * @num_tiles: number of tiles of the buffer object * * This is a i-g-t buffer object wrapper structure which augments the baseline * libdrm buffer object with suitable data needed by the render copy and the * media fill functions. - * - * Note that @num_tiles is only used by gem_stress.c internally and can be - * ignored. */ struct igt_buf { drm_intel_bo *bo; @@ -219,6 +215,7 @@ struct igt_buf { uint32_t tiling; uint32_t *data; uint32_t size; + /*< private >*/ unsigned num_tiles; };