370728 - manual pages for firefox and thunderbird

Status: RESOLVED WONTFIX

(Firefox Graveyard :: Help Documentation, enhancement, P5)

Description

[Martynas Venckus]

User-Agent:       Mozilla/5.0 (X11; U; OpenBSD i386; en-US; rv:1.8.1.1) Gecko/20070216 Firefox/2.0.0.1
Build Identifier: Mozilla/5.0 (X11; U; OpenBSD i386; en-US; rv:1.8.1.1) Gecko/20070216 Firefox/2.0.0.1

cd xpfe/bootstrap && gmake firefox.1 produces outdated and incorrect manual page. What about creating separate *.man.ins for firefox and thunderbird which could be distributed with the package?

Reproducible: Always

Steps to Reproduce:
1.
2.
3.

Comment 1

[Martynas Venckus]

Attachment: Patch we use with OpenBSD/firefox

Comment 2

[Martynas Venckus]

Marking OS: All.

Comment 3

[timeless]

Comment on attachment 255444 [details] [diff] [review]
Patch we use with OpenBSD/firefox

no. xpfe is for xpfe (suite, seamonkey).

if someone else is using it, they're very broken.

Comment 4

[Martynas Venckus]

We are using only the manual page.

Okay, what about having man page for firefox's shell script then? It's really nice to have description of what it is and describe switches for users. Don't you agree?

Comment 5

[timeless]

*shrug* not my content. i'm not opposed.

Comment 6

[Martynas Venckus]

Component: Help/Documentation. CC some mozilla.man.in people.

Comment 7

[Martynas Venckus]

Attachment: firefox.man.in

Comment 8

[Martynas Venckus]

Attachment: Makefile.in.diff

Okay, what about having separate manual pages for all applications (MOZ_APP_NAME)? The descriptions, shell scripts, switches, etc. should be documented.

Comment 9

[Martynas Venckus]

Any way to get some action on this?

Comment 10

[Robert Kaiser]

Future SeaMonkey versions (based on toolkit) should already be using their own man pages from suite/app - I never would have thought that Firefox or Thunderbird would be using the one from xpfe/bootstrap, I thought that was suite-only...

In any case, new man files for them should not live anywhere in xpfe/ but should be in browser/app/ and mail/app/ just like our new one is in suite/app/

Comment 11

[Martynas Venckus]

Attachment: browser_app_Makefile.in.diff

Manual page for firefox.

Comment 12

[Martynas Venckus]

Any progress?

Comment 13

[Steffen Wilberg]

Comment on attachment 257056 [details] [diff] [review]
browser_app_Makefile.in.diff

You're missing the GARBAGE line and the endif from the original code:
http://bonsai.mozilla.org/cvsblame.cgi?file=mozilla/xpfe/bootstrap/Makefile.in&mark=399-410,429-431#399

You should create patches with cvs diff -up8, so that bugzilla's patch viewer can link to the patched files:
http://developer.mozilla.org/en/docs/Creating_a_patch

Then you have to request review from a qualified person:
http://www.mozilla.org/projects/firefox/review.html
Click the "Details" link on the patches, set the review flag to "?" and enter the requestee's email address.

Comment 14

[Mike Connor [:mconnor]]

Not sure this is useful, not sure this is bad though.  P5/Future though, seems easier to just stick this on the support wiki.

Comment 15

[Justin Dolske [:Dolske]]

We do not intend to fix this.