Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

'groff -wall' warnings #12977

Closed
gvanem opened this issue Feb 23, 2024 · 3 comments
Closed

'groff -wall' warnings #12977

gvanem opened this issue Feb 23, 2024 · 3 comments
Assignees
@bagder
Labels
documentation script

Comments

@gvanem
Copy link
Contributor

gvanem commented Feb 23, 2024

I did this

Building curl.exe with support for a compressed --manual and adding -wall to the groff command (a Cygwin-x64 version),
now produces a lot of these warnings:

troff:../lib/tmp/curl.1:285: warning: escape character ignored before '<'
troff:../lib/tmp/curl.1:503: warning: escape character ignored before '<'
...
troff:../lib/tmp/curl.1:1678: warning: escape character ignored before '<'
troff:../lib/tmp/curl.1:5396: warning: escape character ignored before '<'

for a statements like:

.IP "\-v, \-\-verbose"
Makes curl verbose during the operation. Useful for debugging and seeing
what\(aqs going on under the hood. A line starting with \\> means header data sent
by curl, \< means header data received by curl that is hidden in normal cases,
and a line starting with * means additional info provided by curl.

The curl -M for those lines looks like this here (piped via most ver 5.20):
curl-man-2

Not sure if that was intended. I assume the \> should be \\> to balance \\<.
But then again, I'm clueless wrt groff/troff.

PS. I also used the options -r LL=119n -r LT=119n to widen the output.

I expected the following

 -v, --verbose
        Makes  curl verbose during the operation. Useful for debugging and seeing what's going on under the hood.
        A line starting with > means header data sent by curl, < means header data received by curl that is hid-
        den in normal cases, and a line starting with * means additional info provided by curl.

Preferably > and < in some bolder font.

curl/libcurl version

8.7.0-DEV

WARNING: this libcurl is Debug-enabled, do not use in production

curl 8.7.0-DEV (x86_64-pc-win32) libcurl/8.7.0-DEV (mbedTLS/3.4.1) (OpenSSL/3.3.0) Schannel (BearSSL) zlib/1.3 brotli/1.1.0 
zstd/1.5.5 c-ares/1.26.0 WinIDN libssh2/1.10.1_DEV nghttp2/1.60.0 Hyper/1.0.1
Release-Date: [unreleased]
Protocols: dict file ftp ftps gopher gophers http https imap imaps ipfs ipns ldap ldaps mqtt pop3 pop3s scp sftp smb smbs 
smtp smtps telnet tftp ws wss
Features: alt-svc AsynchDNS brotli Debug HSTS HTTP2 HTTPS-proxy IDN IPv6 Kerberos Largefile libz MultiSSL NTLM SPNEGO 
SSL SSPI threadsafe TLS-SRP TrackMemory UnixSockets zstd

And from groff -version

GNU groff version 1.23.0
Copyright (C) 2022 Free Software Foundation, Inc.
GNU groff comes with ABSOLUTELY NO WARRANTY.
You may redistribute copies of groff and its subprograms
under the terms of the GNU General Public License.
For more information about these matters, see the file
named COPYING.

called subprograms:

GNU troff (groff) version 1.23.0
GNU grotty (groff) version 1.23.0
GNU eqn (groff) version 1.23.0

operating system

Win-10.
@bagder bagder self-assigned this Feb 23, 2024
bagder added a commit that referenced this issue Feb 23, 2024
@bagder
gen: make \> in input to render as plain '>' in output
b314ed3 
Reported-by: Gisle Vanem
Fixes #12977
@bagder bagder mentioned this issue Feb 23, 2024
Closed
@bagder bagder closed this as completed in 8d4ff40 Feb 23, 2024
@gvanem
Copy link
Contributor Author

gvanem commented Feb 23, 2024

No troff warnings now and the --manual output looks OK.

@gvanem
Copy link
Contributor Author

gvanem commented Feb 23, 2024

But wouldn't it be better to make > and < look like `>` and `<`?
Like for `alt-svc` etc.

@bagder
Copy link
Member

bagder commented Feb 23, 2024 •
edited

I don't think that can be used as a general rule.

First, we replace backticks with double-quotes in output, so they would appear as "<" and ">".

Then, these characters are also used for example like \<data\> and then you don't want any quotes around the greater than and less than characters...

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@bagder bagder

Labels
documentation script
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

make \> in input to render as plain > in nroff output curl/curl
2 participants
@bagder @gvanem