Hi, Rainer Gerhards wrote: > Most importantly, it hopefully is more clear which legacy statements are > actually global and which not.
Mh... I am not sure if I see the changes. For example <http://www.rsyslog.com/doc/master/configuration/global/index.html>: This site is listing "$MarkMessagePeriod" as a global directive but it isn't. Only when using the old syntax... Same with <http://www.rsyslog.com/doc/master/configuration/action/index.html>: >From reading these docs I would expect I can set $FileOwner $FileGroup before my actions (new syntax) to specify defaults, but I cannot (mixing old and new syntax). But I don't get that information from reading the documentation. But as said, maybe you were working on other parts of the documentation... PS: Just an idea: Why don't you/we start with a *new* documentation? Throw everything away. Yes, for the beginning, many features will be undocumented (well, not really... the old documentation is still accessible) but this will allow us to get rid of all the current problems: 1) There's no consistency 1.1) See <http://www.rsyslog.com/doc/master/configuration/modules/omfile.html>: Template[templateName] DynaFileCacheSize(not mandatory, default 10 ZipLevel0..9 [default 0] ASyncWritingon/off [default off] IOBufferSize<size_nbr>, default 4k DirCreateMode[default equelly-named module parameter] 1.2) Sometimes the documentation is split in new/legacy syntax mode, sometimes not. Also the way we display the old/new syntax can be improved. 2) The visual appearance is not really readable, see <http://f.666kb.com/i/codcurab5nda9w1qk.jpg> (and the examples from 1.1, too). You all do your best to get these things fixed, but personally I think you cannot win. It is too much you need to fix. If we would start over, start with defining how we want to display information (to prevent things shown in 1.1; find a way how we want to show current and legacy syntax; how we want to structure) rewriting should be more easier than fixing these things today. ...and we should focus on the *new* syntax. The new syntax should be completely documented (currently, sometimes I have to read the source code to get some parameters or default values). Legacy syntax isn't that important and remember, the old documentation is still there. The important thing is: Keep the new documentation clean. Only rewritten documentation in our new "format" is allowed to get added. Maybe it will take a year or more to get where we are in the moment (in extent of documentation), but if we would start with the most important/common used parts, the new documentation will be better in 2-3 month than the old one ever was. Thoughts? -Thomas _______________________________________________ rsyslog mailing list http://lists.adiscon.net/mailman/listinfo/rsyslog http://www.rsyslog.com/professional-services/ What's up with rsyslog? Follow https://twitter.com/rgerhards NOTE WELL: This is a PUBLIC mailing list, posts are ARCHIVED by a myriad of sites beyond our control. PLEASE UNSUBSCRIBE and DO NOT POST if you DON'T LIKE THAT.
