public inbox for bzip2-devel@sourceware.org
 help / color / mirror / Atom feed
From: Helge Kreutzmann <debian@helgefjell.de>
To: Mark Wielaard <mark@klomp.org>
Cc: bzip2-devel@sourceware.org
Subject: Re: Errors in man pages of bzip2
Date: Wed, 20 Apr 2022 16:44:27 +0200	[thread overview]
Message-ID: <20220420144427.GA26593@Debian-50-lenny-64-minimal> (raw)
In-Reply-To: <Yl8rcp7suXvrsRq4@wildebeest.org>

[-- Attachment #1: Type: text/plain, Size: 2696 bytes --]

Hello Mark,
On Tue, Apr 19, 2022 at 11:36:50PM +0200, Mark Wielaard wrote:
> Sorry for the late reply.
> 
> On Sat, Feb 05, 2022 at 11:35:40AM +0100, Helge Kreutzmann wrote:
> > Finally the issues I'm reporting have accumulated over time and are
> > not always discovered by me, so sometimes my description of the
> > problem my be a bit limited - do not hesitate to ask so we can clarify
> > them.
> > 
> > I'm now reporting the errors for your project. If future reports
> > should use another channel, please let me know.
> 
> If you could file future issues in bugzilla:
> https://sourceware.org/bugzilla/enter_bug.cgi?product=bzip2
> Then there is an archive. But sending reports to this list is also
> fine.

I can do this; however in February I was told by Micah Snyder to use
https://gitlab.com/groups/bzip2/-/issues

Is the sourcware bugzilla now preferred?

> > Man page: bzdiff.1
> > Issue: missing markup (B< >)
> > 
> > "cmp(1), diff(1), bzmore(1), bzless(1), bzgrep(1), bzip2(1)"
> 
> I don't understand what is wrong here.

The entries in SEE ALSO are marked in bold, which usually is indicated
in our format with B<>, so it should be B<cmp>(1) instead of cmp(1)
and similarly for the others. If you use *roff, it could look like
.BR \%cmp (1),
.BR \%diff (1),
...
> > --
> > Man page: bzexe.1
> > Issue: markup of the command: B<bzexe /bin/cat>
> > 
> > "The I<bzexe> utility allows you to compress executables in place and have "
> > "them automatically uncompress and execute when you run them (at a penalty in "
> > "performance).  For example if you execute ``bzexe /bin/cat'' it will create "
> > "the following two files:"
> 
> I believe bzexe is a Debian extension that isn't part of bzip2 as we ship it.

Ok, then I mark this accordingly.

> > --
> > Man page: bzgrep.1
> > Issue: missing markup (B< >)
> > 
> > "grep(1), egrep(1), fgrep(1), bzdiff(1), bzmore(1), bzless(1), bzip2(1)"
> 
> Again, I don't understand the issue here.

Same as above, missing bold markup.

> > --
> > Man page: bzmore.1
> > Issue: missing markup (B< >)
> > 
> > "more(1), less(1), bzip2(1), bzdiff(1), bzgrep(1)"
> 
> This is like above, I don't really understand what is wrong with the
> way we use SEE ALSO in the manpages.


Same as above, missing bold markup.

Thanks for handling the issues!

Greetings

         Helge

-- 
      Dr. Helge Kreutzmann                     debian@helgefjell.de
           Dipl.-Phys.                   http://www.helgefjell.de/debian.php
        64bit GNU powered                     gpg signed mail preferred
           Help keep free software "libre": http://www.ffii.de/

[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 833 bytes --]

  reply	other threads:[~2022-04-20 14:44 UTC|newest]

Thread overview: 5+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2022-02-05 10:35 Helge Kreutzmann
2022-04-19 21:36 ` Mark Wielaard
2022-04-20 14:44   ` Helge Kreutzmann [this message]
2022-04-20 23:04     ` Mark Wielaard
2022-04-21 15:47       ` Helge Kreutzmann

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=20220420144427.GA26593@Debian-50-lenny-64-minimal \
    --to=debian@helgefjell.de \
    --cc=bzip2-devel@sourceware.org \
    --cc=mark@klomp.org \
    /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 read-only IMAP folder(s) and NNTP newsgroup(s).