Gentoo Websites Logo
Go to: Gentoo Home Documentation Forums Lists Bugs Planet Store Wiki Get Gentoo!
Bug 118952 - distfiles documentation needs updating
Summary: distfiles documentation needs updating
Status: RESOLVED FIXED
Alias: None
Product: Gentoo Infrastructure
Classification: Unclassified
Component: Other (show other bugs)
Hardware: All Linux
: High normal (vote)
Assignee: Gentoo Infrastructure
URL: http://www.gentoo.org/proj/en/infrast...
Whiteboard:
Keywords:
Depends on: 135098
Blocks:
  Show dependency tree
 
Reported: 2006-01-13 23:35 UTC by Brian Harring (RETIRED)
Modified: 2010-08-03 22:46 UTC (History)
2 users (show)

See Also:
Package list:
Runtime testing required: ---


Attachments

Note You need to log in before you can comment on or make changes to this bug.
Description Brian Harring (RETIRED) gentoo-dev 2006-01-13 23:35:03 UTC
Hola.
Specify, section #4 of the doc needs modification- no manual intervention should occur for distfiles cleansing, sucker's carefully setup to handle it automatically, folks reading a doc and following the instructions screwing things up would be a bad thing ;)
Comment 1 Brian Harring (RETIRED) gentoo-dev 2006-02-04 02:10:09 UTC
actually... whole doc needs updating.

aside from that, I'm probably adding mirror-dist to the tree since it's useful beyond just infra uses (now would be the time to sqawk if you dislike) ;)
Comment 2 Lance Albertson (RETIRED) gentoo-dev 2006-05-18 21:59:11 UTC
Mind offering a diff? (or new file) :) If not, it'll probably take a bit to find time to update the doc.
Comment 3 Brian Harring (RETIRED) gentoo-dev 2006-05-31 19:57:26 UTC
Don't have a diff to offer- just stick in something as straight forward "for report of current master mirror status, go here".

Main thing is getting the report linked up rather then me and a few others being the only ones to know about it...
Comment 4 Curtis Napier (RETIRED) gentoo-dev 2006-07-04 03:19:26 UTC
I have a very rough draft started. If you would look at it and make sure that it is technically correct so far. Also, if you would look at the flow of the doc and make sure that it makes sense, is it presenting the info correctly or would you like a different format, etc...

It's basically broken down into two sections. The first section is relevant to devs wanting to put files on the mirrors. The second section is for Infra.

There is still info that I haven't put in yet but comments on anything you feel is important that I don't have yet would be welcome. Especially on the Step by Step part, I hacked that together and it needs to be more ummmm better :-)

I do have my irc logs with ferringb and zmedico so the Common Fetch Errors part will be filled in. Any suggestions for that will be appreciated though.

Information needed:

* Where do the scripts reside on osprey (/usr/local/)?

* Where is the failure.xml report being written to?

* Where is the fail log (/var/log/$)

ToDo:

* Set up rsync module on osprey for failure.xml(not sure where this is on osprey) This needs to be done ASAP.

* Set up rsync on loon to copy failure.xml to loon.gentoo.org:/var/www/www.gentoo.org/htdocs/dyn/ instead of dev.gentoo.org/~zmedico/infra/distfiles/ (I can do this as soon as the rsync on osprey is set up)

* "--disable-central-pid-manager" is being used on mirror-dist.sh due to grsec
 issues on osprey, specifically waitpid failing in an unknown way. This needs to be researched and a permanent solution applied. (should I open a new bug for this or is there one already, other?)

* gen-report-xml.py currently renders failure.xml directly instead of using
 an XSL transform. zmedico, open a new bug and give me details on how you want that accomplished. No account on osprey means I have no idea of whats inside the scripts so no clue how/what I should do for this.

* Ramereth, is it possible for me to get an account on osprey with the proper perms?

http://wwwredesign.gentoo.org/proj/en/infrastructure/mirrors/overview-distfile.xml
In CVS - (Should show up in about an hour)
Comment 5 Zac Medico gentoo-dev 2006-07-04 11:05:55 UTC
(In reply to comment #4)
> * Where do the scripts reside on osprey (/usr/local/)?

/home/distfiles/scripts

> * Where is the failure.xml report being written to?

/home/distfiles/reports/failure.xml

> * Where is the fail log (/var/log/$)

/home/distfiles/logs/{failure,success}.log

> * gen-report-xml.py currently renders failure.xml directly instead of using
>  an XSL transform. zmedico, open a new bug and give me details on how you want
> that accomplished. No account on osprey means I have no idea of whats inside
> the scripts so no clue how/what I should do for this.

Here is a tarball of the current scripts:

http://dev.gentoo.org/~zmedico/infra/distfiles/distfiles-scripts.tar.bz2

I've opened bug 139213 to address the problem with gen-report-xml.py.
Comment 6 Curtis Napier (RETIRED) gentoo-dev 2006-07-05 11:30:08 UTC
I have it fleshed out now I think. I'm still not quite sure about the entire process so please look carefully when you proofread:
http://wwwredesign.gentoo.org/proj/en/infrastructure/mirrors/overview-distfile.xml

Thanks for the tarball zac. I was hinting at ramereth to set me up an account but I appreciate it. ;-)

Is there still an issue with dev.g.o:/space/distfiles-whitelist/ not being deleted correctly? Is someone doing it manually? Do we know how to fix it or does it need to be researched?
Comment 7 Brian Harring (RETIRED) gentoo-dev 2006-07-11 11:55:27 UTC
Bleh, pardon the delay.

suggestions-
1) The description of the tier updating in section #1 is a bit off; implies it's a push setup, when in reality it's all mirrors servers doing pulls at offset cronjobs- it's not bandwidth issues that limit files getting on the mirrors, it's A) timing, B) unable to pull a file for the master image, C) broken distfiles mirror (no longer doing cronjob'd pulls).

