From: Alejandro Colomar <alx.manpages@gmail.com>
To: mtk.manpages@gmail.com
Cc: Alejandro Colomar <alx.manpages@gmail.com>,
"G . Branden Robinson" <g.branden.robinson@gmail.com>,
linux-man@vger.kernel.org
Subject: [PATCH v2] posix.py: ffix: Correctly format URIs
Date: Sun, 10 Jan 2021 15:57:46 +0100 [thread overview]
Message-ID: <20210110145745.4360-1-alx.manpages@gmail.com> (raw)
In-Reply-To: <af78792f-9758-e3e6-9c65-c2f93f0fcfdd@gmail.com>
$ man 7 uri 2>/dev/null \
|sed -n '/Writing a URI/,/^$/p';
Writing a URI
When written, URIs should be placed inside double quotes
(e.g., "http://www.kernel.org"), enclosed in angle brack‐
ets (e.g., <http://lwn.net>), or placed on a line by
themselves. A warning for those who use double-quotes:
never move extraneous punctuation (such as the period
ending a sentence or the comma in a list) inside a URI,
since this will change the value of the URI. Instead,
use angle brackets instead, or switch to a quoting system
that never includes extraneous characters inside quota‐
tion marks. This latter system, called the 'new' or
'logical' quoting system by "Hart's Rules" and the "Ox‐
ford Dictionary for Writers and Editors", is preferred
practice in Great Britain and hackers worldwide (see the
Jargon File's section on Hacker Writing Style,
⟨http://www.fwi.uva.nl/~mes/jargon/h
/HackerWritingStyle.html⟩, for more information). Older
documents suggested inserting the prefix "URL:" just be‐
fore the URI, but this form has never caught on.
Enclose URIs in .UR/.UE,
which encloses the URIs in between <> (or similar characters).
It is especially important in this case,
as the URIs are followed by '.'.
This also fixes the extraneous space that was used to
separate the URIs from the final period.
In some cases, the period ended in a line of its own.
Signed-off-by: Alejandro Colomar <alx.manpages@gmail.com>
---
posix.py | 10 ++++++----
1 file changed, 6 insertions(+), 4 deletions(-)
diff --git a/posix.py b/posix.py
index 55e401a..60271cc 100755
--- a/posix.py
+++ b/posix.py
@@ -337,14 +337,16 @@ for file in sys.argv[2:]:
"Electrical and Electronics Engineers, Inc and The Open Group.\n"
"In the event of any discrepancy between this version and the original IEEE and\n"
"The Open Group Standard, the original IEEE and The Open Group Standard\n"
- "is the referee document. The original Standard can be obtained online at\n"
- "http://www.opengroup.org/unix/online.html .\n"
+ "is the referee document. The original Standard can be obtained online at\n"
+ ".UR http://www.opengroup.org/unix/online.html\n"
+ ".UE .\n"
".PP\n"
"Any typographical or formatting errors that appear\n"
"in this page are most likely\n"
"to have been introduced during the conversion of the source files to\n"
- "man page format. To report such errors, see\n"
- "https://www.kernel.org/doc/man-pages/reporting_bugs.html .\n"
+ "man page format. To report such errors, see\n"
+ ".UR https://www.kernel.org/doc/man-pages/reporting_bugs.html\n"
+ ".UE .\n"
)
text = "".join(lines)
--
2.30.0
next prev parent reply other threads:[~2021-01-10 14:59 UTC|newest]
Thread overview: 24+ messages / expand[flat|nested] mbox.gz Atom feed top
2021-01-09 19:58 [PATCH] posix.py: ffix: Correctly format URIs Alejandro Colomar
2021-01-09 21:07 ` Alejandro Colomar (man-pages)
2021-01-10 6:50 ` G. Branden Robinson
2021-01-10 14:35 ` Alejandro Colomar (man-pages)
2021-01-10 14:57 ` Alejandro Colomar [this message]
2021-01-19 19:59 ` Ping: [PATCH v2] " Alejandro Colomar (man-pages)
2021-01-20 8:50 ` Michael Kerrisk (man-pages)
2021-01-20 8:55 ` Michael Kerrisk (man-pages)
2021-01-12 20:51 ` [PATCH] " Jakub Wilk
2021-01-14 7:11 ` G. Branden Robinson
2021-01-21 19:54 ` Alejandro Colomar (man-pages)
2021-01-21 20:14 ` Jakub Wilk
2021-01-21 20:19 ` Alejandro Colomar
2021-01-22 3:23 ` G. Branden Robinson
2021-01-22 9:35 ` Jakub Wilk
2021-01-22 10:07 ` G. Branden Robinson
2021-01-22 10:50 ` Alejandro Colomar (man-pages)
2021-01-22 14:51 ` G. Branden Robinson
2021-01-22 17:27 ` Alejandro Colomar (man-pages)
2021-01-09 22:09 ` Alejandro Colomar (man-pages)
2021-01-22 12:37 ` Ping: " Alejandro Colomar (man-pages)
2021-01-22 15:13 ` Michael Kerrisk (man-pages)
2021-01-22 18:19 ` Alejandro Colomar (man-pages)
2021-01-23 9:15 ` Michael Kerrisk (man-pages)
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20210110145745.4360-1-alx.manpages@gmail.com \
--to=alx.manpages@gmail.com \
--cc=g.branden.robinson@gmail.com \
--cc=linux-man@vger.kernel.org \
--cc=mtk.manpages@gmail.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).