Update top-level README.txt in CVS

VERIFIED FIXED

Status

()

defect
--
trivial
VERIFIED FIXED
12 years ago
10 years ago

People

(Reporter: Dolske, Assigned: Dolske)

Tracking

Trunk
Points:
---

Firefox Tracking Flags

(Not tracked)

Details

()

Attachments

(1 attachment)

Assignee

Description

12 years ago
While poking around for xpm cleanup after bug 410215, I noticed that we have a rather crufty README.txt in the top level of CVS (see URL).

A couple of choice gems:

"To submit bugs or other feedback, see the Navigator QA menu..."

"To view and use the new streamlined "Modern" theme, your display monitor should be set to display thousands of colors."

As far as I can tell, this file isn't actually used or shipped. Its last update was in 2/2003, and was the only noteworthy update since it landed in the beginning of 2002.

We should just remove it, instead of hoping to periodically remember to update some obscure file (on display in the bottom of a locked filing cabinet stuck in a disused lavatory with a sign on the door saying 'Beware of the Leopard'). Alternatively we could distill it down to something short-and-generic with a 10-year shelf life, but that still seems  hardly worth having.

AFIAK brendan owns the top level dir?

Comment 1

12 years ago
I would like there to be a top-level README file still... but it should mostly contain links to devmo articles such as "how to build this beast" and "how to submit patches"
dolske: There's no mandatory access control, so please remove at will.

bsmedberg: sure, that sounds like README.html -- please feel free to create.

/be
Assignee

Updated

12 years ago
Assignee: nobody → dolske
Summary: Remove top-level README.txt from CVS → Update top-level README.txt in CVS
Assignee

Comment 3

12 years ago
bsmedberg's comment seems fair. Here's a chopped down version of README.txt, which is basically just pointers to other places for basic info.
Attachment #297635 - Flags: review?(benjamin)

Updated

12 years ago
Attachment #297635 - Flags: review?(benjamin) → review+
Comment on attachment 297635 [details]
Updated, shorter README.txt (v.1)

>... you can try asking your question in a
>mozilla.* Usenet group ...

May want to add "via news.mozilla.org" or "on news.mozilla.org", as mozilla.* is not part of Usenet.
Assignee

Comment 5

12 years ago
Checked in, with a clarification to where the newsgroups are.

Checking in README.txt;
/cvsroot/mozilla/README.txt,v  <--  README.txt
new revision: 1.8; previous revision: 1.7
done
Status: NEW → RESOLVED
Last Resolved: 12 years ago
Resolution: --- → FIXED
Turned a bunch of trees red thanks to the merge conflicts due to:

http://bonsai.mozilla.org/cvsblame.cgi?file=/mozilla/tools/tinderbox/post-mozilla-rel.pl&rev=1.140&mark=1380-1386#1379


It would be lovely to remove those lines; I couldn't find a bug on doing so, but I didn't look too hard.

Comment 7

12 years ago
XULRunner, Firefox and Thunderbird at least do package this file, or at least put it into dist/bin/

see http://mxr.mozilla.org/mozilla/source/xulrunner/app/Makefile.in#287 http://mxr.mozilla.org/mozilla/source/browser/locales/Makefile.in#108 http://mxr.mozilla.org/mozilla/source/browser/installer/windows/packages-static#61 http://mxr.mozilla.org/mozilla/source/mail/locales/Makefile.in#86 and http://mxr.mozilla.org/mozilla/source/mail/installer/windows/packages-static#48

It looks like the new contents of this README.txt are not quite right for that purpose. Perhaps the READMEs to package for those apps should be separate from this file, similar to how SeaMonkey does it in http://mxr.mozilla.org/mozilla/source/suite/locales/Makefile.in#79 - then also the hack in http://mxr.mozilla.org/mozilla/source/tools/tinderbox/post-mozilla-rel.pl#1384 could be removed.
Assignee

Comment 8

12 years ago
Those look like different README.txts. For example, the one in my Minefield.app directory reads:

-----
For information about installing, running and configuring Firefox
including a list of known issues and troubleshooting information,
refer to: http://getfirefox.com/releases/
-----

Thunderbird.app has the same (in a TB flavor).

I would submit that if other projects are packaging this top-level readme, they probably shouldn't be, and should instead have their own local version, ala 
http://mxr.mozilla.org/seamonkey/source/browser/app/README.txt

Given how old and crufty the existing file was, I don't think anyone was even reading it (or, at least, complaining about the outdated contents).
Status: RESOLVED → VERIFIED
You need to log in before you can comment on or make changes to this bug.