git: b83d5bf050a9 - stable/13 - libpathconv: Fix mandoc warnings in abs2rel(3) and rel2abs(3)
- Go to: [ bottom of page ] [ top of archives ] [ this month ]
Date: Wed, 10 Aug 2022 12:23:08 UTC
The branch stable/13 has been updated by gbe (doc committer):
URL: https://cgit.FreeBSD.org/src/commit/?id=b83d5bf050a9c735c9f6079672d5af3dec24b7dd
commit b83d5bf050a9c735c9f6079672d5af3dec24b7dd
Author: Gordon Bergling <gbe@FreeBSD.org>
AuthorDate: 2022-08-07 12:53:53 +0000
Commit: Gordon Bergling <gbe@FreeBSD.org>
CommitDate: 2022-08-10 12:22:26 +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 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)