[dev] syntax to use for documenting directives

Manlio Perillo manlio_perillo at libero.it
Sun Jan 6 17:31:50 MSK 2008


There seems to be not uniform syntax rules for documenting nginx directives.

As an example, for the http proxy module we have:

syntax: proxy_buffering on|off
syntax: proxy_ignore_client_abort [on|off]

Since a value is always required, the [] should not be used, IMHO.

Moreover directives values have strong emphasis in the original 
documentation, but no emphasis at all in the english documentation.

Lastly, the RestructuredText pages formatted by MoinMoin are not very


Maybe the documentation format should be more "standardized".

Thanks   Manlio Perillo

More information about the nginx mailing list