From mboxrd@z Thu Jan 1 00:00:00 1970 Authentication-Results: passt.top; dmarc=pass (p=quarantine dis=none) header.from=redhat.com Authentication-Results: passt.top; dkim=pass (1024-bit key; unprotected) header.d=redhat.com header.i=@redhat.com header.a=rsa-sha256 header.s=mimecast20190719 header.b=IgKlPdLb; dkim-atps=neutral Received: from us-smtp-delivery-124.mimecast.com (us-smtp-delivery-124.mimecast.com [170.10.129.124]) by passt.top (Postfix) with ESMTPS id D994A5A0284 for ; Fri, 16 May 2025 14:42:41 +0200 (CEST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1747399360; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:cc:mime-version:mime-version:content-type:content-type: content-transfer-encoding:content-transfer-encoding: in-reply-to:in-reply-to:references:references; bh=DEQ/Q1KU4dhbRKQ0upAIaMvfBkxxkBqajkV2RGX6zbc=; b=IgKlPdLbIecZ5jVZBQwACCzkvoHMcT8eARV0OGIUSO69BvpTzMuzorLpZLXiwl50s81FVn PDrFvvG5JmypV1QuzPSXNGEZYQpX2BzIvNu5f5+MNUpG+WO6NdZC1y1mfyUH+Xgucwarvv 3KjD0zcdXV4y7CG4j9svPtzudKJ819E= Received: from mx-prod-mc-08.mail-002.prod.us-west-2.aws.redhat.com (ec2-35-165-154-97.us-west-2.compute.amazonaws.com [35.165.154.97]) by relay.mimecast.com with ESMTP with STARTTLS (version=TLSv1.3, cipher=TLS_AES_256_GCM_SHA384) id us-mta-595-daIOHaCFPuCxuQALHzy4Ow-1; Fri, 16 May 2025 08:42:38 -0400 X-MC-Unique: daIOHaCFPuCxuQALHzy4Ow-1 X-Mimecast-MFC-AGG-ID: daIOHaCFPuCxuQALHzy4Ow_1747399357 Received: from mx-prod-int-06.mail-002.prod.us-west-2.aws.redhat.com (mx-prod-int-06.mail-002.prod.us-west-2.aws.redhat.com [10.30.177.93]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (2048 bits) server-digest SHA256) (No client certificate requested) by mx-prod-mc-08.mail-002.prod.us-west-2.aws.redhat.com (Postfix) with ESMTPS id 8574B180056F for ; Fri, 16 May 2025 12:42:37 +0000 (UTC) Received: from lenovo-t14s.redhat.com (unknown [10.44.33.64]) by mx-prod-int-06.mail-002.prod.us-west-2.aws.redhat.com (Postfix) with ESMTP id 61FDB1800DB9; Fri, 16 May 2025 12:42:36 +0000 (UTC) From: Laurent Vivier To: passt-dev@passt.top Subject: [PATCH 3/3] iov: Standardize function comment headers Date: Fri, 16 May 2025 14:42:28 +0200 Message-ID: <20250516124228.2383036-4-lvivier@redhat.com> In-Reply-To: <20250516124228.2383036-1-lvivier@redhat.com> References: <20250516124228.2383036-1-lvivier@redhat.com> MIME-Version: 1.0 X-Scanned-By: MIMEDefang 3.4.1 on 10.30.177.93 X-Mimecast-Spam-Score: 0 X-Mimecast-MFC-PROC-ID: z24XdDN2dn5FPk2rKgReH6ebI489PojOPeUqEFhObIk_1747399357 X-Mimecast-Originator: redhat.com Content-Transfer-Encoding: 8bit content-type: text/plain; charset="US-ASCII"; x-default=true Message-ID-Hash: 524QD3JLEZWMBPF5F4QL3BYVVKHSIOZU X-Message-ID-Hash: 524QD3JLEZWMBPF5F4QL3BYVVKHSIOZU X-MailFrom: lvivier@redhat.com X-Mailman-Rule-Misses: dmarc-mitigation; no-senders; approved; emergency; loop; banned-address; member-moderation; nonmember-moderation; administrivia; implicit-dest; max-recipients; max-size; news-moderation; no-subject; digests; suspicious-header CC: Laurent Vivier X-Mailman-Version: 3.3.8 Precedence: list List-Id: Development discussion and patches for passt Archived-At: Archived-At: List-Archive: List-Archive: List-Help: List-Owner: List-Post: List-Subscribe: List-Unsubscribe: Update function comment headers in iov.c to a consistent and standardized format. This change ensures: - Comment blocks for functions consistently start with /**. - Function names in the comment summary line include parentheses (). This improves overall comment clarity and uniformity within the file. Signed-off-by: Laurent Vivier --- iov.c | 15 ++++++++------- 1 file changed, 8 insertions(+), 7 deletions(-) diff --git a/iov.c b/iov.c index 8c63b7ea6e31..91e87a740f0a 100644 --- a/iov.c +++ b/iov.c @@ -26,7 +26,8 @@ #include "iov.h" -/* iov_skip_bytes() - Skip leading bytes of an IO vector +/** + * iov_skip_bytes() - Skip leading bytes of an IO vector * @iov: IO vector * @n: Number of entries in @iov * @skip: Number of leading bytes of @iov to skip @@ -56,8 +57,8 @@ size_t iov_skip_bytes(const struct iovec *iov, size_t n, } /** - * iov_from_buf - Copy data from a buffer to an I/O vector (struct iovec) - * efficiently. + * iov_from_buf() - Copy data from a buffer to an I/O vector (struct iovec) + * efficiently. * * @iov: Pointer to the array of struct iovec describing the * scatter/gather I/O vector. @@ -96,8 +97,8 @@ size_t iov_from_buf(const struct iovec *iov, size_t iov_cnt, } /** - * iov_to_buf - Copy data from a scatter/gather I/O vector (struct iovec) to - * a buffer efficiently. + * iov_to_buf() - Copy data from a scatter/gather I/O vector (struct iovec) to + * a buffer efficiently. * * @iov: Pointer to the array of struct iovec describing the scatter/gather * I/O vector. @@ -136,8 +137,8 @@ size_t iov_to_buf(const struct iovec *iov, size_t iov_cnt, } /** - * iov_size - Calculate the total size of a scatter/gather I/O vector - * (struct iovec). + * iov_size() - Calculate the total size of a scatter/gather I/O vector + * (struct iovec). * * @iov: Pointer to the array of struct iovec describing the * scatter/gather I/O vector. -- 2.49.0