I'd rephrase that to reflect that, since the "bandwidth constraints" is a bit of smoke ;)

2) whitelist file wasn't designed to be maintained indefinitely- that was borked in the switch to the new d.g.o.  Original agreed upon period for whitelist files was 6 months- after 6 months of whitelisting, have to move the files into the appropriate months whitelisting to continue exempting them.  If y'all are changing it, hey cool, just commenting on what it was originally setup as.

3) common fetch errors addition- host isn't valid (happens a lot), related, host is too laggy for usage (timeouts on fetching).

Aside from that, looks good, ty curtis.
Comment 8 Curtis Napier (RETIRED) gentoo-dev 2006-07-11 18:29:05 UTC
Thanks ferringb, I've completed the changes and commited (in CVS). I've left the bug open pending resolution of bug#135098. I will update this doc when that bug is fixed.
Comment 9 Thomas Cort (RETIRED) gentoo-dev 2006-07-12 05:08:34 UTC
"Instructions for new developers"[1] also needs to be updated.

[1] http://www.gentoo.org/proj/en/devrel/new-dev-training.xml#doc_chap2
Comment 10 Kurt Lieber (RETIRED) gentoo-dev 2006-07-12 05:53:12 UTC
(In reply to comment #9)
> "Instructions for new developers"[1] also needs to be updated.
> 
> [1] http://www.gentoo.org/proj/en/devrel/new-dev-training.xml#doc_chap2


What specifically needs to be updated?
Comment 11 Thomas Cort (RETIRED) gentoo-dev 2006-07-12 06:13:26 UTC
(In reply to comment #10)
> (In reply to comment #9)
> > "Instructions for new developers"[1] also needs to be updated.
> > 
> > [1] http://www.gentoo.org/proj/en/devrel/new-dev-training.xml#doc_chap2
>
> What specifically needs to be updated?

The "Putting files on mirrors" section tells the developer that copying a file to dev.gentoo.org:/space/distfiles-local is the proper way of getting files to the mirrors. That, according to overview-distfile.xml, is wrong. Files are automatically fetched and there is no need to copy them to dev.g.o yourself unless they are for distfiles with mirror://. It should be updated to reflect what's on overview-distfile.xml.
Comment 12 Curtis Napier (RETIRED) gentoo-dev 2006-07-12 10:54:55 UTC
(In reply to comment #11)
> (In reply to comment #10)
> > (In reply to comment #9)
> > > "Instructions for new developers"[1] also needs to be updated.
> > > 
> > > [1] http://www.gentoo.org/proj/en/devrel/new-dev-training.xml#doc_chap2
> >
> > What specifically needs to be updated?
> 
> The "Putting files on mirrors" section tells the developer that copying a file
> to dev.gentoo.org:/space/distfiles-local is the proper way of getting files to
> the mirrors. That, according to overview-distfile.xml, is wrong. Files are
> automatically fetched and there is no need to copy them to dev.g.o yourself
> unless they are for distfiles with mirror://. It should be updated to reflect
> what's on overview-distfile.xml.
> 


I updated that doc. See bug#140138
Comment 13 Maurice van der Pot (RETIRED) gentoo-dev 2006-08-24 06:52:10 UTC
The new-dev-training.xml seems to be duplicated in the handbook: 
http://www.gentoo.org/proj/en/devrel/handbook/handbook.xml?part=1&chap=4

It may be better to remove the duplication, because it needs more than just fixing the distfile instructions.
Comment 14 Curtis Napier (RETIRED) gentoo-dev 2006-08-31 18:28:43 UTC
(In reply to comment #13)
> The new-dev-training.xml seems to be duplicated in the handbook: 
> http://www.gentoo.org/proj/en/devrel/handbook/handbook.xml?part=1&chap=4
> 
> It may be better to remove the duplication, because it needs more than just
> fixing the distfile instructions.
> 

I updated that page in the dev-handbook so it's fixed in the short term. 

Long term someone in devrel should make a decision and probably remove /proj/en/devrel/new-dev-training.xml (since it's basically the same exact information as /proj/en/devrel/handbook/hb-introduction-new-devs.xml).

If you do make sure to let GDP know **FIRST** since it will break the metadoc which causes havoc on the website.
Comment 15 Xavier Neys (RETIRED) gentoo-dev 2006-09-01 02:57:54 UTC
(In reply to comment #14)
> Long term someone in devrel should make a decision and probably remove
> /proj/en/devrel/new-dev-training.xml (since it's basically the same exact
> information as /proj/en/devrel/handbook/hb-introduction-new-devs.xml).
> 
> If you do make sure to let GDP know **FIRST** since it will break the metadoc
> which causes havoc on the website.

FYI, it b0rks the doc index, not the whole web site.
It wouldn't be a problem with the current version of gorg.
We might upgrade before Easter 2009.
Until then, please do let GDP know *before* you remove the file.
Comment 16 Robin Johnson archtester Gentoo Infrastructure gentoo-dev Security 2008-01-06 12:00:37 UTC
zmedico: what's still relevant in this bug, or can we close it?
Comment 17 Christian Ruppert (idl0r) gentoo-dev 2010-05-01 19:39:17 UTC
(In reply to comment #16)
> zmedico: what's still relevant in this bug, or can we close it?
> 

ping ^^
Comment 18 Zac Medico gentoo-dev 2010-05-01 20:31:32 UTC
I guess we can close it.

@ferringb: Are we done here? I guess you can update overview-distfile.xml yourself now if necessary.
Comment 19 Jeremy Olexa (darkside) (RETIRED) archtester gentoo-dev Security 2010-08-03 22:46:03 UTC
closing bug per previous comments.