Gentoo Websites Logo
Go to: Gentoo Home Documentation Forums Lists Bugs Planet Store Wiki Get Gentoo!
Bug 98604 - developer documentation should cover sandbox
Summary: developer documentation should cover sandbox
Status: RESOLVED FIXED
Alias: None
Product: Documentation
Classification: Unclassified
Component: Devmanual (show other bugs)
Hardware: All Linux
: High normal (vote)
Assignee: Gentoo Quality Assurance Team
URL:
Whiteboard:
Keywords:
Depends on:
Blocks:
 
Reported: 2005-07-10 15:39 UTC by Maurice Volaski
Modified: 2009-04-19 21:00 UTC (History)
1 user (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 Maurice Volaski 2005-07-10 15:39:49 UTC
There appears to be virtually no documentation on the sandbox. 

Now there seems to be not only sandbox feature, but also a usersandbox, too.

And there is an entire ebuild for the sandbox, but no man page!

There should be a section added to the portage documentation to explain how all these things work 
and it should also explain why infamous ACCESS VIOLATIONS occurs and why it can't seem to be fixed.

(Poor documentation makes Gentoo look bad.)

Reproducible: Always
Steps to Reproduce:
1.
2.
3.
Comment 1 SpanKY gentoo-dev 2005-07-10 21:43:35 UTC
i dont really the point other than a short description in make.conf in the
FEATURES section about sandbox and usersandbox
Comment 2 Zac Medico gentoo-dev 2005-09-04 17:16:15 UTC
(In reply to comment #0)
> There appears to be virtually no documentation on the sandbox.  Now there
seems to be not only sandbox feature, but also a usersandbox, too.  And there is
an entire ebuild for the sandbox, but no man page!

The make.conf manpage and make.conf.example have brief explanations.  The
sandbox package has a sandboxshell manpage.

> There should be a section added to the portage documentation to explain how
all these things work and it should also explain why infamous ACCESS VIOLATIONS
occurs and why it can't seem to be fixed.

IMO there's no point in explaining such things to users.  They should simply
file a bug and leave it to the ebuild devs.

> (Poor documentation makes Gentoo look bad.)

Please feel free to create documentation patches and attach them to this bug. :)
Comment 3 Martin Schlemmer (RETIRED) gentoo-dev 2005-09-05 00:37:48 UTC
I have said it in the past, and will say it again - I suck at docs.  Anyhow, I
think a manpage will be nifty, so if anybody will be willing to do that, ping me.
Comment 4 Marius Mauch (RETIRED) gentoo-dev 2007-01-11 04:25:39 UTC
Addin docs-team to CC in case they are interested in this or have anything to add. Feel free to unCC yourself if that's not the case.
Comment 5 Zac Medico gentoo-dev 2007-01-11 05:14:30 UTC

*** This bug has been marked as a duplicate of bug 137610 ***
Comment 6 Zac Medico gentoo-dev 2007-01-11 05:15:27 UTC
oops, wrong bug
Comment 7 nm (RETIRED) gentoo-dev 2007-01-11 05:31:09 UTC
(In reply to comment #4)
> Addin docs-team to CC in case they are interested in this or have anything to
> add. Feel free to unCC yourself if that's not the case.
> 

Interesting, could be very interesting. However, that's more the sort of "interesting" that would need to be placed in 1) the developer handbook maintained by devrel and 2) the devmanual maintained by QA.

Working with the sandbox is clearly a development feature, not an end-user feature. I don't feel that we should throw it in with the existing user-oriented Portage Handbook for the same reason why I was discouraged by various Portage folks from mentioning things like AUTOCLEAN -- best not to mention it (in that handbook) so that users don't mess up their systems.

That being said, I, personally, am interested in helping out (gotta do something to occupy myself ;) ). I can edit and guideXMLify the online documentation for you if needed; just get in touch with me. :)

Un-CCing the GDP for now.
Comment 8 nm (RETIRED) gentoo-dev 2007-08-13 10:05:55 UTC
No activity whatsoever, so unCCing myself.
Comment 9 Mark Loeser (RETIRED) gentoo-dev 2008-11-16 20:10:46 UTC
We already have some stuff on here:

http://devmanual.gentoo.org/general-concepts/sandbox/

And links from there on how to deal with some sandbox issues.  Is there anything specific we are looking for that would help people?  I'm willing to write it, but I just don't know what people want :)  Patches make the process go much faster btw.
Comment 10 Mark Loeser (RETIRED) gentoo-dev 2009-04-19 21:00:41 UTC
We already have some documentation in devmanual about sandbox.  I don't know what people want added, so I'm considering this fixed.