libgrip

Libgrip needs developer documentation

Bug #744911 reported by David Planella on 2011-03-29

This bug affects 1 person

Affects		Status	Importance	Assigned to	Milestone
	libgrip	Fix Released	Medium	Stephen M. Webb	libgrip 0.3.0
	libgrip (Ubuntu)	Fix Released	Undecided	Unassigned

Bug Description

As discussed previously, we're trying to publish the documentation of the APIs in the Ubuntu platform at http://developer.ubuntu.com/api/

This is a bug to track the progress for the task of creating a libgrip-doc package with the documentation present in the source code, or alternatively ship a gir file so that we can extract the relevant information from it.

Here's the overview of the overall status at https://wiki.ubuntu.com/DeveloperUbuntuComApi

Related branches

lp://staging/~bregma/libgrip/lp-744911

Merged into lp://staging/libgrip at revision 52

Duncan McGreggor (community): Approve on 2011-03-31

David Planella: Pending (review docs published) requested 2011-03-31

lp://staging/libgrip

lp://staging/libgrip/quantal

lp://staging/ubuntu/oneiric/libgrip

Stephen M. Webb (bregma) on 2011-03-29

Changed in libgrip:
status:	New → Triaged
assignee:	nobody → Stephen M. Webb (bregma)

Stephen M. Webb (bregma) on 2011-03-29

Changed in libgrip:
status:	Triaged → In Progress

Duncan McGreggor (oubiwann) on 2011-03-31

Changed in libgrip:
importance:	Undecided → Medium

Stephen M. Webb (bregma) on 2011-08-09

Changed in libgrip:
status:	In Progress → Fix Committed

Stephen M. Webb (bregma) on 2011-08-09

Changed in libgrip:
milestone:	none → 0.3.0

Revision history for this message

Launchpad Janitor (janitor) wrote on 2011-08-09:

This bug was fixed in the package libgrip - 0.3.0-0ubuntu1

---------------
libgrip (0.3.0-0ubuntu1) oneiric; urgency=low

  * New upstream release.
    - Add documentation (LP: #744911)
    - Expose device type and attributes
-- Chase Douglas <email address hidden> Tue, 09 Aug 2011 16:33:26 -0700

Changed in libgrip (Ubuntu):
status:	New → Fix Released

Chase Douglas (chasedouglas) on 2011-08-09

Changed in libgrip:
status:	Fix Committed → Fix Released

Revision history for this message

David Planella (dpm) wrote on 2011-08-24:

Thanks a lot for this!

I was about to add the libgrip documentation to developer.ubuntu.com/api, but I couldn't find the libgrip-doc package with the documentation in the archive.

Is there any additional step necessary to publish a libgrip-doc package?

Revision history for this message

Stephen M. Webb (bregma) wrote on 2011-08-24:

I think the -doc package still needs to be seeded into Ubuntu. It's available in the uTouch daily archives https://launchpad.net/~utouch-team/+archive/daily but not the Ubuntu archives.

Revision history for this message

David Planella (dpm) wrote on 2011-08-24: Re: [Bug 744911] Re: Libgrip needs developer documentation

El dc 24 de 08 de 2011 a les 12:52 +0000, en/na Stephen M. Webb va
escriure:
> I think the -doc package still needs to be seeded into Ubuntu. It's
> available in the uTouch daily archives https://launchpad.net/~utouch-
> team/+archive/daily but not the Ubuntu archives.
>

In that case, is it just a matter of submitting a MIR for the
libgrip-doc package?

If that's all what's needed to have online libgrip documentation, could
perhaps someone in the DX team do the MIR?

Thanks!

Martin Pitt (pitti) on 2011-09-30

Changed in libgrip (Ubuntu):
status:	Fix Released → Triaged

Revision history for this message

Martin Pitt (pitti) wrote on 2011-09-30:

install documentation Edit (1.2 KiB, text/plain)

It's not a question of seeding or MIR. The libgrip source simply doesn't build a libgrip-doc binary. Also, I don't think it's really necessary to have a separate -doc, for small libraries the documentation usually just goes into libgrip-dev.

I was about to push this into lp:~utouch-packaging/libgrip/ubuntu, but it's out of date wrt. to the archive.

Attaching a debdiff how to install the documentation properly: Files go into /usr/share/doc/, and we provide a gtk-doc symlink. This works properly with devhelp (I tested), and is Debian Policy conformant.

Revision history for this message

Martin Pitt (pitti) wrote on 2011-09-30:

I can upload/sponsor this, if someone tells me to go ahead with this and ignore the inconsistent Vcs-Bzr: branch.

Revision history for this message

Martin Pitt (pitti) wrote on 2011-09-30:

Talked to Chase, clarified bzr status.

Chase Douglas (chasedouglas) on 2011-09-30

Changed in libgrip (Ubuntu):
status:	Triaged → Fix Committed

Revision history for this message

Martin Pitt (pitti) wrote on 2011-09-30:

Forgot bug ref in the changelog, sorry:

libgrip (0.3.2-0ubuntu3) oneiric; urgency=low

  * debian/control: Fix Vcs-Bzr: to be an actual branch, and also point to
    oneiric branch to match what's actually in the archive.
  * debian/libgrip-dev.install: Install the HTML documentation into
    /usr/share/doc/.
  * Add debian/libgrip-dev.links: Provide a gtk-doc symlink for devhelp.

-- Martin Pitt <email address hidden> Fri, 30 Sep 2011 07:38:01 +0200

Changed in libgrip (Ubuntu):
status:	Fix Committed → Fix Released

Report a bug

This report contains Public information

Everyone can see this information.

You are

Subscribing...

Edit bug mail

Other bug subscribers

Patches

install documentation Edit

Add patch

Remote bug watches

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