From nobody Sun Aug 07 12:54:05 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 4M0zmY3Cy1z4Xqv3; Sun, 7 Aug 2022 12:54:05 +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 4M0zmY2nPjz3QnL; Sun, 7 Aug 2022 12:54:05 +0000 (UTC) (envelope-from git@FreeBSD.org) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=freebsd.org; s=dkim; t=1659876845; 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=sL9gzgy1S10vqDeF2r8BGj31qx553cUdInwPxCtQ7GU=; b=R55+/Ot+RPdMN0guhEz9s0Mp5ReghUplZtLRVoKJTnP+aXmYqx6O1Ao9snpqHgA+oMjIjA ZOn1pm9StxJxEQm761j38E2r23me9mhe3OV8yMo8T1vI1Q9f4gmh+/cfH7DM3chUyqX9b7 adENbaQBdhcTYWApMhzrWC/UPGwrAFXe2O5oYJjHXN7570jw7TfOU5ZxR/W+zNsiLH1TCf EEVwXWc8pRbbJIXfloW8K24LmsbhaNZBAXnNPqcC92m/K7kbB4YZvmeS/hSdAuh0KDUJCS izZ+PfH0PhyWgcnTCG+0sS+q7wbMRLWtCQ4BkTrA9O2km1Um6Tuhxh1ididD6A== 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 4M0zmY1Xw4z1CdL; Sun, 7 Aug 2022 12:54:05 +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 277Cs5Vh037277; Sun, 7 Aug 2022 12:54:05 GMT (envelope-from git@gitrepo.freebsd.org) Received: (from git@localhost) by gitrepo.freebsd.org (8.16.1/8.16.1/Submit) id 277Cs52a037276; Sun, 7 Aug 2022 12:54:05 GMT (envelope-from git) Date: Sun, 7 Aug 2022 12:54:05 GMT Message-Id: <202208071254.277Cs52a037276@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: 094517119c62 - main - 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/main X-Git-Reftype: branch X-Git-Commit: 094517119c62c23369d545a7475ae982d86330a3 Auto-Submitted: auto-generated ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=freebsd.org; s=dkim; t=1659876845; 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=sL9gzgy1S10vqDeF2r8BGj31qx553cUdInwPxCtQ7GU=; b=dDpJynTWD9O3I1PdCc6FGZSXiQ9Tu4vgkYWZ0P0dz5nnHH7ecLAN47l4QY9oVfqjOzKq35 liEqZDz0fdIDtqtnkvMXp676UtE3wzGUTF4vueqqG+dXP763c/2kNrajTIBJzJrLazsbyt vcs8OJrrefT/5JDJzqU+GxRelsqEMxYp2WfmMN1kEa2ZKgxSJmjjFyU1LwKqaXxGuql97L lJiGYVQm7IisGHAjmNfk4zy1mzk3XzXYhRYvnsfegUAEL50SXXhzVri+2QXn5o4EQqoexa yiJmZrOs+c7pcC8BU2ltByIlG64pe6t50CgTchn5yfVWZ2XU9V2uE1wX1zdbDQ== ARC-Seal: i=1; s=dkim; d=freebsd.org; t=1659876845; a=rsa-sha256; cv=none; b=hwlnuEry6TsHHHNYUq6VcooeAtPnqkhRNykidQK8JZInh35NaNQArwkIly4cTvth4PgSrb kN3arvuOqBwLYeOfVzuiOxfROn6rs8ocjB2lYdBtRadDk7HIaqa4TYA7c06/XCx7GNrNQF mupctqfuwAvfuMxmMh8/oOYE6VTsltackPSKQoSxN+gjOhSqYkUFiQANpFfprlEnDSGRSl UO4jUqWcpxPAwssMAgoPKx1FO2LPkJnt9MiN8lV90uW4X05wO/xy6W+6HMwd93o0eIzJLY HIk1MGeSzYs+IP9sipCuVnCYWozVsANpcS8VoHel8BhUQX4bCAx24Cd21v08jw== ARC-Authentication-Results: i=1; mx1.freebsd.org; none X-ThisMailContainsUnwantedMimeParts: N The branch main has been updated by gbe (doc committer): URL: https://cgit.FreeBSD.org/src/commit/?id=094517119c62c23369d545a7475ae982d86330a3 commit 094517119c62c23369d545a7475ae982d86330a3 Author: Gordon Bergling AuthorDate: 2022-08-07 12:53:53 +0000 Commit: Gordon Bergling CommitDate: 2022-08-07 12:53:53 +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 MFC after: 3 days --- 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 984b2530e1b0..fd684aa072d9 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)