ANN: Updating flag description in the User's Guide

2014-11-06 Thread Jan Stolarek
Devs, I have some important information for everyone. TL;DR1 As a rule of thumb, whenever you modify DynFlags or StaticFlags please make absolutely sure that your changes are described in the User's Guide. See Note [Updating flag description in the User's Guide] in DynFlags. TL;DR2 Your

Re: ANN: Updating flag description in the User's Guide

2014-11-06 Thread Simon Marlow
On 06/11/2014 12:06, Jan Stolarek wrote: Devs, I have some important information for everyone. TL;DR1 As a rule of thumb, whenever you modify DynFlags or StaticFlags please make absolutely sure that your changes are described in the User's Guide. See Note [Updating flag description in

Re: ANN: Updating flag description in the User's Guide

2014-11-06 Thread RodLogic
What about standardizing on an 'experimental' prefix such as -fx-use-rpaths or -fx-kill-oneshot? These flags would not be added to the user guide and their intent clear when actually using them. On Thu, Nov 6, 2014 at 10:28 AM, Simon Marlow wrote: > On 06/11/2014 12:06, Jan Stolarek wrote: > >>

Re: ANN: Updating flag description in the User's Guide

2014-11-06 Thread Jan Stolarek
> Sometimes we add flags that are for experimentation or development > purposes and not intended for user consumption, and these tend not to be > added to the User's Guide. I suspect many of the flags you mention fall > into this category. I suggest for these we have a specific comment in > the s

Re: ANN: Updating flag description in the User's Guide

2014-11-06 Thread Jan Stolarek
> What about standardizing on an 'experimental' prefix such as -fx-use-rpaths > or -fx-kill-oneshot? These flags would not be added to the user guide and > their intent clear when actually using them. As already stated in an earlier reply I think we should have documentation for the sake of other

Re: ANN: Updating flag description in the User's Guide

2014-11-06 Thread Johan Tibell
Agreed. For example, the HTTP standard has moved away from X-prefixed headers for similar reasons. On Thu, Nov 6, 2014 at 2:13 PM, Jan Stolarek wrote: > > What about standardizing on an 'experimental' prefix such as > -fx-use-rpaths > > or -fx-kill-oneshot? These flags would not be added to the

Re: ANN: Updating flag description in the User's Guide

2014-11-07 Thread Simon Marlow
On 06/11/2014 13:02, Jan Stolarek wrote: Sometimes we add flags that are for experimentation or development purposes and not intended for user consumption, and these tend not to be added to the User's Guide. I suspect many of the flags you mention fall into this category. I suggest for these we