I noticed that the new baselayout finally supported wireless in conf.d/net. It also has a featureful interface to other things like bridges. The problem is that most people probably don't merge new changes into conf.d files like me (simply keeping the old ones), and have no idea what all of the wonderful new comments say. A broader problem might be that baselayout needs some kind of documentation, at least a README file in /usr/share/doc/baselayout-*. Since we have such a fine documentation team, rather than leaving this up to the developer, I think it's a good little project for us to tackle. We could write up a little README for that project, then submit the changes so that it's included in the next release of baselayout. Does this sound good? .. this also makes me think we could use gentoo specific README's for a lot of tools... might this evolve into some kind of larger project with gentoo specific documentation for apps installed with portage? Reproducible: Always Steps to Reproduce: 1. 2. 3.
(In reply to comment #0) > I noticed that the new baselayout finally supported wireless in conf.d/net. It > also has a featureful interface to other things like bridges. The problem is > that most people probably don't merge new changes into conf.d files like me > (simply keeping the old ones), and have no idea what all of the wonderful new > comments say. > > A broader problem might be that baselayout needs some kind of documentation, at > least a README file in /usr/share/doc/baselayout-*. > > Since we have such a fine documentation team, rather than leaving this up to the > developer, I think it's a good little project for us to tackle. We could write > up a little README for that project, then submit the changes so that it's > included in the next release of baselayout. conf.d/net is covered in the URL below. http://www.gentoo.org/doc/en/handbook/handbook-x86.xml?part=4&chap=0
conf.d/net part is already quite well documented, so I think you're just requesting more documentation about the rest of baselayout. Baselayout people, any known avilable resources?
Maybe this should be transformed into something like "wipe documentation out of config files bug". It's just true most people don't merge the new config files...
(In reply to comment #3) > Maybe this should be transformed into something like "wipe documentation out of > config files bug". It's just true most people don't merge the new config files... Good point. Documentation in configuration files could be easily maintained, but documentation inside GDP's space (www.gentoo.org/doc) can be easily translated. (I'm not speaking for removal of comments, of course).
there is the handbook doc plus /etc/conf.d/net.example
wunderbar! I think the bit about docs.g.o making these things up for translation is a great point. What about non-english speakers who have to read through the english comments in our config files all over?
Reopening as it isn't INVALID if you ignore stuff about /etc/conf.d/net which was main representant of such docs.
ignore what ? /etc/conf.d/net no longer contains anything, just a comment telling you to read /etc/conf.d/net.example if you merged the latest /etc/conf.d/net file from your baselayout upgrade you'd know that
