~/.bughelper/config not created by sudo apt-get install bughelper

[David Farning]

Binary package hint: bughelper

Step 8 of https://wiki.ubuntu.com/BugHelper/Documentation/WritingClueFiles indicates that ~/.bughelper/config should exit after bughelper installation.

~/.bughelper/config was not present after bughelper installation on my feisty system.

As you can tell, I am quite eager to start running bug helper against mozillateam bugs.

thanks
David

[David Farning (dfarning)]

This is strange. The file showed up about 15 minutes later. hmmm

[Thomas Butter (tbutter)]

The wiki documentation is wrong, the file is created when bugxml is executed the first time.

To get it just call bugxml once without arguments.

Since this error is also in /usr/share/doc/bughelper/adding-cluefiles.txt the bug should still be open.

[Daniel Holbach (dholbach)]

It does not need to be 'bugxml', but 'bughelper' will work also. Maybe we should add a
  bughelper --gen-config
command or something, that does a noop.

[Alex Muntada (alex.muntada)]

I guess the "bughelper --gen-config" should be added between steps 7 and 8 in WritingClueFiles, so it will work for bughelper package and for people running from the bzr branch for the first time.

A simpler approach is to add a new step that describes in detail the ~/.bughelper/config contents, so there's no need to run "bughelper --gen-config" and edit that file later. Since people need to edit the config file, I guess they won't argue if they have to cut&paste its contents from the documentation. WDYT?

[Daniel Holbach (dholbach)]

I personally think it's easier to have the file generated for you.

Other opinions?

[Alex Muntada (alex.muntada)]

However, note that running "bughelper --gen-config" when installing that package won't solve the issue for people running bughelper from bzr (i.e. Ubuntu Edgy and earlier), so a new step between 7 and 8 should be added anyway. Right?

Just trying to make my point clear, since I don't care if it's --gen-config or manual editing.

[Emilio Pozuelo Monfort (pochu)]

Isn't it possible to make the installation (of the deb package) gen it?

And if not, I think the first command you run should automatically do it for you.

[Daniel Holbach (dholbach)]

Emilio: No, it's not possible. You install bughelper on a system for all users, but you have to create per-user configuration files.

Alex: It will solve the problem, how would it not? With whatever commands you run bughelper, it will create the configuration on first run. I just thought it made more sense to have an option for that, instead of having a step between 7 and 8 that read "run bughelper --help". :-)

[Alex Muntada (alex.muntada)]

Daniel: creating config on first run is good, I agree. Then, a new step between 7 and 8 that reads "run bughelper --gen-config" would solve the problem for everybody, agreed too.

I was confused like Emilio and thought that "bughelper --gen-config" would be run during the package installation, which now it's obvious that was a misunderstanding on our part.

Sorry for bringing noise to this bug... ;)

[Henrik Nilsen Omma (henrik)]

OK, so going back to the original report and the wiki page ... Step 8 tells you to edit a file which does not exist before you can do step 9. But running step 9 would create the file :)

Why don't we just pick some sensible defaults for the config file, like:

Packages-Dir: ~/.bughelper/packages
Local-Packages-Dir: ~/.bughelper/myclues
Update-Interval: 24
Attachments-Cache: ~/.bughelper/attachments-cache

which wil be generated the first time it is run anyway. That way step 8 can be eliminated completely from the docs and new-step-8 would let you get on with trying a clue. The Local-Packages-Dir can always be modified later and that can be documented further down on the wiki page.

[Daniel Holbach (dholbach)]

Somebody needs to work on the 'noop' thing then.

[Daniel Holbach (dholbach)]

Apart from Local-Packages-Dir: it's what gets done on the first run. I'd suggest a "visible" location for the local packages dir, for example, it's ~/bzr/bughelper-data for me. It's a location that should not be set until people really use that dir.

[Henrik Nilsen Omma (henrik)]

OK, so we'll leave the functionality as it is. The 'issue' that arises from this can be fixed by just refactoring the documentation, which I'm doing now.

[Daniel Holbach (dholbach)]

... and adding a --gen-config option to bughelper, which is a noop and should exit(0)

[Alex Muntada (alex.muntada)]

Unless anybody else is working on this bug, tomorrow I'll be adding the noop thing to bughelper.main.

Please, note that this is the only open bug in milestone 0.1.

[Alex Muntada (alex.muntada)]

Please review and push into bughelper.main:

~alex.muntada/bughelper/bughelper.dev
------------------------------------------------------------
revno: 88
committer: Alex Muntada <email address hidden>
branch nick: alex.muntada
timestamp: Mon 2007-02-19 01:46:26 +0100
message:
  Added --gen-config option to bughelper, so we can just generate the
  ~/.bughelper/config file and exit (closes #84489)

[Alex Muntada (alex.muntada)]

Unless anybody else commits my changes into bughelper.main, I'm going to do it this afternoon.

Then, I'll update the wiki page and doc dir in bughelper.main too, so we can close this bug once and for all... ;)

[Alex Muntada (alex.muntada)]

------------------------------------------------------------
revno: 89
committer: Alex Muntada <email address hidden>
branch nick: bughelper.main
timestamp: Wed 2007-02-21 20:24:13 +0100
message:
  Updated --gen-config doc from wiki.ubuntu.com.
------------------------------------------------------------
revno: 88
committer: Alex Muntada <email address hidden>
branch nick: alex.muntada
timestamp: Mon 2007-02-19 01:46:26 +0100
message:
  Added --gen-config option to bughelper, so we can just generate the
  ~/.bughelper/config file and exit (closes #84489)

[Alex Muntada (alex.muntada)]

Ready to package.

[Daniel Holbach (dholbach)]

 bughelper (0.1~r90) feisty; urgency=low
 .
   * New release:
     - added --gen-config, so the documentation at
       https://wiki.ubuntu.com/BugHelper/doc/writing-clue-files is consistent
       again (LP: #84489)
     - added script that retrieves wiki pages and puts them to doc/*
       after removing a few parts (ToC and footer)
     - lots of documentation updates (LP: #79222)
     - don't fail on invalid XML (LP: #85150),
     - do not crash, when local-packages-dir is undefined,
     - option to count quantity of bugs