Skip to content

'groff -wall' warnings #12977

Closed
Closed

Description

@gvanem

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.

Activity

  1. self-assigned this
    on Feb 23, 2024
  2. added a commit that references this issue on Feb 23, 2024
    b314ed3
  3. gvanem commented on Feb 23, 2024

    @gvanem
    ContributorAuthor

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

  4. gvanem commented on Feb 23, 2024

    @gvanem
    ContributorAuthor

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

  5. added a commit that references this issue on Feb 23, 2024
    8d4ff40
  6. bagder commented on Feb 23, 2024

    @bagder
    Member

    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

Metadata

Metadata

Assignees

Type

No type

Projects

No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions