From nobody Wed Aug 10 12:27:25 2022 X-Original-To: dev-commits-src-all@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 4M2q2Q39Trz4YJQW; Wed, 10 Aug 2022 12:27:26 +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 4M2q2P5l9Wz3bTq; Wed, 10 Aug 2022 12:27:25 +0000 (UTC) (envelope-from git@FreeBSD.org) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=freebsd.org; s=dkim; t=1660134445; 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=dfOEiMBW/duaqL5cIjHdsqUwLQYzelNRLwSwAWawjbQ=; b=De9P7cjOWP4ueGWY0ggfD1NBz9H18OTpiRNef/E6rt1vTf9XsHnL8AE4S3N3ZRilApT2ja Hw8HVwhA8xwyrqxN4sdPie7qM15UsT/3WyBm9g7oTEWseVO7y6BvqH8gysFovcqNgL2+h7 x9Fy0sJhwv7qJv8MlOOeysnHgbVgqq0XGQUnR9JbeeAjniVlNP3GBmfS53ha9+7E/OciPN lc/YZQHuMhPmhf1l1Kg01BW/qSKF7d5WcLn9927N/06m5AWbcNmXElsq/tpeRvZ6KagfQD pcIIWBLj/d8JpG1ibtwj0uaic0FTLts0LlXzWNBEsyhaWKt6HO4uaw0X2qlQnQ== 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 4M2q2P4j4xz19wp; Wed, 10 Aug 2022 12:27:25 +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 27ACRPOf073084; Wed, 10 Aug 2022 12:27:25 GMT (envelope-from git@gitrepo.freebsd.org) Received: (from git@localhost) by gitrepo.freebsd.org (8.16.1/8.16.1/Submit) id 27ACRPDt073083; Wed, 10 Aug 2022 12:27:25 GMT (envelope-from git) Date: Wed, 10 Aug 2022 12:27:25 GMT Message-Id: <202208101227.27ACRPDt073083@gitrepo.freebsd.org> To: src-committers@FreeBSD.org, dev-commits-src-all@FreeBSD.org, dev-commits-src-branches@FreeBSD.org From: Gordon Bergling Subject: git: 6855794be20e - stable/12 - libpathconv: Fix mandoc warnings in abs2rel(3) and rel2abs(3) List-Id: Commit messages for all branches of the src repository List-Archive: https://lists.freebsd.org/archives/dev-commits-src-all List-Help: List-Post: List-Subscribe: List-Unsubscribe: Sender: owner-dev-commits-src-all@freebsd.org X-BeenThere: dev-commits-src-all@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/stable/12 X-Git-Reftype: branch X-Git-Commit: 6855794be20e17192a1c86ba92626a563a51baef Auto-Submitted: auto-generated ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=freebsd.org; s=dkim; t=1660134445; 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=dfOEiMBW/duaqL5cIjHdsqUwLQYzelNRLwSwAWawjbQ=; b=i1c+5TbPtI+QltRRkyWYYeFDWhrivoWuhvS1FAAgaR92AuYH8OdVOmlXgwNrfOGSmSMR8E fsr2Xmvz3ZcUdR+iytCxiPrNPuagfy4WtJ0nEvvtbeCHfY3j1F4noCj8/oTXAqFJa0+3rM 10cmEpja4fBV7iDs4eGMfzkLbLPDm7Gj0LiEHT2Dm0L5smaRKNicJwZbCHZ9owDc8DRItm mKnr7d0PXJmffSpnzrRcsGRjs5v78WJ4nx3K5GX4eyUUcqnbiLkY5lK4XOu3XR1Ry60DrT sP2ooc3s1Pezi7UtX2IISTBpgxmUQWouHnhrflkFz4SwSmNV0EObZQ9+xgYt/g== ARC-Seal: i=1; s=dkim; d=freebsd.org; t=1660134445; a=rsa-sha256; cv=none; b=fW0Bwi/Nr1uFifaIiDnkLw6kwCybKcULH9L61c6FUb3icksT5VGJc9wQ5cRT4KtIidrav0 /1rVRgiDfAbEf5XdwHBqBqb5RfbXEkLhleSmWxC3o6hmzOJgoz9vZ9PxM+jjSdp8uS4xoR UdQtMhBjMw0qiXOed883wJ122KAfwIlPPAwwV87sAT5Q+Z/8EPRTllADpVq+ftFFys3CxJ tmEkKp59cTrz5CxsirnIinbA+7bnYzpa/uIaVukn3K5jQMIFUyudDQ2kP9D/STNd4X2TCM 0okNn2q2RQG6sYuizJcmmJktAp79c+gkx19fP1fpVh3/eHt7jL+nENI9vdPv9g== ARC-Authentication-Results: i=1; mx1.freebsd.org; none X-ThisMailContainsUnwantedMimeParts: N The branch stable/12 has been updated by gbe (doc committer): URL: https://cgit.FreeBSD.org/src/commit/?id=6855794be20e17192a1c86ba92626a563a51baef commit 6855794be20e17192a1c86ba92626a563a51baef Author: Gordon Bergling AuthorDate: 2022-08-07 12:53:53 +0000 Commit: Gordon Bergling CommitDate: 2022-08-10 12:27:00 +0000 libpathconv: Fix mandoc warnings in abs2rel(3) and rel2abs(3) - cannot parse date, using it verbatim: Dec 15, 1997" - sections out of conventional order: Sh SEE ALSO - possible typo in section name: Sh EXAMPLE instead of EXAMPLES - AUTHORS section without An macro (cherry picked from commit 094517119c62c23369d545a7475ae982d86330a3) --- lib/libpathconv/abs2rel.3 | 44 ++++++++++++++++++++++---------------------- lib/libpathconv/rel2abs.3 | 40 ++++++++++++++++++++-------------------- 2 files changed, 42 insertions(+), 42 deletions(-) diff --git a/lib/libpathconv/abs2rel.3 b/lib/libpathconv/abs2rel.3 index 4d46d8a79b26..33ad58d60880 100644 --- a/lib/libpathconv/abs2rel.3 +++ b/lib/libpathconv/abs2rel.3 @@ -25,7 +25,7 @@ .\" .\" $FreeBSD$ .\" -.Dd Dec 15, 1997" +.Dd December 15, 1997 .Dt ABS2REL 3 .Os .Sh NAME @@ -60,6 +60,23 @@ function returns relative path name on success. If an error occurs, it returns .Dv NULL . +.Sh EXAMPLES + char result[MAXPATHLEN]; + char *path = abs2rel("/usr/src/sys", "/usr/local/lib", result, MAXPATHLEN); + +yields: + + path == "../../src/sys" + +Similarly, + + path1 = abs2rel("/usr/src/sys", "/usr", result, MAXPATHLEN); + path2 = abs2rel("/usr/src/sys", "/usr/src/sys", result, MAXPATHLEN); + +yields: + + path1 == "src/sys" + path2 == "." .Sh ERRORS The .Fn abs2rel @@ -77,24 +94,11 @@ argument is zero. The .Fa size argument is greater than zero but smaller than the length of the pathname plus 1. -.Sh EXAMPLE - char result[MAXPATHLEN]; - char *path = abs2rel("/usr/src/sys", "/usr/local/lib", result, MAXPATHLEN); - -yields: - - path == "../../src/sys" - -Similarly, - - path1 = abs2rel("/usr/src/sys", "/usr", result, MAXPATHLEN); - path2 = abs2rel("/usr/src/sys", "/usr/src/sys", result, MAXPATHLEN); - -yields: - - path1 == "src/sys" - path2 == "." +.Sh SEE ALSO +.Xr rel2abs 3 +.Sh AUTHORS +.An Shigio Yamaguchi (shigio@tamacom.com) .Sh BUGS If the .Fa base @@ -130,7 +134,3 @@ The function assures correct result, but don't forget that .Fn realpath requires that all but the last component of the path exist. -.Sh "SEE ALSO" -.Xr rel2abs 3 -.Sh AUTHORS -Shigio Yamaguchi (shigio@tamacom.com) diff --git a/lib/libpathconv/rel2abs.3 b/lib/libpathconv/rel2abs.3 index aee8039cf914..8bc880707d7b 100644 --- a/lib/libpathconv/rel2abs.3 +++ b/lib/libpathconv/rel2abs.3 @@ -25,7 +25,7 @@ .\" .\" $FreeBSD$ .\" -.Dd Dec 3, 1997" +.Dd December 3, 1997 .Dt REL2ABS 3 .Os .Sh NAME @@ -58,6 +58,23 @@ The function returns absolute path name on success. If an error occurs, it returns .Dv NULL . +.Sh EXAMPLES + char result[MAXPATHLEN]; + char *path = rel2abs("../../src/sys", "/usr/local/lib", result, MAXPATHLEN); + +yields: + + path == "/usr/src/sys" + +Similarly, + + path1 = rel2abs("src/sys", "/usr", result, MAXPATHLEN); + path2 = rel2abs(".", "/usr/src/sys", result, MAXPATHLEN); + +yields: + + path1 == "/usr/src/sys" + path2 == "/usr/src/sys" .Sh ERRORS The .Fn rel2abs @@ -75,24 +92,7 @@ argument is zero. The .Fa size argument is greater than zero but smaller than the length of the pathname plus 1 -.Sh EXAMPLE - char result[MAXPATHLEN]; - char *path = rel2abs("../../src/sys", "/usr/local/lib", result, MAXPATHLEN); - -yields: - - path == "/usr/src/sys" - -Similarly, - - path1 = rel2abs("src/sys", "/usr", result, MAXPATHLEN); - path2 = rel2abs(".", "/usr/src/sys", result, MAXPATHLEN); - -yields: - - path1 == "/usr/src/sys" - path2 == "/usr/src/sys" -.Sh "SEE ALSO" +.Sh SEE ALSO .Xr abs2rel 3 .Sh AUTHORS -Shigio Yamaguchi (shigio@tamacom.com) +.An Shigio Yamaguchi (shigio@tamacom.com)