471930 - Strip User Docs from XPCOM

Status: NEW

(Core :: XPCOM, defect)

Description

[Tyler Downer [He/Him]]

Attachment: Patch v1

PCOM is chuck full of user docs, readmes, todos, etc. that really belong in other places, such as http://www.mozilla.org/projects/xpcom/, devmo, wiki.mozilla.org, etc.
There does not seem any real reason to keep these docs here. The only drawback I can see is disorientation of current or new users. That is why I have filed bug XXXXXX, which places a link to https://developer.mozilla.org/en/Mozilla_Source_Code_Directory_Structure. That page gives links to almost all the project pages for the various directories, as well as other info.

Patch is pretty drastic, but I think there is no big issue in that all.

Comment 1

[Tyler Downer [He/Him]]

Bug 471548 instead of bug XXXXXX. Sorry for the spam.

Comment 2

[Brendan Eich [:brendan]]

Comment on attachment 355185 [details] [diff] [review]
Patch v1

Single r+ should be enough.

/be

Comment 3

[Benjamin Smedberg]

Comment on attachment 355185 [details] [diff] [review]
Patch v1

>diff --git a/xpcom/MoreFiles/ReadMe.txt b/xpcom/MoreFiles/ReadMe.txt
>deleted file mode 100644

This is an external file which was imported with the MoreFiles code. Please do not remove it.

>--- a/xpcom/reflect/xptcall/src/md/test/README

I think this README should be kept.

I know the string guide is on MDC... what about the xptcall docs? Those should definitely be migrated before this lands.

Comment 4

[Tyler Downer [He/Him]]

OK, i will keep those docs. The xptcall docs will have to be moved still before this does land. I was planning on getting those up if this got +. I will get a new patch that addresses those issues up shortly.

Comment 5

[Tyler Downer [He/Him]]

Attachment: Patch v2

This keeps those docs.

Comment 6

[Benjamin Smedberg]

Comment on attachment 355471 [details] [diff] [review]
Patch v2

Please make sure the xptcall docs are ported before landing this. Thanks!

Comment 7

[Tyler Downer [He/Him]]

Will do that in the next few days, then will land this. Thank you!

Comment 8

[Tyler Downer [He/Him]]

https://developer.mozilla.org/En/Xptcall_Porting_Guide has the Guide, with https://developer.mozilla.org/En/Xptcall_Porting_Status having the status board (may need to be updated). Also linked to that from the FAQ.

Comment 9

[Dão Gottwald [:dao]]

http://hg.mozilla.org/mozilla-central/rev/2df29cb1ed93

Comment 10

[Jeff Walden [:Waldo]]

At least some of these docs are being nsinstalled in Makefiles, so the checked-in patch is turning the tree red.  The build logs suggest it's probably easy to fix, but it's probably worth a full xpcom build at least to be sure any bustage fix actually covers all the bases -- could someone do that, please?  Dao, perhaps, since you checked this in?  (I'm in the middle of debugging something else right now and don't have time.)

Comment 11

[Dão Gottwald [:dao]]

backed out

Comment 12

[Tyler Downer [He/Him]]

Attachment: Patch v3

I made a new patch, same stuff, so bringing over +, I think it is alright. Not sure what caused the tree to burn, but here goes.

Comment 13

[Tyler Downer [He/Him]]

checkin needed might help.

Comment 14

[Dão Gottwald [:dao]]

Still doesn't build.

http://tinderbox.mozilla.org/showlog.cgi?log=MozillaTry/1240230760.1240234362.28745.gz

Comment 15

[Tyler Downer [He/Him]]

Well, if someone with more qualifications in this area wants to take this over, please do.