Minor error in README example

[Ben]

The example in `/usr/share/doc/libpam-dotfile/README.gz` doesn't work because by default `dovecot`'s PAM service name is now `dovecot` (not `imap`).

The README should either be changed to show how `dovecot`'s service name can be changed, or just use `dovecot` as the example service name. The attached diff implements the latter.

[Niklas Klein (kleinernik)]

Made a debdiff out of bens patch

[Niklas Klein (kleinernik)]

Sorry, this is the second time i am patching a package. I just learned how to refer to bugs in lunchpad from the changelog. Therefor i updated my debdiff to a hopefully better formulation in the changelog.

[Mathias Gug (mathiaz)]

Thanks for you patch.

However, the Maintainer field in the control file has not been updated. Please see https://wiki.ubuntu.com/DebianMaintainerField.

[Niklas Klein (kleinernik)]

Sorry, i am new to bugfixing. I have updated the maintainer field, as described under the url you gave me, Mathias.

[Mathias Gug (mathiaz)]

On Tue, Sep 11, 2007 at 06:15:31AM -0000, Niklas Klein wrote:
> Sorry, i am new to bugfixing. I have updated the maintainer field, as
> described under the url you gave me, Mathias.
>
> ** Attachment added: "pam-dotfile_0.7-1ubuntu1.debdiff"
> http://launchpadlibrarian.net/9211224/pam-dotfile_0.7-1ubuntu1.debdiff

Thanks.

However, the package doesn't build correctly. It fails with the
following error:

dh_installdocs doc/{README,README.html,style.css}
cp: cannot stat `doc/{README,README.html,style.css}': No such file or
directory
dh_installdocs: command returned error code 256
make: *** [binary-arch] Error 1

Did you try to build it ? If so, how ?

[Niklas Klein (kleinernik)]

Sorry, do you mean debuild -S ? I followed the tutorial https://wiki.ubuntu.com/MOTU/Recipes/Debdiff

/deb/pam-dotfile/pam-dotfile-0.7$ debuild -S
 fakeroot debian/rules clean
dh_testdir
dh_testroot
rm -f build-stamp
/usr/bin/make distclean
make[1]: Entering directory `/home/nik/deb/pam-dotfile/pam-dotfile-0.7'
make[1]: *** No rule to make target `distclean'. Stop.
make[1]: Leaving directory `/home/nik/deb/pam-dotfile/pam-dotfile-0.7'
make: [clean] Error 2 (ignored)
dh_clean
 dpkg-source -b pam-dotfile-0.7
dpkg-source: building pam-dotfile using existing pam-dotfile_0.7.orig.tar.gz
dpkg-source: building pam-dotfile in pam-dotfile_0.7-1ubuntu1.diff.gz
dpkg-source: building pam-dotfile in pam-dotfile_0.7-1ubuntu1.dsc
 dpkg-genchanges -S
dpkg-genchanges: not including original source code in upload
dpkg-buildpackage (debuild emulation): source only, diff-only upload (original source NOT included)
Now signing changes and any dsc files...

[Niklas Klein (kleinernik)]

I am really sorry, i still have to learn a lot.I now have used pbuilder and i had the same error than you. I fixed the dh_installdocs line.

- dh_installdocs doc/{README,README.html,style.css}
+ dh_installdocs doc/README doc/README.html doc/style.css

Now i can build the package. Thanks for your patience Mathias.

[Mathias Gug (mathiaz)]

On Wed, Sep 12, 2007 at 11:11:30AM -0000, Niklas Klein wrote:
> I am really sorry, i still have to learn a lot.I now have used pbuilder
> and i had the same error than you. I fixed the dh_installdocs line.
>
> - dh_installdocs doc/{README,README.html,style.css}
> + dh_installdocs doc/README doc/README.html doc/style.css

Thanks. It actually builds now.

>
> ** Attachment added: "pam-dotfile_0.7-1ubuntu1.debdiff"
> http://launchpadlibrarian.net/9252236/pam-dotfile_0.7-1ubuntu1.debdiff

Could you also improve the changelog entry: it's not very descriptive of
what has been fixed. You mentionned the LP bug number which is good. Could
you also list the files that you've updated ?

--
Mathias

[Niklas Klein (kleinernik)]

Ok, i added a changelog entry you hopefully will like more.

[Mathias Gug (mathiaz)]

On Fri, Sep 14, 2007 at 07:04:15AM -0000, Niklas Klein wrote:
>
> ** Attachment added: "pam-dotfile_0.7-1ubuntu1.debdiff"
> http://launchpadlibrarian.net/9276579/pam-dotfile_0.7-1ubuntu1.debdiff
>

