From nobody Sat Feb 25 13:11:53 2023 X-Original-To: dev-commits-src-main@mlmmj.nyi.freebsd.org Received: from mx1.freebsd.org (mx1.freebsd.org [IPv6:2610:1c1:1:606c::19:1]) by mlmmj.nyi.freebsd.org (Postfix) with ESMTP id 4PP6bs4dxgz3t91D; Sat, 25 Feb 2023 13:11:53 +0000 (UTC) (envelope-from git@FreeBSD.org) Received: from mxrelay.nyi.freebsd.org (mxrelay.nyi.freebsd.org [IPv6:2610:1c1:1:606c::19:3]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (4096 bits) server-digest SHA256 client-signature RSA-PSS (4096 bits) client-digest SHA256) (Client CN "mxrelay.nyi.freebsd.org", Issuer "R3" (verified OK)) by mx1.freebsd.org (Postfix) with ESMTPS id 4PP6bs2rBDz4V8W; Sat, 25 Feb 2023 13:11:53 +0000 (UTC) (envelope-from git@FreeBSD.org) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=freebsd.org; s=dkim; t=1677330713; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:mime-version:mime-version:content-type:content-type: content-transfer-encoding:content-transfer-encoding; bh=JhWog2heIk9SNtXdjlUV6bK0SgEu8/UMDxIW9zEUOJ8=; b=XYjmG8EEGOnNPaHGpNYDO1Q7zBym4XQCyBzOOK4VHKX4x3wRpEMBdBW+tcKgiOzIA2j0Tg HH8WiRpQ42TxM5kEGUEaW3DN4B4w6lcVngSgXbOd6y/z3SzvYoHiOz1qs+9LXqMHuZ/VVO Sd2IIrTO1wg11+WCJJ5C9qk2FELLd/Ce5OeEgTNvuqejP/l8JrLW0f9B1eoaCU39xtP7HR uFxnJe0j7gQikFDJ8A/vna046la8aeDLITr0TPOeNjkZ/YKL4elvJmTYU7QgroAbL2zmtC +cuFxmhKdhIllKuy4y98DnLxDGriBulSNe1U6JPdSzQ6Cl5/zqXM6+tLP5wo6Q== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=freebsd.org; s=dkim; t=1677330713; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:mime-version:mime-version:content-type:content-type: content-transfer-encoding:content-transfer-encoding; bh=JhWog2heIk9SNtXdjlUV6bK0SgEu8/UMDxIW9zEUOJ8=; b=Alr4tULvWYWChP+VY78CrQm6ZbAlH6ntR6SvFPDAtsw8aRt2auajoHzyFfVqL9BLzTsVNq qUOCDzoEE9WmZzau5Wy6zZqC7psuoYhBZqTY59no2puwpqy9mQmngbCPw2Zmi6sAGI3at/ p/cfoVVJXO7054EvLweoY9iagR8ZQGQkp8H4qidzcQddFSub95xN1pYJ+S8nqYYlSJ3TIy ldtLqlrSA1rOtMHI6Kqf+lUNMHcTpfx2Cst4Q8S6ugrYeiPp9+1nud6St8jqvcdlT5UPmm oaUHbqqIe7nuxdBBEsnCuc4NmOXs4krlRMDDLFZ+WgbQ2FjUSzn/75RGXotO1Q== ARC-Authentication-Results: i=1; mx1.freebsd.org; none ARC-Seal: i=1; s=dkim; d=freebsd.org; t=1677330713; a=rsa-sha256; cv=none; b=W8zZxPP4XcguV++ryvmzgmUXQFh9XONHG4aWFZFuxnO+fjeJdksWlmZr5gYxbbldPfyKzl TLA6+w6Ao5B/5/ooImUSenQ+/dvZEByFrIj2TUKu7304dPpEcUuDDTsxTZIEjJT/eWDl3l I3RIWOWBKgJeicHky2ru/M8W1SyrWKvUleYgh0Y5LAsEvp1dx71O+iUtZtdJC1zXvHExCd RIp4FZjuBCSwJTdEuA39uxjiFXPf73FV0coGh+JxI4+W06Hledp6QAB/Bxrg8ArEZEMjNN VjDRSAgoDcrGL4zXvRdNcK+T8kNNC3GgPqm3t4ddcnpkFXJzoVULPxWrZTOZSw== Received: from gitrepo.freebsd.org (gitrepo.freebsd.org [IPv6:2610:1c1:1:6068::e6a:5]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (4096 bits) server-digest SHA256) (Client did not present a certificate) by mxrelay.nyi.freebsd.org (Postfix) with ESMTPS id 4PP6bs1vhmz1542; Sat, 25 Feb 2023 13:11:53 +0000 (UTC) (envelope-from git@FreeBSD.org) Received: from gitrepo.freebsd.org ([127.0.1.44]) by gitrepo.freebsd.org (8.16.1/8.16.1) with ESMTP id 31PDBrjk056824; Sat, 25 Feb 2023 13:11:53 GMT (envelope-from git@gitrepo.freebsd.org) Received: (from git@localhost) by gitrepo.freebsd.org (8.16.1/8.16.1/Submit) id 31PDBrR0056823; Sat, 25 Feb 2023 13:11:53 GMT (envelope-from git) Date: Sat, 25 Feb 2023 13:11:53 GMT Message-Id: <202302251311.31PDBrR0056823@gitrepo.freebsd.org> To: src-committers@FreeBSD.org, dev-commits-src-all@FreeBSD.org, dev-commits-src-main@FreeBSD.org From: Gordon Bergling Subject: git: 211ceb62e85d - main - inet6_opt_init.3: Some enhancements List-Id: Commit messages for the main branch of the src repository List-Archive: https://lists.freebsd.org/archives/dev-commits-src-main List-Help: List-Post: List-Subscribe: List-Unsubscribe: Sender: owner-dev-commits-src-main@freebsd.org X-BeenThere: dev-commits-src-main@freebsd.org MIME-Version: 1.0 Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: 8bit X-Git-Committer: gbe X-Git-Repository: src X-Git-Refname: refs/heads/main X-Git-Reftype: branch X-Git-Commit: 211ceb62e85d8d01ea89af0de8e43430de550e72 Auto-Submitted: auto-generated X-ThisMailContainsUnwantedMimeParts: N The branch main has been updated by gbe: URL: https://cgit.FreeBSD.org/src/commit/?id=211ceb62e85d8d01ea89af0de8e43430de550e72 commit 211ceb62e85d8d01ea89af0de8e43430de550e72 Author: Gordon Bergling AuthorDate: 2023-02-25 13:11:27 +0000 Commit: Gordon Bergling CommitDate: 2023-02-25 13:11:27 +0000 inet6_opt_init.3: Some enhancements - Be consistent with RFC references, so add a space after 'RFC' - Add a LIBRARY section - Use standard integer types in the SYNOPSIS section Obtained from: DragonflyBSD MFC after: 5 days Differential Revision: https://reviews.freebsd.org/D27548 --- lib/libc/net/inet6_opt_init.3 | 28 +++++++++++++++------------- 1 file changed, 15 insertions(+), 13 deletions(-) diff --git a/lib/libc/net/inet6_opt_init.3 b/lib/libc/net/inet6_opt_init.3 index 484767f781fa..0813e6ca7838 100644 --- a/lib/libc/net/inet6_opt_init.3 +++ b/lib/libc/net/inet6_opt_init.3 @@ -29,7 +29,7 @@ .\" .\" $FreeBSD$ .\" -.Dd August 1, 2021 +.Dd February 25, 2023 .Dt INET6_OPT_INIT 3 .Os .\" @@ -43,20 +43,22 @@ .Nm inet6_opt_get_val .Nd IPv6 Hop-by-Hop and Destination Options manipulation .\" +.Sh LIBRARY +.Lb libc .Sh SYNOPSIS .In netinet/in.h .Ft "int" .Fn inet6_opt_init "void *extbuf" "socklen_t extlen" .Ft "int" -.Fn inet6_opt_append "void *extbuf" "socklen_t extlen" "int offset" "u_int8_t type" "socklen_t len" "u_int8_t align" "void **databufp" +.Fn inet6_opt_append "void *extbuf" "socklen_t extlen" "int offset" "uint8_t type" "socklen_t len" "uint8_t align" "void **databufp" .Ft "int" .Fn inet6_opt_finish "void *extbuf" "socklen_t extlen" "int offset" .Ft "int" .Fn inet6_opt_set_val "void *databuf" "int offset" "void *val" "socklen_t vallen" .Ft "int" -.Fn inet6_opt_next "void *extbuf" "socklen_t extlen" "int offset" "u_int8_t *typep" "socklen_t *lenp" "void **databufp" +.Fn inet6_opt_next "void *extbuf" "socklen_t extlen" "int offset" "uint8_t *typep" "socklen_t *lenp" "void **databufp" .Ft "int" -.Fn inet6_opt_find "void *extbuf" "socklen_t extlen" "int offset" "u_int8_t type" "socklen_t *lenp" "void **databufp" +.Fn inet6_opt_find "void *extbuf" "socklen_t extlen" "int offset" "uint8_t type" "socklen_t *lenp" "void **databufp" .Ft "int" .Fn inet6_opt_get_val "void *databuf" "int offset" "void *val" "socklen_t vallen" .\" @@ -67,9 +69,9 @@ The advanced sockets API defines a set of functions to help applications create and manipulate Hop-by-Hop and Destination options. This man page describes the functions specified in -IETF Draft RFC3542. +IETF Draft RFC 3542. These functions use the -formatting rules specified in Appendix B in RFC2460, i.e., that the +formatting rules specified in Appendix B in RFC 2460, i.e., that the largest field is placed last in the option. The function prototypes for these functions are all contained in the @@ -206,7 +208,7 @@ inserted into the extension header, and the argument indicates how much data to copy. .Pp The caller should ensure that each field is aligned on its natural -boundaries as described in Appendix B of RFC2460. +boundaries as described in Appendix B of RFC 2460. .Pp The function returns the offset for the next field which is calculated as .Fa offset @@ -281,7 +283,7 @@ or functions. The .Fa val -argument points where the data will be extracted. +argument points to where the data will be extracted. The .Fa offset argument specifies from where in the data portion of the option the @@ -289,7 +291,7 @@ value should be extracted; the first byte of option data is specified by an offset of zero. .Pp It is expected that each field is aligned on its natural boundaries as -described in Appendix B of RFC2460. +described in Appendix B of RFC 2460. .Pp The function returns the offset for the next field by calculating @@ -305,7 +307,7 @@ All the functions return on an error. .\" .Sh EXAMPLES -RFC3542 gives comprehensive examples in Section 22. +RFC 3542 gives comprehensive examples in Section 22. .Pp KAME also provides examples in the .Pa advapitest @@ -318,20 +320,20 @@ directory of its kit. .%A E. Nordmark .%A T. Jinmei .%T "Advanced Sockets API for IPv6" -.%N RFC3542 +.%N RFC 3542 .%D October 2002 .Re .Rs .%A S. Deering .%A R. Hinden .%T "Internet Protocol, Version 6 (IPv6) Specification" -.%N RFC2460 +.%N RFC 2460 .%D December 1998 .Re .Sh STANDARDS The functions are documented in .Dq Advanced Sockets API for IPv6 -.Pq RFC3542 . +.Pq RFC 3542 . .\" .Sh HISTORY The implementation first appeared in KAME advanced networking kit.