Package: libcurl4-doc
Version: 7.68.0-1
Severity: minor
Tags: patch
Dear Maintainer,
* What led up to the situation?
Checking some issues in man pages
* What exactly did you do (or not do) that was effective (or
ineffective)?
Using "mandoc -Tlint" and "test-groff" to check formatting issues.
* What was the outcome of this action?
mandoc: curl_getdate.3:64:2: WARNING: skipping paragraph macro: PP empty
mandoc: curl_global_init_mem.3:56:2: ERROR: skipping end of block that is not
open: RE
mandoc: curl_unescape.3:48:5: ERROR: skipping all arguments: br
curl_easy_escape "(3)," curl_easy_unescape "(3)," curl_free "(3)," RFC 2396
mandoc: curl_unescape.3:48:2: WARNING: skipping paragraph macro: br after SH
mandoc: curl_url_cleanup.3:29:2: STYLE: fill mode already enabled, skipping: fi
mandoc: curl_url_dup.3:29:2: STYLE: fill mode already enabled, skipping: fi
mandoc: curl_url_set.3:32:2: STYLE: fill mode already enabled, skipping: fi
troff: <curl_getdate.3>:108: warning: trailing space
troff: <curl_getdate.3>:109: warning: trailing space
Patch:
>From 71eabbb5680f8b84d8846a53eb90dc0e15a2c308 Mon Sep 17 00:00:00 2001
From: Bjarni Ingi Gislason <bjarn...@rhi.hi.is>
Subject: [PATCH] curl/docs/libcurl/*: fix some formatting of man pages
To:
Fix some fomatting issues in man pages.
Details:
From "mandoc -Tlint":
mandoc: curl_getdate.3:64:2: WARNING: skipping paragraph macro: PP empty
mandoc: curl_global_init_mem.3:56:2: ERROR: skipping end of block that is not
open: RE
mandoc: curl_unescape.3:48:5: ERROR: skipping all arguments: br
curl_easy_escape "(3)," curl_easy_unescape "(3)," curl_free "(3)," RFC 2396
mandoc: curl_unescape.3:48:2: WARNING: skipping paragraph macro: br after SH
mandoc: curl_url_cleanup.3:29:2: STYLE: fill mode already enabled, skipping: fi
mandoc: curl_url_dup.3:29:2: STYLE: fill mode already enabled, skipping: fi
mandoc: curl_url_set.3:32:2: STYLE: fill mode already enabled, skipping: fi
From "test-groff -b -mandoc -T utf8 -rF0 -t -w w -z":
[ "test-groff" is a developmental version of "groff" ]
troff: <curl_getdate.3>:108: warning: trailing space
troff: <curl_getdate.3>:109: warning: trailing space
Signed-off-by: Bjarni Ingi Gislason <bjarn...@rhi.hi.is>
---
docs/libcurl/curl_getdate.3 | 5 ++---
docs/libcurl/curl_global_init_mem.3 | 7 ++++---
docs/libcurl/curl_unescape.3 | 2 +-
docs/libcurl/curl_url_cleanup.3 | 6 +++---
docs/libcurl/curl_url_dup.3 | 6 +++---
docs/libcurl/curl_url_set.3 | 5 ++---
6 files changed, 15 insertions(+), 16 deletions(-)
diff --git a/docs/libcurl/curl_getdate.3 b/docs/libcurl/curl_getdate.3
index 71479d20e..943c4ac4d 100644
--- a/docs/libcurl/curl_getdate.3
+++ b/docs/libcurl/curl_getdate.3
@@ -61,7 +61,6 @@ first three letters. This is usually not info that adds
anything.
If a decimal number of the form YYYYMMDD appears, then YYYY is read as the
year, MM as the month number and DD as the day of the month, for the specified
calendar date.
-.PP
.SH EXAMPLES
.nf
Sun, 06 Nov 1994 08:49:37 GMT
@@ -106,5 +105,5 @@ On systems with 64 bit time_t: if the year is less than
1583, this function
will return -1. (The Gregorian calendar was first introduced 1582 so no "real"
dates in this way of doing dates existed before then.)
.SH "SEE ALSO"
-.BR curl_easy_escape "(3), " curl_easy_unescape "(3), "
-.BR CURLOPT_TIMECONDITION "(3), " CURLOPT_TIMEVALUE "(3) "
+.BR curl_easy_escape "(3), " curl_easy_unescape "(3),"
+.BR CURLOPT_TIMECONDITION "(3), " CURLOPT_TIMEVALUE "(3)"
diff --git a/docs/libcurl/curl_global_init_mem.3
b/docs/libcurl/curl_global_init_mem.3
index 79f2994ad..486871a14 100644
--- a/docs/libcurl/curl_global_init_mem.3
+++ b/docs/libcurl/curl_global_init_mem.3
@@ -53,14 +53,15 @@ To replace realloc()
To replace strdup()
.IP "void *calloc_callback(size_t nmemb, size_t size);"
To replace calloc()
-.RE
+.RS
This function is otherwise the same as \fIcurl_global_init(3)\fP, please refer
to that man page for documentation.
+.RE
.SH "CAUTION"
Manipulating these gives considerable powers to the application to severely
screw things up for libcurl. Take care!
.SH AVAILABILITY
Added in 7.12.0
.SH "SEE ALSO"
-.BR curl_global_init "(3), "
-.BR curl_global_cleanup "(3), "
+.BR curl_global_init (3),
+.BR curl_global_cleanup (3)
diff --git a/docs/libcurl/curl_unescape.3 b/docs/libcurl/curl_unescape.3
index 061fbbf5c..6673f8293 100644
--- a/docs/libcurl/curl_unescape.3
+++ b/docs/libcurl/curl_unescape.3
@@ -45,4 +45,4 @@ be removed in a future release.
.SH RETURN VALUE
A pointer to a zero terminated string or NULL if it failed.
.SH "SEE ALSO"
-.br curl_easy_escape "(3)," curl_easy_unescape "(3)," curl_free "(3)," RFC 2396
+.BR curl_easy_escape "(3), " curl_easy_unescape "(3), " curl_free "(3), " RFC
2396
diff --git a/docs/libcurl/curl_url_cleanup.3 b/docs/libcurl/curl_url_cleanup.3
index 4d095a9d7..c8662e15b 100644
--- a/docs/libcurl/curl_url_cleanup.3
+++ b/docs/libcurl/curl_url_cleanup.3
@@ -26,7 +26,7 @@ curl_url_cleanup - free a CURLU handle
.B #include <curl/curl.h>
void curl_url_cleanup(CURLU *handle);
-.fi
+.
.SH DESCRIPTION
Frees all the resources associated with the given CURLU handle!
.SH RETURN VALUE
@@ -40,5 +40,5 @@ none
.SH AVAILABILITY
Added in curl 7.62.0
.SH "SEE ALSO"
-.BR curl_url_dup "(3), " curl_url "(3), " curl_url_set "(3), "
-.BR curl_url_get "(3), "
+.BR curl_url_dup "(3), " curl_url "(3), " curl_url_set "(3),"
+.BR curl_url_get "(3)"
diff --git a/docs/libcurl/curl_url_dup.3 b/docs/libcurl/curl_url_dup.3
index c0259e0e6..cc5a3b30b 100644
--- a/docs/libcurl/curl_url_dup.3
+++ b/docs/libcurl/curl_url_dup.3
@@ -26,7 +26,7 @@ curl_url_dup - duplicate a CURLU handle
.B #include <curl/curl.h>
CURLU *curl_url_dup(CURLU *inhandle);
-.fi
+.
.SH DESCRIPTION
Duplicates a given CURLU \fIinhandle\fP and all its contents and returns a
pointer to a new CURLU handle. The new handle also needs to be freed with
@@ -48,5 +48,5 @@ Returns a new handle or NULL if out of memory.
.SH AVAILABILITY
Added in curl 7.62.0
.SH "SEE ALSO"
-.BR curl_url_cleanup "(3), " curl_url "(3), " curl_url_set "(3), "
-.BR curl_url_get "(3), "
+.BR curl_url_cleanup "(3), " curl_url "(3), " curl_url_set "(3),"
+.BR curl_url_get "(3)"
diff --git a/docs/libcurl/curl_url_set.3 b/docs/libcurl/curl_url_set.3
index a7667a35d..e9075bd2d 100644
--- a/docs/libcurl/curl_url_set.3
+++ b/docs/libcurl/curl_url_set.3
@@ -29,7 +29,6 @@ CURLUcode curl_url_set(CURLU *url,
CURLUPart part,
const char *content,
unsigned int flags)
-.fi
.SH DESCRIPTION
Given the \fIurl\fP handle of an already parsed URL, this function lets the
user set/update individual pieces of it.
@@ -138,5 +137,5 @@ If this function returns an error, no URL part is returned.
.SH AVAILABILITY
Added in curl 7.62.0. CURLUPART_ZONEID was added in 7.65.0.
.SH "SEE ALSO"
-.BR curl_url_cleanup "(3), " curl_url "(3), " curl_url_get "(3), "
-.BR curl_url_dup "(3), "
+.BR curl_url_cleanup "(3), " curl_url "(3), " curl_url_get "(3),"
+.BR curl_url_dup "(3)"
--
2.27.0
-- System Information:
Debian Release: bullseye/sid
APT prefers testing
APT policy: (500, 'testing'), (500, 'stable')
Architecture: amd64 (x86_64)
Kernel: Linux 5.6.14-1 (SMP w/2 CPU cores)
Locale: LANG=is_IS.iso88591, LC_CTYPE=is_IS.iso88591 (charmap=ISO-8859-1),
LANGUAGE=is_IS.iso88591 (charmap=ISO-8859-1)
Shell: /bin/sh linked to /bin/dash
Init: sysvinit (via /sbin/init)
-- no debconf information