It's better, but you haven't mentioned the Maintainer change neither the
files. A good changelog entry would be:

 * README: fix imap example to use dovecot. (LP: #110829).
 * debian/rules: fix documentation build.
 * debian/control: Update Maintainer field to follow
   DebianMaintainerField spec.

[Niklas Klein (kleinernik)]

Ok i have added your suggestion to the changelog. I had to learn who the changelog has to look like, by trying and getting responses, how to do better. I can't find the complete useful information in the wiki at ubuntu.com.

What i have learned no is:
* Changelog entry lines are limited to 80 characters
* I a bug is closed, refer to it with: (LP: #xxxxx). at the end of the line
* Mention the files which are changed (This is one thing hard to find out, because i can't find it in the wiki and i haven't seen it in most of the changelog files i read).
* Mention the right release

I used https://wiki.ubuntu.com/MOTU/Recipes/Debdiff to start with trying to help with bugs, perhaps i is a good idea to add an recipe for updating the changelog and refer from https://wiki.ubuntu.com/MOTU/Recipes/Debdiff to this recipe?

If the points i have mention above are right (Mathias?), i am willing to write a recipe page in the wiki. If i am missing some points, please let me know.

[Niklas Klein (kleinernik)]

Ok i have added your suggestion to the changelog. I had to learn who the changelog has to look like, by trying and getting responses, how to do better. I can't find the complete useful information in the wiki at ubuntu.com.

What i have learned now is:
* Changelog entry lines are limited to 80 characters
* I a bug is closed, refer to it with: (LP: #xxxxx). at the end of the line
* Mention the files which are changed (This is one thing hard to find out, because i can't find it in the wiki and i haven't seen it in most of the changelog files i read).
* Mention the right release

I used https://wiki.ubuntu.com/MOTU/Recipes/Debdiff to start with trying to help with bugs, perhaps i is a good idea to add an recipe for updating the changelog and refer from https://wiki.ubuntu.com/MOTU/Recipes/Debdiff to this recipe?

If the points i have mention above are right (Mathias?), i am willing to write a recipe page in the wiki. If i am missing some points, please let me know.

[Mathias Gug (mathiaz)]

Hi Niklas,

On Sat, Sep 15, 2007 at 07:48:00AM -0000, Niklas Klein wrote:
> Ok i have added your suggestion to the changelog. I had to learn who the
> changelog has to look like, by trying and getting responses, how to do
> better. I can't find the complete useful information in the wiki at
> ubuntu.com.
>
> What i have learned now is:
> * Changelog entry lines are limited to 80 characters
> * I a bug is closed, refer to it with: (LP: #xxxxx). at the end of the line
> * Mention the files which are changed (This is one thing hard to find out, because i can't find it in the wiki and i haven't seen it in most of the changelog files i read).
> * Mention the right release
>
> I used https://wiki.ubuntu.com/MOTU/Recipes/Debdiff to start with trying
> to help with bugs, perhaps i is a good idea to add an recipe for
> updating the changelog and refer from
> https://wiki.ubuntu.com/MOTU/Recipes/Debdiff to this recipe?
>
> If the points i have mention above are right (Mathias?), i am willing
> to write a recipe page in the wiki. If i am missing some points, please
> let me know.

That would be a good idea. However I'm not sure if a recipe would be the
best way. Daniel Hobach (<email address hidden>) is currently working on
reorganising the MOTU documentation. You should get in touch with him.
You could also ask on <email address hidden> what are the
main rules for writing a proper changelog entry. You may get more input
on this subject and then write up all the suggestions somewhere in the wiki.

>
> ** Attachment added: "pam-dotfile_0.7-1ubuntu1.debdiff"
> http://launchpadlibrarian.net/9287053/pam-dotfile_0.7-1ubuntu1.debdiff

The debdiff looks good now.

[Niklas Klein (kleinernik)]

pam-dotfile (0.7-1ubuntu1) gutsy; urgency=low

  * README: fix imap example to use dovecot. (LP: #110829).
  * debian/rules: fix documentation build.
  * debian/control: Update Maintainer field to follow
    DebianMaintainerField spec.

 -- Niklas Klein <email address hidden> Fri, 7 Sep 2007 14:13:14 +0200

[Mathias Gug (mathiaz)]

Could you also submit your change to debian ?

That way we won't have to merge the package, but sync it instead. You should not send the debian/control change as this specific to Ubuntu.

[Niklas Klein (kleinernik)]

Ok i have send a patch to debian