bzr(1) has unwanted line at start

[Ralph Corderoy]

Binary package hint: bzr

Ubuntu 8.04, bzr 1.3.1-1ubuntu0.1.

    $ zcat /usr/share/man/man1/bzr.1.gz | head
    Man page for Bazaar (bzr)
    .\"
    .\" Large parts of this file are autogenerated from the output of
    .\" "bzr help commands"
    .\" "bzr help <cmd>"
    .\"
    .\" Generation time: 2008-05-30 17:18:39 +0000
    .\"
    .TH bzr 1 "2008\-05\-30" "1.3.1" "Bazaar"
    .SH "NAME"
    $

The first line appears in the output of `man bzr' and also stops

    $ man -k bzr
    Bazaar (bzr) (1) [bzr] - (unknown subject)
    bzr (1) - (unknown subject)
    $

from working properly. It looks like it simply shouldn't be there.

[Old_Soldier (charles.davis)]

Confirming that this behavior exists in bzr on Hardy

[David Futcher (bobbo)]

Looks liek this can be fixed by commenting out the very first line. Attached is a patch to fix this.

[Kurt Litsch (kurt.litsch)]

Debdiff applying David's patch.

[Alexander Sack (asac)]

could you work add that patch into debian/patches/ ? and also adapt that patch to apply cleanly to the latest intrepid version? since we are at 1.6-1 you would need to ubuntunize maintainer fields too.

At best provide a bzr branch so we can just merge and upload it. the packaging branch is at http://bzr.debian.org/pkg-bazaar/bzr/unstable.

[Alexander Sack (asac)]

incomplete: read comment i dropped above.

[Ralph Corderoy (ralph-inputplus)]

Sorry, but I don't fix the patch is the correct fix for this bug. Having dug a little I find the man pages are created at build time, thus it is the program used to build them that should be fixed rather than the output of the program being patched up.

The program is tools/doc_generate/autodoc_man.py. A bug was introduced in revno 1551.3.11.

    revno: 1551.3.11
    committer: Aaron Bentley <email address hidden>
    branch nick: bzr.ab
    timestamp: Tue 2006-02-07 16:40:33 -0500
    message:
      Merge from Robert

The changes include

     man_preamble = """\
    -.\\\" Man page for %(bzrcmd)s (bazaar-ng)
    +Man page for %(bzrcmd)s (bazaar-ng)
     .\\\"
     .\\\" Large parts of this file are autogenerated from the output of
     .\\\" \"%(bzrcmd)s help commands\"

which altered the first line of the produced man page so it isn't a troff comment. All that needs to happen is same six characters that start the "Large parts" line should be prefixed once again to the "Man page" line.

[James Westby (james-w)]

Hi,

I don't see a reason to upload this as a patch to Ubuntu. This bug is already
against bzr, and any patch can just be applied there.

For bzr we work very carefully to do the work in Debian and sync across, and
only work directly in Ubuntu where things like freezes prevent that.

In this case I see no reason to upload directly for this small bug. I'll put up
a fix directly to bzr now.

Thanks,

James

[Ralph Corderoy (ralph-inputplus)]

Fixing the generator program would also fix this problem in all the man
pages it produces, not just the one I raised the bug on.

[James Westby (james-w)]

Hi,

The patch has been sent to the bzr mailing list for review.

Thanks,

James

[Alexander Sack (asac)]

On Tue, Sep 16, 2008 at 12:02:28PM -0000, James Westby wrote:
> Hi,
>
> I don't see a reason to upload this as a patch to Ubuntu. This bug is already
> against bzr, and any patch can just be applied there.
>
> For bzr we work very carefully to do the work in Debian and sync across, and
> only work directly in Ubuntu where things like freezes prevent that.
>

OK James. I'll leave it to you then. Maybe consider to unsubscribe the
main sponsors team to make this disappear from our sponsoring list :).

Cheers,

 - Alexander

[James Westby (james-w)]

> OK James. I'll leave it to you then. Maybe consider to unsubscribe the
> main sponsors team to make this disappear from our sponsoring list :).

I would if I was a main sponsor :-)

Thanks,

James

[Daniel Holbach (dholbach)]

I'm unsubscribing the Sponsors' Team for now. Please re-subscribe when ready.