rahul wrote:
>
>     2.1. Update Squid to 2.7STABLE5

>          It also removes some of the tuning directives, and adds
>          newer directives. The removed directives do not cause squid
>          to fail if present.

You'll want to say a bit more here. From the earlier thread, my
understanding was that if these are present in the config, squid will
log a warning to inform user the directive is no longer valid and then
continue to function normally. If so, document that.

Do some of the added directives map to some of the removed directives?
If so, case should document "directive old_directive is obsoleted and
replaced with new_directive" for whichever case(s) that might be true.

>         The default values of various directives has also been changed.

Any incompatibilities introduced by this?

If customer left those directives out of their config and relied on
the defaults, now changed, can they experience any incompatible
behavior after upgrade?


>         A new project private file has been added (logfile-daemon), another
>         project private file (sasl_auth) has been renamed to (squid_sasl_auth)

Since(if?) you confirmed these are project private implementation
detail, no reason to mention it.


>     3.1. Exported Interfaces
>                          
>     NAME                            STABILITY      NOTES
>                          
>     /usr/squid/libexec/                             Executable location
>             logfile-daemon          Project Private    
>             squid_sasl_auth         Project Private    

Is everything else in /usr/squid/libexec/ Project Private (refer to
previous case)? If so, no real reason to list those two.

(If some things in the dir are public but other private, then it's
good to list them so it is clear which is which. OTOH if previous case
declared /usr/squid/libexec/* to be Project Private then it is
unambiguous these new ones are as well, so no reason to list.)


What's missing in the exported interface table is:

- the removed directives: previous classification: XYZ
  (I don't remember value of XYZ, look up in previous case)
  new classification: Obsolete XYZ

- the added directives; their interface classification



-- 
Jyri J. Virkki - jyri.virkki at sun.com - Sun Microsystems

Reply via email to