RFE: Write manpages for bughelper suite

Bug #79218 reported by Daniel Holbach
4
Affects Status Importance Assigned to Milestone
Bug Helper
Fix Released
Medium
Alex Muntada

Bug Description

Somebody please write up some manpages we can install with the suite. I suggest we use docbook to write them and build man pages from them during the package build process.

./README in the branch ~bugsquad/bughelper/bughelper.main should have enough information already - it just needs to be written up. To get an idea of docbook for manpages run:

     apt-get source kxmame; cd kxmame-*; less debian/kxmame.1.docbook

Changed in bughelper:
importance: Undecided → Medium
status: Unconfirmed → Confirmed
Changed in bughelper:
assignee: nobody → alex.muntada
status: Confirmed → In Progress
Revision history for this message
Alex Muntada (alex.muntada) wrote :

After figuring out how to get my own bzr branch and playing a little with docbook manual pages, I finally have a working version available in: ~alex.muntada/bughelper/bughelper.dev

Could someone review and merge it into main branch?

To produce the bughelper.1 manpage you'll need the docbook2x package and run something like this:

cd debian && docbook2x-man bughelper.1.docbook && man ./bughelper.1

Now, I'd like to know if the bugxml and bugnumbers pages should be kept separately or you think that it's fine to put them in the same file and install them as symlinks (still dunno how to do it, but I'll find if needed).

Changed in bughelper:
status: In Progress → Needs Info
Revision history for this message
Alex Muntada (alex.muntada) wrote :

Sorry, I committed the changes locally but I can't manage to push them on Launchpad. Will tell you when done.

Changed in bughelper:
status: Needs Info → In Progress
Revision history for this message
Dean Sas (dsas) wrote :

Alex: you need to "bzr push --create-prefix sftp://bazaar.launchpad.net/~alex.muntanda/bughelper/bughelper.dev"

If your name on your computer isn't alex.muntanda then you may need to do "bzr push --create-prefix sftp://<email address hidden>/~alex.muntanda/bughelper/bughelper.dev"

Hop on IRC if you need some help.

Revision history for this message
Alex Muntada (alex.muntada) wrote :

Dean, I asked in #bzr because I had created an external branch from the website; those external branches cannot be updated through sftp (it's a known bug), so I was suggested to rename the branch and set the product to "obsolete-junk".

I just did and then published my branch as you said (it didn't work before), so my changes are now avaible and ready for review.

Changed in bughelper:
status: In Progress → Fix Committed
Revision history for this message
Daniel Holbach (dholbach) wrote :

Good work, Alex! We just need manpages for bugxml also (maybe not for bugnumers *shrug*).

We also need this bit.

=== modified file 'debian/control'
--- debian/control 2006-12-31 13:39:59 +0000
+++ debian/control 2007-01-23 08:43:13 +0000
@@ -3,6 +3,7 @@
 Priority: extra
 Maintainer: Daniel Holbach <email address hidden>
 Build-Depends: cdbs (>= 0.4.43), debhelper (>= 5), python-central (>= 0.5), python-all-dev (>= 2.4)
+Build-Depends-Indep: docbook2x
 Standards-Version: 3.7.2
 XS-Python-Version: all

Changed in bughelper:
status: Fix Committed → Confirmed
Revision history for this message
Alex Muntada (alex.muntada) wrote :

Added Daniel's patch plus new bugxml(1) manpage, and made minor fixes to bughelper(1) manpage. Please, review and commit in bughelper.main.

More opinions about bugnumbers(1) page?
Should we mention it on the same bughelper(1) page?

Changed in bughelper:
status: Confirmed → Fix Committed
Revision history for this message
Daniel Holbach (dholbach) wrote :

Thanks a lot Alex!

------------------------------------------------------------
revno: 55
committer: Daniel Holbach <email address hidden>
branch nick: bughelper.main
timestamp: Tue 2007-01-30 10:43:34 +0100
message:
  commit slightly modified patch by Alex Muntada to give us manpages #79218
    ------------------------------------------------------------
    revno: 38.1.5
    merged: <email address hidden>
    committer: Alex Muntada <email address hidden>
    branch nick: alex.muntada
    timestamp: Thu 2007-01-25 01:34:16 +0100
    message:
      added new bugxml(1) manpage
    ------------------------------------------------------------
    revno: 38.1.4
    merged: <email address hidden>
    committer: Alex Muntada <email address hidden>
    branch nick: alex.muntada
    timestamp: Thu 2007-01-25 01:33:34 +0100
    message:
      - splitted description and added overview
      - unified option spelling
    ------------------------------------------------------------
    revno: 38.1.3
    merged: <email address hidden>
    committer: Alex Muntada <email address hidden>
    branch nick: alex.muntada
    timestamp: Thu 2007-01-25 00:42:44 +0100
    message:
      Patch by Daniel Holbach from bug 79218 (Build-Depends-Indep in debian/control)
    ------------------------------------------------------------
    revno: 38.1.2
    merged: <email address hidden>
    committer: Alex Muntada <email address hidden>
    branch nick: alex.muntada
    timestamp: Mon 2007-01-22 21:41:31 +0100
    message:
      Added debian rules to make the bughelper man page.
    ------------------------------------------------------------
    revno: 38.1.1
    merged: <email address hidden>
    committer: Alex Muntada <email address hidden>
    branch nick: alex.muntada
    timestamp: Mon 2007-01-22 21:39:21 +0100
    message:
      First version of bughelper man page, based on "bughelper -h" output.
------------------------------------------------------------

Changed in bughelper:
status: Fix Committed → Fix Released
To post a comment you must log in.
This report contains Public information  
Everyone can see this information.

Other bug subscribers

Remote bug watches

Bug watches keep track of this bug in other bug trackers.