summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorAlessandro Ghedini <ghedo@debian.org>2020-12-31 11:52:59 +0100
committerAlessandro Ghedini <ghedo@debian.org>2020-12-31 13:22:52 +0100
commit2f29920511996c38e9e5597d9a819d418377ef52 (patch)
treebce4399bd7b9b88b35eaca56d0f65daa15ba4698
parenta2acca15ba5dcd62f2b2a498e4e080e8b75421d0 (diff)
Fix formatting in some man pages
Closes: #963559 Thanks: Bjarni Ingi Gislason for the patch
-rw-r--r--debian/patches/13_fix-man-formatting.patch139
-rw-r--r--debian/patches/series1
2 files changed, 140 insertions, 0 deletions
diff --git a/debian/patches/13_fix-man-formatting.patch b/debian/patches/13_fix-man-formatting.patch
new file mode 100644
index 00000000..ce58cdea
--- /dev/null
+++ b/debian/patches/13_fix-man-formatting.patch
@@ -0,0 +1,139 @@
+From 71eabbb5680f8b84d8846a53eb90dc0e15a2c308 Mon Sep 17 00:00:00 2001
+From: Bjarni Ingi Gislason <bjarniig@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 <bjarniig@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(-)
+
+--- a/docs/libcurl/curl_getdate.3
++++ b/docs/libcurl/curl_getdate.3
+@@ -62,7 +62,6 @@
+ 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
+@@ -107,5 +106,5 @@
+ 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)"
+--- a/docs/libcurl/curl_global_init_mem.3
++++ b/docs/libcurl/curl_global_init_mem.3
+@@ -54,14 +54,15 @@
+ 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)
+--- a/docs/libcurl/curl_unescape.3
++++ b/docs/libcurl/curl_unescape.3
+@@ -46,4 +46,4 @@
+ .SH RETURN VALUE
+ A pointer to a null-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
+--- a/docs/libcurl/curl_url_cleanup.3
++++ b/docs/libcurl/curl_url_cleanup.3
+@@ -27,7 +27,7 @@
+ .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
+@@ -41,5 +41,5 @@
+ .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)"
+--- a/docs/libcurl/curl_url_dup.3
++++ b/docs/libcurl/curl_url_dup.3
+@@ -27,7 +27,7 @@
+ .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
+@@ -49,5 +49,5 @@
+ .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)"
+--- a/docs/libcurl/curl_url_set.3
++++ b/docs/libcurl/curl_url_set.3
+@@ -30,7 +30,6 @@
+ 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.
+@@ -143,5 +142,5 @@
+ .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)"
diff --git a/debian/patches/series b/debian/patches/series
index ec3e1e44..07778406 100644
--- a/debian/patches/series
+++ b/debian/patches/series
@@ -4,6 +4,7 @@
08_enable-zsh.patch
11_omit-directories-from-config.patch
12_use-python3-in-tests.patch
+13_fix-man-formatting.patch
# do not add patches below
90_gnutls.patch